org.apache.sshd

Interface ClientSession

All Superinterfaces:

Closeable, Session

All Known Implementing Classes:

ClientSessionImpl

public interface ClientSession
extends Session

An authenticated session to a given SSH server A client session is established using the SshClient. Once the session has been created, the user has to authenticate using either authPassword(String, String) or authPublicKey(String, java.security.KeyPair). From this session, channels can be created using the createChannel(String) method. Multiple channels can be created on a given session concurrently. When using the client in an interactive mode, the waitFor(int, long) method can be used to listen to specific events such as the session being established, authenticated or closed. When a given session is no longer used, it must be closed using the close(boolean) method.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.Session

Session.AttributeKey<T>, Session.TimeoutStatus

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHED
static int	CLOSED
static int	TIMEOUT
static int	WAIT_AUTH

Method Summary

Methods

Modifier and Type	Method and Description
void	addPasswordIdentity(String password)
void	addPublicKeyIdentity(KeyPair key)
AuthFuture	auth() Starts the authentication process.
AuthFuture	authAgent(String username) Deprecated. Use auth() instead
AuthFuture	authInteractive(String username, String password) Deprecated. Use auth() instead
AuthFuture	authPassword(String username, String password) Deprecated. Use auth() instead
AuthFuture	authPublicKey(String username, KeyPair key) Deprecated. Use auth() instead
CloseFuture	close(boolean immediately) Close this session.
ClientChannel	createChannel(String type) Create a channel of the given type.
ClientChannel	createChannel(String type, String subType) Create a channel of the given type and subtype.
ChannelDirectTcpip	createDirectTcpipChannel(SshdSocketAddress local, SshdSocketAddress remote) Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.
ChannelExec	createExecChannel(String command) Create a channel to execute a command.
ScpClient	createScpClient() Create an SCP client from this session.
SftpClient	createSftpClient() Create an SFTP client from this session.
ChannelShell	createShellChannel() Create a channel to start a shell.
ChannelSubsystem	createSubsystemChannel(String subsystem) Create a subsystem channel.
ClientFactoryManager	getFactoryManager() Return ClientFactoryManager for this session.
Map<Object,Object>	getMetadataMap() Access to the metadata.
UserInteraction	getUserInteraction()
void	setUserInteraction(UserInteraction userInteraction)
SshdSocketAddress	startDynamicPortForwarding(SshdSocketAddress local) Start dynamic local port forwarding using a SOCKS proxy.
SshdSocketAddress	startLocalPortForwarding(SshdSocketAddress local, SshdSocketAddress remote) Start forwarding the given local address on the client to the given address on the server.
SshdSocketAddress	startRemotePortForwarding(SshdSocketAddress remote, SshdSocketAddress local) Start forwarding tcpip from the given address on the server to the given address on the client.
void	stopDynamicPortForwarding(SshdSocketAddress local) Stop a previously started dynamic port forwarding.
void	stopLocalPortForwarding(SshdSocketAddress local) Stop forwarding the given local address.
void	stopRemotePortForwarding(SshdSocketAddress remote) Stop forwarding of the given remote address.
SshFuture	switchToNoneCipher() Switch to a none cipher for performance.
int	waitFor(int mask, long timeout) Wait for a specific state.

Methods inherited from interface org.apache.sshd.common.Session

addListener, createBuffer, createBuffer, exceptionCaught, getAttribute, getAuthTimeout, getClientVersion, getIdleTimeout, getIntProperty, getIoSession, getNegotiatedKexParameter, getServerVersion, getService, getTimeoutStatus, getUsername, reExchangeKeys, removeListener, request, resetIdleTimeout, setAttribute, writePacket, writePacket

Methods inherited from interface org.apache.sshd.common.Closeable

isClosed, isClosing

Field Detail

TIMEOUT

static final int TIMEOUT

See Also:

Constant Field Values

CLOSED

static final int CLOSED

See Also:

Constant Field Values

WAIT_AUTH

static final int WAIT_AUTH

See Also:

Constant Field Values

AUTHED

static final int AUTHED

See Also:

Constant Field Values

Method Detail

addPasswordIdentity

void addPasswordIdentity(String password)

addPublicKeyIdentity

void addPublicKeyIdentity(KeyPair key)

getUserInteraction

UserInteraction getUserInteraction()

setUserInteraction

void setUserInteraction(UserInteraction userInteraction)

auth

AuthFuture auth()
                throws IOException

Starts the authentication process. User identities will be tried until the server successfully authenticate the user. User identities must be provided before calling this method using addPasswordIdentity(String) or addPublicKeyIdentity(java.security.KeyPair).

Returns:

the authentication future

Throws:

IOException

See Also:

addPasswordIdentity(String), addPublicKeyIdentity(java.security.KeyPair)

