src/libs/utils/ssh/sshconnection.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef SSHCONNECTION_H
  34 #define SSHCONNECTION_H
  35
  36 #include "ssherrors.h"
  37
  38 #include <utils/utils_global.h>
  39
  40 #include <QtCore/QByteArray>
  41 #include <QtCore/QObject>
  42 #include <QtCore/QSharedPointer>
  43 #include <QtCore/QString>
  44
  45 namespace Utils {
  46 class SftpChannel;
  47 class SshRemoteProcess;
  48
  49 namespace Internal {
  50 class SshConnectionPrivate;
  51 } // namespace Internal
  52
  53 struct QTCREATOR_UTILS_EXPORT SshConnectionParameters
  54 {
  55     enum ProxyType { DefaultProxy, NoProxy };
  56     enum AuthenticationType { AuthenticationByPassword, AuthenticationByKey };
  57     SshConnectionParameters(ProxyType proxyType);
  58
  59     QString host;
  60     QString userName;
  61     QString password;
  62     QString privateKeyFile;
  63     int timeout; // In seconds.
  64     AuthenticationType authenticationType;
  65     quint16 port;
  66     ProxyType proxyType;
  67 };
  68
  69 QTCREATOR_UTILS_EXPORT bool operator==(const SshConnectionParameters &p1, const SshConnectionParameters &p2);
  70 QTCREATOR_UTILS_EXPORT bool operator!=(const SshConnectionParameters &p1, const SshConnectionParameters &p2);
  71
  72 class QTCREATOR_UTILS_EXPORT SshConnection : public QObject
  73 {
  74     Q_OBJECT
  75     Q_DISABLE_COPY(SshConnection)
  76 public:
  77     enum State { Unconnected, Connecting, Connected };
  78     typedef QSharedPointer<SshConnection> Ptr;
  79
  80     static Ptr create();
  81
  82     void connectToHost(const SshConnectionParameters &serverInfo);
  83     void disconnectFromHost();
  84     State state() const;
  85     SshError errorState() const;
  86     QString errorString() const;
  87     SshConnectionParameters connectionParameters() const;
  88     ~SshConnection();
  89
  90     QSharedPointer<SshRemoteProcess> createRemoteProcess(const QByteArray &command);
  91     QSharedPointer<SftpChannel> createSftpChannel();
  92
  93 signals:
  94     void connected();
  95     void disconnected();
  96     void dataAvailable(const QString &message);
  97     void error(Utils::SshError);
  98
  99 private:
 100     SshConnection();
 101
 102     Internal::SshConnectionPrivate *d;
 103 };
 104
 105 } // namespace Internal
 106
 107 #endif // SSHCONNECTION_H