org.eclipse.remote.internal.jsch.core

Class JSchConnection

java.lang.Object

org.eclipse.remote.internal.jsch.core.JSchConnection

All Implemented Interfaces:

java.util.EventListener, IRemoteConnection.Service, IRemoteConnectionChangeListener, IRemoteConnectionControlService, IRemoteConnectionHostService, IRemoteConnectionPropertyService, IRemotePortForwardingService, IRemoteProcessService

public class JSchConnection
extends java.lang.Object
implements IRemoteConnectionControlService, IRemoteConnectionPropertyService, IRemotePortForwardingService, IRemoteProcessService, IRemoteConnectionHostService, IRemoteConnectionChangeListener

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSchConnection.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDRESS_ATTR
static boolean	DEFAULT_IS_PASSWORD
static java.lang.String	DEFAULT_LOGIN_SHELL_COMMAND
static int	DEFAULT_PORT
static int	DEFAULT_TIMEOUT
static boolean	DEFAULT_USE_LOGIN_SHELL
static java.lang.String	EMPTY_STRING
static java.lang.String	IS_PASSWORD_ATTR
static java.lang.String	JSCH_ID
static java.lang.String	LOGIN_SHELL_COMMAND_ATTR
static java.lang.String	PASSPHRASE_ATTR
static java.lang.String	PASSWORD_ATTR
static java.lang.String	PORT_ATTR
static java.lang.String	PROXYCOMMAND_ATTR
static java.lang.String	PROXYCONNECTION_ATTR
static java.lang.String	TIMEOUT_ATTR
static java.lang.String	USE_LOGIN_SHELL_ATTR
static java.lang.String	USERNAME_ATTR

Constructor Summary

Constructors

Constructor and Description
JSchConnection(IRemoteConnection connection)

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
void	connectionChanged(RemoteConnectionChangeEvent event) Notifies this listener that the status of a connection has changed.
void	forwardLocalPort(int localPort, java.lang.String fwdAddress, int fwdPort) Forward local port localPort to remote port fwdPort on remote machine fwdAddress.
int	forwardLocalPort(java.lang.String fwdAddress, int fwdPort, org.eclipse.core.runtime.IProgressMonitor monitor) Forward a local port to remote port fwdPort on remote machine fwdAddress.
void	forwardRemotePort(int remotePort, java.lang.String fwdAddress, int fwdPort) Forward remote port remotePort to port fwdPort on machine fwdAddress.
int	forwardRemotePort(java.lang.String fwdAddress, int fwdPort, org.eclipse.core.runtime.IProgressMonitor monitor) Forward a remote port to port fwdPort on remote machine fwdAddress.
java.util.Map<java.lang.String,java.lang.String>	getEnv() Returns an unmodifiable string map view of the remote environment.
java.lang.String	getEnv(java.lang.String name) Returns the value of an environment variable.
com.jcraft.jsch.ChannelExec	getExecChannel() Open an exec channel to the remote host.
java.lang.String	getHostname() Obtain the hostname associated with this connection.
java.lang.String	getLoginShellCommand() Get the login shell command if useLoginShell is true
java.lang.String	getPassphrase()
java.lang.String	getPassword()
int	getPort() Obtain the port associated with this connection
IRemoteProcessBuilder	getProcessBuilder(java.util.List<java.lang.String> command) Get a process builder for creating remote processes
IRemoteProcessBuilder	getProcessBuilder(java.lang.String... command) Get a process builder for creating remote processes
java.lang.String	getProperty(java.lang.String key) Gets the remote system property indicated by the specified key.
java.lang.String	getProxyCommand() Gets the proxy command.
JSchConnection	getProxyConnection() Gets the proxy connection.
java.lang.String	getProxyConnectionName() Gets the proxy connection name
IRemoteConnection	getRemoteConnection()
com.jcraft.jsch.ChannelSftp	getSftpCommandChannel() Open an sftp command channel to the remote host.
com.jcraft.jsch.ChannelShell	getShellChannel() Open a shell channel to the remote host.
com.jcraft.jsch.Channel	getStreamForwarder(java.lang.String host, int port)
int	getTimeout() Obtain the timeout used when establishing the connection.
java.lang.String	getUsername() Obtain the username associated with this connection.
java.lang.String	getWorkingDirectory() Get the working directory.
boolean	hasOpenSession() Test if the connection has a valid open session.
boolean	isOpen() Test if the connection is open.
boolean	isPasswordAuth()
com.jcraft.jsch.ChannelSftp	newSftpChannel() Open a channel for long running commands.
void	open(org.eclipse.core.runtime.IProgressMonitor monitor) Open the connection.
void	openMinimal(org.eclipse.core.runtime.IProgressMonitor monitor) Open ssh connection without full setup (environment, sftp)
void	removeLocalPortForwarding(int port) Remove the local port forwarding associated with the given port.
void	removeRemotePortForwarding(int port) Remove the remote port forwarding associated with the given port.
void	setHostname(java.lang.String hostname) Set the hostname associated with this connection.
void	setPassphrase(java.lang.String passphrase) Set the pass phrase associated with this connection.
void	setPassword(java.lang.String password) Set the password associated with this connection.
void	setPort(int port) Set the port used for the connection.
void	setTimeout(int timeout) Set the timeout used when establishing the connection.
void	setUseLoginShell(boolean useLogingShell) Set the flag indicating a login shell should be stated for this connection.
void	setUsePassword(boolean usePassword) Set the connection to try password authentication first.
void	setUsername(java.lang.String username) Set the username associated with this connection.
void	setWorkingDirectory(java.lang.String path) Set the working directory while the connection is open.
boolean	useLoginShell() Obtain the flag that indicates a login shell should be started once the connection is established

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JSCH_ID

public static final java.lang.String JSCH_ID

See Also:

Constant Field Values

ADDRESS_ATTR

public static final java.lang.String ADDRESS_ATTR

See Also:

Constant Field Values

USERNAME_ATTR

public static final java.lang.String USERNAME_ATTR

See Also:

Constant Field Values

PASSWORD_ATTR

public static final java.lang.String PASSWORD_ATTR

See Also:

Constant Field Values

PORT_ATTR

public static final java.lang.String PORT_ATTR

See Also:

Constant Field Values

PROXYCONNECTION_ATTR

public static final java.lang.String PROXYCONNECTION_ATTR

See Also:

Constant Field Values

PROXYCOMMAND_ATTR

public static final java.lang.String PROXYCOMMAND_ATTR

See Also:

Constant Field Values

IS_PASSWORD_ATTR

public static final java.lang.String IS_PASSWORD_ATTR

See Also:

Constant Field Values

PASSPHRASE_ATTR

public static final java.lang.String PASSPHRASE_ATTR

See Also:

Constant Field Values

TIMEOUT_ATTR

public static final java.lang.String TIMEOUT_ATTR

See Also:

Constant Field Values

USE_LOGIN_SHELL_ATTR

public static final java.lang.String USE_LOGIN_SHELL_ATTR

See Also:

Constant Field Values

LOGIN_SHELL_COMMAND_ATTR

public static final java.lang.String LOGIN_SHELL_COMMAND_ATTR

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_IS_PASSWORD

public static final boolean DEFAULT_IS_PASSWORD

See Also:

Constant Field Values

DEFAULT_USE_LOGIN_SHELL

public static final boolean DEFAULT_USE_LOGIN_SHELL

See Also:

Constant Field Values

DEFAULT_LOGIN_SHELL_COMMAND

public static final java.lang.String DEFAULT_LOGIN_SHELL_COMMAND

See Also:

Constant Field Values

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

Constructor Detail

JSchConnection

public JSchConnection(IRemoteConnection connection)

Method Detail

connectionChanged

public void connectionChanged(RemoteConnectionChangeEvent event)

Description copied from interface: IRemoteConnectionChangeListener

Notifies this listener that the status of a connection has changed.

Specified by:

connectionChanged in interface IRemoteConnectionChangeListener

Parameters:

event - the connection change event

getRemoteConnection

public IRemoteConnection getRemoteConnection()

Specified by:

getRemoteConnection in interface IRemoteConnection.Service

close

public void close()

Description copied from interface: IRemoteConnectionControlService

Close the connection. Must be called to terminate the connection.

Specified by:

close in interface IRemoteConnectionControlService

forwardLocalPort

public void forwardLocalPort(int localPort,
                             java.lang.String fwdAddress,
                             int fwdPort)
                      throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Forward local port localPort to remote port fwdPort on remote machine fwdAddress. If this IRemoteConnection is not to fwdAddress, the port will be routed via the connection machine to fwdAddress.

Specified by:

forwardLocalPort in interface IRemotePortForwardingService

Parameters:

localPort - local port to forward

fwdAddress - address of remote machine

fwdPort - remote port on remote machine

Throws:

RemoteConnectionException

forwardLocalPort

public int forwardLocalPort(java.lang.String fwdAddress,
                            int fwdPort,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                     throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Forward a local port to remote port fwdPort on remote machine fwdAddress. The local port is chosen dynamically and returned by the method. If this IRemoteConnection is not to fwdAddress, the port will be routed via the connection machine to fwdAddress.

Specified by:

forwardLocalPort in interface IRemotePortForwardingService

Returns:

local port number

Throws:

RemoteConnectionException

forwardRemotePort

public void forwardRemotePort(int remotePort,
                              java.lang.String fwdAddress,
                              int fwdPort)
                       throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Forward remote port remotePort to port fwdPort on machine fwdAddress. When a connection is made to remotePort on the remote machine, it is forwarded via this IRemoteConnection to fwdPort on machine fwdAddress.

Specified by:

forwardRemotePort in interface IRemotePortForwardingService

Parameters:

remotePort - remote port to forward

fwdAddress - address of recipient machine

fwdPort - port on recipient machine

Throws:

RemoteConnectionException

forwardRemotePort

public int forwardRemotePort(java.lang.String fwdAddress,
                             int fwdPort,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Forward a remote port to port fwdPort on remote machine fwdAddress. The remote port is chosen dynamically and returned by the method. When a connection is made to this port on the remote machine, it is forwarded via this IRemoteConnection to fwdPort on machine fwdAddress. If fwdAddress is the empty string ("") then the fwdPort will be bound to any address on all interfaces. Note that this requires enabling the GatewayPort sshd option on some systems.

Specified by:

forwardRemotePort in interface IRemotePortForwardingService

Returns:

remote port number

Throws:

RemoteConnectionException

getHostname

public java.lang.String getHostname()

Description copied from interface: IRemoteConnectionHostService

Obtain the hostname associated with this connection.

Specified by:

getHostname in interface IRemoteConnectionHostService

Returns:

hostname

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Description copied from interface: IRemoteProcessService

Returns an unmodifiable string map view of the remote environment. The connection must be open prior to calling this method.

Specified by:

getEnv in interface IRemoteProcessService

Returns:

the remote environment

getEnv

public java.lang.String getEnv(java.lang.String name)

Description copied from interface: IRemoteProcessService

Returns the value of an environment variable. The connection must be open prior to calling this method.

Specified by:

getEnv in interface IRemoteProcessService

Parameters:

name - name of the environment variable

Returns:

value of the environment variable or null if the variable is not defined

getExecChannel

public com.jcraft.jsch.ChannelExec getExecChannel()
                                           throws RemoteConnectionException

Open an exec channel to the remote host.

Returns:

exec channel or null if the progress monitor was cancelled

Throws:

RemoteConnectionException - if a channel could not be opened

getShellChannel

public com.jcraft.jsch.ChannelShell getShellChannel()
                                             throws RemoteConnectionException

Open a shell channel to the remote host.

Returns:

shell channel or null if the progress monitor was cancelled

Throws:

RemoteConnectionException - if a channel could not be opened

getPassphrase

public java.lang.String getPassphrase()

getPassword

public java.lang.String getPassword()

getPort

public int getPort()

Description copied from interface: IRemoteConnectionHostService

Obtain the port associated with this connection

Specified by:

getPort in interface IRemoteConnectionHostService

Returns:

port

getProcessBuilder

public IRemoteProcessBuilder getProcessBuilder(java.util.List<java.lang.String> command)

Description copied from interface: IRemoteProcessService

Get a process builder for creating remote processes

Specified by:

getProcessBuilder in interface IRemoteProcessService

Returns:

process builder or null if connection is not open

getProcessBuilder

public IRemoteProcessBuilder getProcessBuilder(java.lang.String... command)

Description copied from interface: IRemoteProcessService

Get a process builder for creating remote processes

Specified by:

getProcessBuilder in interface IRemoteProcessService

Returns:

process builder or null if connection is not open

getProperty

public java.lang.String getProperty(java.lang.String key)

Description copied from interface: IRemoteConnectionPropertyService

Gets the remote system property indicated by the specified key. The connection must be open prior to calling this method.

Specified by:

getProperty in interface IRemoteConnectionPropertyService

Parameters:

key - the name of the property

Returns:

the string value of the property, or null if no property has that key

getLoginShellCommand

public java.lang.String getLoginShellCommand()

Get the login shell command if useLoginShell is true

Returns:

login shell command

getProxyCommand

public java.lang.String getProxyCommand()

Gets the proxy command. For no proxy command null is returned.

Returns:

proxy command

getProxyConnection

public JSchConnection getProxyConnection()

Gets the proxy connection. If no proxy connection is used it returns null.

Returns:

proxy connection

getProxyConnectionName

public java.lang.String getProxyConnectionName()

Gets the proxy connection name

Returns:

proxy connection name. If no proxy is used returns null.

getSftpCommandChannel

public com.jcraft.jsch.ChannelSftp getSftpCommandChannel()
                                                  throws RemoteConnectionException

Open an sftp command channel to the remote host. This channel is for commands that do not require any state being preserved and should not be closed. Long running commands (such as get/put) should use a separate channel obtained via {#link #newSftpChannel()}. Always use the second session if available.

Returns:

sftp channel

Throws:

RemoteConnectionException - if a channel could not be opened

newSftpChannel

public com.jcraft.jsch.ChannelSftp newSftpChannel()
                                           throws RemoteConnectionException

Open a channel for long running commands. This channel should be closed when the command is completed.

Returns:

sftp channel

Throws:

RemoteConnectionException - if a channel could not be opened

getStreamForwarder

public com.jcraft.jsch.Channel getStreamForwarder(java.lang.String host,
                                                  int port)
                                           throws RemoteConnectionException

Throws:

RemoteConnectionException

getTimeout

public int getTimeout()

Description copied from interface: IRemoteConnectionHostService

Obtain the timeout used when establishing the connection.

Specified by:

getTimeout in interface IRemoteConnectionHostService

Returns:

timeout

getUsername

public java.lang.String getUsername()

Description copied from interface: IRemoteConnectionHostService

Obtain the username associated with this connection.

Specified by:

getUsername in interface IRemoteConnectionHostService

Returns:

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Description copied from interface: IRemoteProcessService

Get the working directory. Relative paths will be resolved using this path. The remote connection does not need to be open to use this method, however a default directory path, rather than the actual working directory, may be returned in this case.

Specified by:

getWorkingDirectory in interface IRemoteProcessService

Returns:

String representing the current working directory

hasOpenSession

public boolean hasOpenSession()

Test if the connection has a valid open session. Doesn't check whether the connection is fully setup.

Returns:

true if a valid session is available.

isOpen

public boolean isOpen()

Description copied from interface: IRemoteConnectionControlService

Test if the connection is open.

Specified by:

isOpen in interface IRemoteConnectionControlService

Returns:

true if connection is open.

isPasswordAuth

public boolean isPasswordAuth()

open

public void open(org.eclipse.core.runtime.IProgressMonitor monitor)
          throws RemoteConnectionException

Description copied from interface: IRemoteConnectionControlService

Open the connection. Must be called before the connection can be used.

Specified by:

open in interface IRemoteConnectionControlService

Parameters:

monitor - the progress monitor to use for reporting progress to the user. It is the caller's responsibility to call done() on the given monitor. Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

Throws:

RemoteConnectionException

openMinimal

public void openMinimal(org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws RemoteConnectionException

Open ssh connection without full setup (environment, sftp)

Parameters:

monitor -

Throws:

RemoteConnectionException

See Also:

org.eclipse.remote.core.IRemoteConnection#open()

removeLocalPortForwarding

public void removeLocalPortForwarding(int port)
                               throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Remove the local port forwarding associated with the given port.

Specified by:

removeLocalPortForwarding in interface IRemotePortForwardingService

Parameters:

port - forwarded port

Throws:

RemoteConnectionException

removeRemotePortForwarding

public void removeRemotePortForwarding(int port)
                                throws RemoteConnectionException

Description copied from interface: IRemotePortForwardingService

Remove the remote port forwarding associated with the given port.

Specified by:

removeRemotePortForwarding in interface IRemotePortForwardingService

Parameters:

port - forwarded port

Throws:

RemoteConnectionException

setWorkingDirectory

public void setWorkingDirectory(java.lang.String path)

Description copied from interface: IRemoteProcessService

Set the working directory while the connection is open. The working directory will revert to the default when the connection is closed then subsequently reopened. Relative paths will be resolved using this path. The path must be valid and absolute for any changes to be made.

Specified by:

setWorkingDirectory in interface IRemoteProcessService

Parameters:

path - String representing the current working directory

useLoginShell

public boolean useLoginShell()

Description copied from interface: IRemoteConnectionHostService

Obtain the flag that indicates a login shell should be started once the connection is established

Specified by:

useLoginShell in interface IRemoteConnectionHostService

Returns:

login shell flag

setHostname

public void setHostname(java.lang.String hostname)

Description copied from interface: IRemoteConnectionHostService

Set the hostname associated with this connection. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setHostname in interface IRemoteConnectionHostService

Parameters:

hostname - new hostname for connection

setPassphrase

public void setPassphrase(java.lang.String passphrase)

Description copied from interface: IRemoteConnectionHostService

Set the pass phrase associated with this connection. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setPassphrase in interface IRemoteConnectionHostService

setPassword

public void setPassword(java.lang.String password)

Description copied from interface: IRemoteConnectionHostService

Set the password associated with this connection. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setPassword in interface IRemoteConnectionHostService

Parameters:

password - new password for connection

setPort

public void setPort(int port)

Description copied from interface: IRemoteConnectionHostService

Set the port used for the connection. Note, this method can only be used forh an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setPort in interface IRemoteConnectionHostService

Parameters:

port - new port for connection

setTimeout

public void setTimeout(int timeout)

Description copied from interface: IRemoteConnectionHostService

Set the timeout used when establishing the connection. A timeout of 0 means infinite. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setTimeout in interface IRemoteConnectionHostService

Parameters:

timeout - new timeout value

setUseLoginShell

public void setUseLoginShell(boolean useLogingShell)

Description copied from interface: IRemoteConnectionHostService

Set the flag indicating a login shell should be stated for this connection. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setUseLoginShell in interface IRemoteConnectionHostService

Parameters:

useLogingShell - true to start a login shell

setUsePassword

public void setUsePassword(boolean usePassword)

Description copied from interface: IRemoteConnectionHostService

Set the connection to try password authentication first. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setUsePassword in interface IRemoteConnectionHostService

Parameters:

usePassword - use password authentication

setUsername

public void setUsername(java.lang.String username)

Description copied from interface: IRemoteConnectionHostService

Set the username associated with this connection. Note, this method can only be used for an IRemoteConnectionWorkingCopy and will have no effect otherwise.

Specified by:

setUsername in interface IRemoteConnectionHostService

Parameters:

username - new username for connection