Package adams.flow.standalone

Class SSHConnection

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, SSHSessionProvider, OptionHandler, PasswordPrompter, PasswordSupporter, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TechnicalInformationHandler, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InteractiveActor, OptionalPasswordPrompt, StopModeSupporter, Serializable, Comparable
    public class SSHConnection
extends AbstractStandalone
implements TechnicalInformationHandler, OptionalPasswordPrompt, SSHSessionProvider, PasswordPrompter
    Provides access to a remote host via SSH.

    For more information see:

    (2011). JSch - JSch is a pure Java implementation of SSH2.. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SSHConnection
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -host <java.lang.String> (property: host)
    The host (name/IP address) to connect to.
    default:
 
    -port <int> (property: port)
    The port to connect to.
    default: 22
    minimum: 1
    maximum: 65535
 
    -authentication-type <CREDENTIALS|PUBLIC_KEY> (property: authenticationType)
    The type of authentication to use.
    default: CREDENTIALS
 
    -user <java.lang.String> (property: user)
    The SSH user to use for connecting.
 
    -password <adams.core.base.BasePassword> (property: password)
    The password of the SSH user to use for connecting.
 
    -private-key-file <adams.core.io.PlaceholderFile> (property: privateKeyFile)
    The location of the private key.
    default: ${HOME}/.ssh/id_rsa
 
    -private-key-passphrase <adams.core.base.BasePassword> (property: privateKeyPassphrase)
    The passphrase for the private key file, ignored if empty.
 
    -known-hosts <adams.core.io.PlaceholderFile> (property: knownHosts)
    The file storing the known hosts.
    default: ${HOME}/.ssh/known_hosts
 
    -strict-host-key-checking <boolean> (property: strictHostKeyChecking)
    Enables/disables strict host key checking - strict checking is the recommended
    setting, as disabling it is very insecure!
    default: true
 
    -forward-x <boolean> (property: forwardX)
    If set to true, then X is forwarded.
    default: false
 
    -x-host <java.lang.String> (property: XHost)
    The xhost (name/IP address) to connect to.
    default:
 
    -x-port <int> (property: XPort)
    The xport to connect to.
    default: 6000
    minimum: 1
    maximum: 65535
 
    -prompt-for-password <boolean> (property: promptForPassword)
    If enabled, the user gets prompted for enter a password if none has been
    provided in the setup.
    default: false
 
    -timeout <int> (property: timeout)
    The timeout in milliseconds.
    default: 0
    minimum: 0
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Host

        protected String m_Host
        the SSH host.

      • m_Port

        protected int m_Port
        the SSH port.

      • m_AuthenticationType

        protected SSHAuthenticationType m_AuthenticationType
        the type of authentication to use.

      • m_User

        protected String m_User
        the SSH user to use.

      • m_Password

        protected BasePassword m_Password
        the SSH password to use.

      • m_PrivateKeyFile

        protected PlaceholderFile m_PrivateKeyFile
        the location of the private key.

      • m_PrivateKeyPassphrase

        protected BasePassword m_PrivateKeyPassphrase
        the passphrase for the private key.

      • m_KnownHosts

        protected PlaceholderFile m_KnownHosts
        the file with known hosts.

      • m_StrictHostKeyChecking

        protected boolean m_StrictHostKeyChecking
        whether to perform strict host key checking (only disable for testing!! insecure!!).

      • m_ForwardX

        protected boolean m_ForwardX
        whether to forward X11.

      • m_XHost

        protected String m_XHost
        the xhost to use.

      • m_XPort

        protected int m_XPort
        the xport to use.

      • m_ActualPassword

        protected BasePassword m_ActualPassword
        the actual SMTP password to use.

      • m_PromptForPassword

        protected boolean m_PromptForPassword
        whether to prompt the user for a password if none provided.

      • m_Timeout

        protected int m_Timeout
        the timeout to use (milliseconds).

      • m_StopFlowIfCanceled

        protected boolean m_StopFlowIfCanceled
        whether to stop the flow if canceled.

      • m_CustomStopMessage

        protected String m_CustomStopMessage
        the custom stop message to use if flow gets stopped due to cancelation.

      • m_StopMode

        protected StopMode m_StopMode
        how to perform the stop.

      • m_Session

        protected transient com.jcraft.jsch.Session m_Session
        the SSH session.

    • Constructor Detail

      • SSHConnection

        public SSHConnection()

    • Method Detail

      • getTechnicalInformation

        public TechnicalInformation getTechnicalInformation()
        Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
        Specified by:
        getTechnicalInformation in interface TechnicalInformationHandler
        Returns:
        the technical information about this class

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset in class AbstractActor

      • setHost

        public void setHost​(String value)
        Sets the host to connect to.
        Parameters:
        value - the host name/ip

      • getHost

        public String getHost()
        Returns the host to connect to.
        Returns:
        the host name/ip

      • hostTipText

        public String hostTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setPort

        public void setPort​(int value)
        Sets the port to connect to.
        Parameters:
        value - the port

      • getPort

        public int getPort()
        Returns the port to connect to.
        Returns:
        the port

      • portTipText

        public String portTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAuthenticationType

        public void setAuthenticationType​(SSHAuthenticationType value)
        Sets the type of authentication to use.
        Parameters:
        value - the type

      • getAuthenticationType

        public SSHAuthenticationType getAuthenticationType()
        Returns the type of authentication to use.
        Returns:
        the type

      • authenticationTypeTipText

        public String authenticationTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUser

        public void setUser​(String value)
        Sets the SSH user to use.
        Parameters:
        value - the user name

      • getUser

        public String getUser()
        Returns the SSH user name to use.
        Returns:
        the user name

      • userTipText

        public String userTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • passwordTipText

        public String passwordTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setPrivateKeyFile

        public void setPrivateKeyFile​(PlaceholderFile value)
        Sets the location of the private key file.
        Parameters:
        value - the key file

      • getPrivateKeyFile

        public PlaceholderFile getPrivateKeyFile()
        Returns the location of the private key file.
        Returns:
        the key file

      • privateKeyFileTipText

        public String privateKeyFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setPrivateKeyPassphrase

        public void setPrivateKeyPassphrase​(BasePassword value)
        Sets the passphrase for the private key file, ignored if empty.
        Parameters:
        value - the passphrase

      • getPrivateKeyPassphrase

        public BasePassword getPrivateKeyPassphrase()
        Returns the passphrase for the private key file, ignored if empty.
        Returns:
        the passphrase

      • privateKeyPassphraseTipText

        public String privateKeyPassphraseTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setKnownHosts

        public void setKnownHosts​(PlaceholderFile value)
        Sets the file with the known hosts.
        Parameters:
        value - the file

      • getKnownHosts

        public PlaceholderFile getKnownHosts()
        Returns the file with the known hosts.
        Returns:
        the file

      • knownHostsTipText

        public String knownHostsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setStrictHostKeyChecking

        public void setStrictHostKeyChecking​(boolean value)
        Sets whether to perform strict host key checking. NB: only disabled for testing, as it is very insecure to disable it!
        Parameters:
        value - if true then strict checking is on

      • getStrictHostKeyChecking

        public boolean getStrictHostKeyChecking()
        Returns whether to perform strict host key checking. NB: only disabled for testing, as it is very insecure to disable it!
        Returns:
        true if strict checking is on

      • strictHostKeyCheckingTipText

        public String strictHostKeyCheckingTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setForwardX

        public void setForwardX​(boolean value)
        Sets whether to forward X11.
        Parameters:
        value - if true then X11 is forwarded

      • getForwardX

        public boolean getForwardX()
        Returns whether X11 is forwarded.
        Returns:
        true if X11 is forwarded

      • forwardXTipText

        public String forwardXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setXHost

        public void setXHost​(String value)
        Sets the xhost to connect to.
        Parameters:
        value - the host name/ip

      • getXHost

        public String getXHost()
        Returns the xhost to connect to.
        Returns:
        the host name/ip

      • XHostTipText

        public String XHostTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setXPort

        public void setXPort​(int value)
        Sets the xport to connect to.
        Parameters:
        value - the port

      • getXPort

        public int getXPort()
        Returns the xport to connect to.
        Returns:
        the port

      • XPortTipText

        public String XPortTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setTimeout

        public void setTimeout​(int value)
        Sets the timeout in milliseconds.
        Parameters:
        value - the timeout

      • getTimeout

        public int getTimeout()
        Returns the timeout in milliseconds.
        Returns:
        the timeout

      • timeoutTipText

        public String timeoutTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setStopFlowIfCanceled

        public void setStopFlowIfCanceled​(boolean value)
        Sets whether to stop the flow if dialog canceled.
        Specified by:
        setStopFlowIfCanceled in interface InteractiveActor
        Parameters:
        value - if true flow gets stopped if dialog canceled

      • getStopFlowIfCanceled

        public boolean getStopFlowIfCanceled()
        Returns whether to stop the flow if dialog canceled.
        Specified by:
        getStopFlowIfCanceled in interface InteractiveActor
        Returns:
        true if the flow gets stopped if dialog canceled

      • stopFlowIfCanceledTipText

        public String stopFlowIfCanceledTipText()
        Returns the tip text for this property.
        Specified by:
        stopFlowIfCanceledTipText in interface InteractiveActor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCustomStopMessage

        public void setCustomStopMessage​(String value)
        Sets the custom message to use when stopping the flow.
        Specified by:
        setCustomStopMessage in interface InteractiveActor
        Parameters:
        value - the stop message

      • getCustomStopMessage

        public String getCustomStopMessage()
        Returns the custom message to use when stopping the flow.
        Specified by:
        getCustomStopMessage in interface InteractiveActor
        Returns:
        the stop message

      • customStopMessageTipText

        public String customStopMessageTipText()
        Returns the tip text for this property.
        Specified by:
        customStopMessageTipText in interface InteractiveActor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • stopModeTipText

        public String stopModeTipText()
        Returns the tip text for this property.
        Specified by:
        stopModeTipText in interface StopModeSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doInteract

        public String doInteract()
        Performs the interaction with the user.
        Specified by:
        doInteract in interface InteractiveActor
        Returns:
        null if successfully interacted, otherwise error message

      • supportsHeadlessInteraction

        public boolean supportsHeadlessInteraction()
        Returns whether headless interaction is supported.
        Specified by:
        supportsHeadlessInteraction in interface InteractiveActor
        Returns:
        true if interaction in headless environment is possible

      • doInteractHeadless

        public String doInteractHeadless()
        Performs the interaction with the user in a headless environment.
        Specified by:
        doInteractHeadless in interface InteractiveActor
        Returns:
        null if successfully interacted, otherwise error message

      • getSession

        public com.jcraft.jsch.Session getSession()
        Returns the SSH session. Attempts to reconnect when necessary or create new session when none present.
        Specified by:
        getSession in interface SSHSessionProvider
        Returns:
        the SSH session, null if not connected

      • newSession

        public com.jcraft.jsch.Session newSession()
        Returns a new session for the host/port defined in the options.
        Specified by:
        newSession in interface SSHSessionProvider
        Returns:
        the session

      • newSession

        public com.jcraft.jsch.Session newSession​(String host,
                                          int port)
        Returns a new session for the given host/port.
        Specified by:
        newSession in interface SSHSessionProvider
        Parameters:
        host - the host to create the session for
        Returns:
        the session

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if ok, otherwise error message

      • disconnect

        protected void disconnect()
        Disconnects the SSH session, if necessary.

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractActor