net.sf.sshapi.impl.libssh

Class LibsshClient

java.lang.Object

net.sf.sshapi.AbstractClient

net.sf.sshapi.impl.libssh.LibsshClient

All Implemented Interfaces:

SshClient

public class LibsshClient
extends AbstractClient

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORWARDING_BUFFER_SIZE
static int	O_RDONLY
static int	O_RDWR
static int	O_WRONLY
static int	S_IRUSR
static int	S_IRWXU
static int	S_IWUSR
static int	S_IXUSR
static int	SCP_BUFFER_SIZE
static int	SFTP_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
LibsshClient(SshConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(SshAuthenticator[] authenticators) Authenticate.
void	connect(java.lang.String username, java.lang.String hostname, int port) Connect to specified host and port using the provided username.
SshExtendedStreamChannel	createCommand(java.lang.String command) Execute a command on the remote server.
SshPortForward	createLocalForward(java.lang.String localAddress, int localPort, java.lang.String remoteHost, int remotePort) Create a local forward.
SshPortForward	createRemoteForward(java.lang.String remoteHost, int remotePort, java.lang.String localAddress, int localPort) Create a remote forward.
SshSCPClient	createSCPClient() Create a new SCP client.
SftpClient	createSftpClient() Create a new SFTP client that may be used to perform file operations.
SshShell	createShell(java.lang.String termType, int cols, int rows, int pixWidth, int pixHeight, byte[] terminalModes) Create a new shell.
javax.net.SocketFactory	createTunneledSocketFactory() Create a SocketFactory whose connections are actually tunneled over this SSH connection and made from the remote machine.
void	disconnect() Disconnect this client.
int	getChannelCount() Get the number of channels that are currently open.
java.lang.String	getRemoteIdentification() Get the remote server identification string.
int	getRemoteProtocolVersion() Get the protocol version.
java.lang.String	getUsername() Get the currently authenticated user.
boolean	isAuthenticated() Get if the client is currently authenticated.
boolean	isConnected() Get if the client is currently connected.
protected static com.sun.jna.Pointer	stringPointer(java.lang.String str)

Methods inherited from class net.sf.sshapi.AbstractClient

addChannelHandler, addPortForwardListener, authenticate, createAuthenticatorMap, createPublicKeySubsystem, firePortForwardChannelClosed, firePortForwardChannelOpened, getConfiguration, getProvider, getTimeout, init, removeChannelHandler, removePortForwardListener, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

S_IRWXU

public static final int S_IRWXU

See Also:

Constant Field Values

S_IRUSR

public static final int S_IRUSR

See Also:

Constant Field Values

S_IWUSR

public static final int S_IWUSR

See Also:

Constant Field Values

S_IXUSR

public static final int S_IXUSR

See Also:

Constant Field Values

O_RDONLY

public static final int O_RDONLY

See Also:

Constant Field Values

O_WRONLY

public static final int O_WRONLY

See Also:

Constant Field Values

O_RDWR

public static final int O_RDWR

See Also:

Constant Field Values

SCP_BUFFER_SIZE

public static final int SCP_BUFFER_SIZE

See Also:

Constant Field Values

SFTP_BUFFER_SIZE

public static final int SFTP_BUFFER_SIZE

See Also:

Constant Field Values

FORWARDING_BUFFER_SIZE

public static final int FORWARDING_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

LibsshClient

public LibsshClient(SshConfiguration configuration)

Method Detail

connect

public void connect(java.lang.String username,
                    java.lang.String hostname,
                    int port)
             throws SshException

Description copied from interface: SshClient

Connect to specified host and port using the provided username.

Parameters:

username - user name

hostname - host name

port - port

Throws:

SshException - on any error

stringPointer

protected static final com.sun.jna.Pointer stringPointer(java.lang.String str)

createTunneledSocketFactory

public javax.net.SocketFactory createTunneledSocketFactory()
                                                    throws SshException

Description copied from interface: SshClient

Create a SocketFactory whose connections are actually tunneled over this SSH connection and made from the remote machine. This actually makes use of local port forward, but instead of setting up a local server socket, the tunnels are accessable as Socket objects.

Returns:

tunneled socket factory

Throws:

SshException

createSCPClient

public SshSCPClient createSCPClient()
                             throws SshException

Description copied from interface: SshClient

Create a new SCP client. This may be used for simple file transfer. For a more fully featured file-system like approach, use SshClient.createSftpClient().

Returns:

scp client

Throws:

SshException - on any error

authenticate

public boolean authenticate(SshAuthenticator[] authenticators)
                     throws SshException

Description copied from interface: SshClient

Authenticate. An authenticator should be provided for each type supported. This method may be called multiple times until true is return or an exception is thrown.

Parameters:

authenticators - authenticators.

Returns:

true when full authenticated, or false if more authentication is required

Throws:

SshException

getRemoteIdentification

public java.lang.String getRemoteIdentification()

Description copied from interface: SshClient

Get the remote server identification string. Client must be connected.

Returns:

remote identification

getRemoteProtocolVersion

public int getRemoteProtocolVersion()

Description copied from interface: SshClient

Get the protocol version. Will be one of SshConfiguration.SSH1_ONLY or SshConfiguration.SSH2_ONLY.

Returns:

protocol version

createLocalForward

public SshPortForward createLocalForward(java.lang.String localAddress,
                                         int localPort,
                                         java.lang.String remoteHost,
                                         int remotePort)
                                  throws SshException

Description copied from interface: SshClient

Create a local forward. Local forwards create a listening socket on the client that is tunneled through to the remote server which then makes the connection to the target.

Once you have created the SshPortForward object, you must start tunnel using SshPortForward.open(). When you have finished with the tunnel, call SshPortForward.close() (closed tunnels may be re-opened by calling the SshPortForward.open() method again).

Parameters:

localAddress - local address to bind to. Use null to bind to all addresses. Note, this may not be supported by all implementations.

localPort - local port to listen on

remoteHost - remote host to tunnel to

remotePort - remote port to tunnel to

Returns:

local forward

Throws:

SshException - on any error

createRemoteForward

public SshPortForward createRemoteForward(java.lang.String remoteHost,
                                          int remotePort,
                                          java.lang.String localAddress,
                                          int localPort)
                                   throws SshException

Description copied from interface: SshClient

Create a remote forward. Remote forwards create a listening socket on the SSH server you are connected to, and tunnel connections back to the client end and then on to the target.

Once you have created the SshPortForward object, you must start tunnel using SshPortForward.open(). When you have finished with the tunnel, call SshPortForward.close() (closed tunnels may be re-opened by calling the SshPortForward.open() method again).

Parameters:

remoteHost - the address on the remote server to listen. This must either be null to bind to all address on that server, or a single address that exists on that server (including 127.0.0.1).

remotePort - remote port to tunnel to

localAddress - local address to bind to. Use null to bind to all addresses. Note, this may not be supported by all implementations.

localPort - local port to listen on

Returns:

local forward

Throws:

SshException - on any error

createShell

public SshShell createShell(java.lang.String termType,
                            int cols,
                            int rows,
                            int pixWidth,
                            int pixHeight,
                            byte[] terminalModes)
                     throws SshException

Description copied from interface: SshClient

Create a new shell.

Note, this method does not actually start the shell, you must call SshLifecycleComponent.open() to do that.

Remember to close the shell when you are finished with it using SshLifecycleComponent.close().

Parameters:

termType - terminal type, or use null to NOT request a pseudo terminal

cols - width of terminal in characters (use zero if not pseudo terminal should be requested)

rows - height of terminal in characters (use zero if not pseudo terminal should be requested)

pixWidth - width of terminal in pixels (if known, otherwise use zero)

pixHeight - height of terminal in pixels (if known, otherwise use zero)

terminalModes - terminal modes (or null or empty array)

Returns:

shell

Throws:

SshException

createCommand

public SshExtendedStreamChannel createCommand(java.lang.String command)
                                       throws SshException

Description copied from interface: SshClient

Execute a command on the remote server.

Note, this method does not actually start the command, you must call SshLifecycleComponent.open() to do that.

Remember to close the channel when you are finished with it using SshLifecycleComponent.close().

Parameters:

command - command to execute

Returns:

channel

Throws:

SshException - on any error

disconnect

public void disconnect()
                throws SshException

Description copied from interface: SshClient

Disconnect this client.

Throws:

SshException

isConnected

public boolean isConnected()

Description copied from interface: SshClient

Get if the client is currently connected. A client may be connected, but not yet authenticated.

Returns:

connected

See Also:

SshClient.isAuthenticated()

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: SshClient

Get if the client is currently authenticated. This implies the client is connected.

Returns:

authenticated

See Also:

SshClient.isConnected()

createSftpClient

public SftpClient createSftpClient()
                            throws SshException

Description copied from interface: SshClient

Create a new SFTP client that may be used to perform file operations.

Note, this method does not actually start the client, you must call SshLifecycleComponent.open() to do that.

Remember to close the client when you are finished with it using SshLifecycleComponent.close().

Returns:

SFTP client

Throws:

SshException

getUsername

public java.lang.String getUsername()

Description copied from interface: SshClient

Get the currently authenticated user.

Returns:

user

getChannelCount

public int getChannelCount()

Description copied from interface: SshClient

Get the number of channels that are currently open.

Returns:

open channels