authAgent

@Deprecated
AuthFuture authAgent(String username)
                     throws IOException

Deprecated. Use auth() instead

Authenticate the session with the given username using an ssh agent.

Throws:

IOException

See Also:

auth()

authPassword

@Deprecated
AuthFuture authPassword(String username,
                                 String password)
                        throws IOException

Deprecated. Use auth() instead

Authenticate the session with the given username and password.

Throws:

IOException

See Also:

auth()

authInteractive

@Deprecated
AuthFuture authInteractive(String username,
                                    String password)
                           throws IOException

Deprecated. Use auth() instead

Authenticate the session with the given username and password.

Throws:

IOException

See Also:

auth()

authPublicKey

@Deprecated
AuthFuture authPublicKey(String username,
                                  KeyPair key)
                         throws IOException

Deprecated. Use auth() instead

Authenticate the session with the given username and public key.

Throws:

IOException

See Also:

auth()

createChannel

ClientChannel createChannel(String type)
                            throws IOException

Create a channel of the given type. Same as calling createChannel(type, null).

Throws:

IOException

createChannel

ClientChannel createChannel(String type,
                          String subType)
                            throws IOException

Create a channel of the given type and subtype.

Throws:

IOException

createShellChannel

ChannelShell createShellChannel()
                                throws IOException

Create a channel to start a shell.

Throws:

IOException

createExecChannel

ChannelExec createExecChannel(String command)
                              throws IOException

Create a channel to execute a command.

Throws:

IOException

createSubsystemChannel

ChannelSubsystem createSubsystemChannel(String subsystem)
                                        throws IOException

Create a subsystem channel.

Throws:

IOException

createDirectTcpipChannel

ChannelDirectTcpip createDirectTcpipChannel(SshdSocketAddress local,
                                          SshdSocketAddress remote)
                                            throws IOException

Create a direct tcp-ip channel which can be used to stream data to a remote port from the server.

Throws:

IOException

createScpClient

ScpClient createScpClient()

Create an SCP client from this session.

createSftpClient

SftpClient createSftpClient()
                            throws IOException

Create an SFTP client from this session.

Throws:

IOException

startLocalPortForwarding

SshdSocketAddress startLocalPortForwarding(SshdSocketAddress local,
                                         SshdSocketAddress remote)
                                           throws IOException

Start forwarding the given local address on the client to the given address on the server.

Throws:

IOException

stopLocalPortForwarding

void stopLocalPortForwarding(SshdSocketAddress local)
                             throws IOException

Stop forwarding the given local address.

Throws:

IOException

startRemotePortForwarding

SshdSocketAddress startRemotePortForwarding(SshdSocketAddress remote,
                                          SshdSocketAddress local)
                                            throws IOException

Start forwarding tcpip from the given address on the server to the given address on the client. The remote host name is the address to bind to on the server:

• "" means that connections are to be accepted on all protocol families supported by the SSH implementation
• "0.0.0.0" means to listen on all IPv4 addresses
• "::" means to listen on all IPv6 addresses
• "localhost" means to listen on all protocol families supported by the SSH implementation on loopback addresses only, [RFC3330] and RFC3513]
• "127.0.0.1" and "::1" indicate listening on the loopback interfaces for IPv4 and IPv6 respectively

Throws:

IOException

stopRemotePortForwarding

void stopRemotePortForwarding(SshdSocketAddress remote)
                              throws IOException

Stop forwarding of the given remote address.

Throws:

IOException

startDynamicPortForwarding

SshdSocketAddress startDynamicPortForwarding(SshdSocketAddress local)
                                             throws IOException

Start dynamic local port forwarding using a SOCKS proxy.

Parameters:

local -

Returns:

Throws:

IOException

stopDynamicPortForwarding

void stopDynamicPortForwarding(SshdSocketAddress local)
                               throws IOException

Stop a previously started dynamic port forwarding.

Parameters:

local -

Throws:

IOException

waitFor

int waitFor(int mask,
          long timeout)

Wait for a specific state.

close

CloseFuture close(boolean immediately)

Close this session.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

getMetadataMap

Map<Object,Object> getMetadataMap()

Access to the metadata.

getFactoryManager

ClientFactoryManager getFactoryManager()

Return ClientFactoryManager for this session.

Specified by:

getFactoryManager in interface Session

Returns:

the factory manager, can not be null.

switchToNoneCipher

SshFuture switchToNoneCipher()
                             throws IOException

Switch to a none cipher for performance. This should be done after the authentication phase has been performed. After such a switch, interactive channels are not allowed anymore. Both client and server must have been configured to support the none cipher. If that's not the case, the returned future will be set with an exception.

Returns:

an SshFuture that can be used to wait for the exchange to be finished

Throws:

IOException - if a key exchange is already running