org.apache.sshd.client.session

Class ClientSessionImpl

java.lang.Object

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.session.AbstractSession

org.apache.sshd.client.session.ClientSessionImpl

All Implemented Interfaces:

ClientSession, Closeable, Session

public class ClientSessionImpl
extends AbstractSession
implements ClientSession

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.session.AbstractSession

AbstractSession.PendingWriteFuture

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

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
protected AuthFuture	authFuture

Fields inherited from class org.apache.sshd.common.session.AbstractSession

attributes, authed, authTimeoutMs, authTimeoutTimestamp, clientProposal, clientVersion, currentService, decodeLock, decoderBuffer, decoderLength, decoderState, disconnectTimeoutMs, encodeLock, factoryManager, I_C, I_S, idleTimeoutMs, idleTimeoutTimestamp, inBytes, inCipher, inCipherSize, inCompression, inMac, inMacResult, inPackets, ioSession, isServer, kex, KEX_STATE_DONE, KEX_STATE_INIT, KEX_STATE_KEYS, KEX_STATE_RUN, kexState, lastKeyTime, listeners, negotiated, outBytes, outCipher, outCipherSize, outCompression, outMac, outPackets, pendingPackets, random, reexchangeFuture, requestLock, requestResult, seqi, seqo, serverProposal, serverVersion, SESSION, sessionId, sessionListenerProxy, timeoutStatus, uncompressBuffer, username

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, log, state

Fields inherited from interface org.apache.sshd.ClientSession

AUTHED, CLOSED, TIMEOUT, WAIT_AUTH

Constructor Summary

Constructors

Constructor and Description
ClientSessionImpl(ClientFactoryManager client, IoSession session)

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 user) Authenticate the session with the given username using an ssh agent.
AuthFuture	authInteractive(String user, String password) Authenticate the session with the given username and password.
AuthFuture	authPassword(String user, String password) Authenticate the session with the given username and password.
AuthFuture	authPublicKey(String user, KeyPair key) Authenticate the session with the given username and public key.
protected void	checkKeys()
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() Retrieve the factory manager
Map<Object,Object>	getMetadataMap() Access to the metadata.
protected Service[]	getServices()
UserInteraction	getUserInteraction()
protected void	handleMessage(Buffer buffer) Abstract method for processing incoming decoded packets.
protected boolean	readIdentification(Buffer buffer) Read the other side identification.
protected void	receiveKexInit(Buffer buffer)
protected void	sendEvent(SessionListener.Event event)
protected void	sendInitialServiceRequest()
protected void	sendKexInit()
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	startService(String name)
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.
protected void	switchToNextService()
SshFuture	switchToNoneCipher() Switch to a none cipher for performance.
int	waitFor(int mask, long timeout) Wait for a specific state.

Methods inherited from class org.apache.sshd.common.session.AbstractSession

addListener, attachSession, checkForTimeouts, checkRekey, createBuffer, createBuffer, createProposal, decode, disconnect, doCloseImmediately, doHandleMessage, doReadIdentification, doWritePacket, exceptionCaught, getAttribute, getAuthTimeout, getClientVersion, getIdleTimeout, getInnerCloseable, getIntProperty, getIoSession, getKex, getLock, getLongProperty, getNegotiatedKexParameter, getServerVersion, getService, getSession, getSession, getSessionId, getTimeoutStatus, getUsername, isAuthenticated, messageReceived, negotiate, notImplemented, receiveKexInit, receiveNewKeys, reExchangeKeys, removeListener, request, requestFailure, requestSuccess, resetIdleTimeout, sendIdentification, sendKexInit, sendNewKeys, serviceAccept, setAttribute, setAuthenticated, setUsername, toString, writePacket, writePacket

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.ClientSession

close

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

authFuture

protected AuthFuture authFuture

Constructor Detail

ClientSessionImpl

public ClientSessionImpl(ClientFactoryManager client,
                 IoSession session)
                  throws Exception

Throws:

Exception

Method Detail

getServices

protected Service[] getServices()

Overrides:

getServices in class AbstractSession

getFactoryManager

public ClientFactoryManager getFactoryManager()

Description copied from class: AbstractSession

Retrieve the factory manager

Specified by:

getFactoryManager in interface ClientSession

Specified by:

getFactoryManager in interface Session

Overrides:

getFactoryManager in class AbstractSession

Returns:

the factory manager for this session

addPasswordIdentity

public void addPasswordIdentity(String password)

Specified by:

addPasswordIdentity in interface ClientSession

addPublicKeyIdentity

public void addPublicKeyIdentity(KeyPair key)

Specified by:

addPublicKeyIdentity in interface ClientSession

getUserInteraction

public UserInteraction getUserInteraction()

Specified by:

getUserInteraction in interface ClientSession

setUserInteraction

public void setUserInteraction(UserInteraction userInteraction)

Specified by:

setUserInteraction in interface ClientSession

auth

public AuthFuture auth()
                throws IOException

Description copied from interface: ClientSession

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 ClientSession.addPasswordIdentity(String) or ClientSession.addPublicKeyIdentity(java.security.KeyPair).

Specified by:

auth in interface ClientSession

Returns:

the authentication future

Throws:

IOException

See Also:

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

authAgent

public AuthFuture authAgent(String user)
                     throws IOException

Description copied from interface: ClientSession

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

Specified by:

authAgent in interface ClientSession

Throws:

IOException

See Also:

ClientSession.auth()

authPassword

public AuthFuture authPassword(String user,
                      String password)
                        throws IOException

Description copied from interface: ClientSession

Authenticate the session with the given username and password.

Specified by:

authPassword in interface ClientSession

Throws:

IOException

See Also:

ClientSession.auth()

authInteractive

public AuthFuture authInteractive(String user,
                         String password)
                           throws IOException

Description copied from interface: ClientSession

Authenticate the session with the given username and password.

Specified by:

authInteractive in interface ClientSession

Throws:

IOException

See Also:

ClientSession.auth()

authPublicKey

public AuthFuture authPublicKey(String user,
                       KeyPair key)
                         throws IOException

Description copied from interface: ClientSession

Authenticate the session with the given username and public key.

Specified by:

authPublicKey in interface ClientSession

Throws:

IOException

See Also:

ClientSession.auth()

switchToNextService

protected void switchToNextService()
                            throws IOException

Throws:

IOException

switchToNoneCipher

public SshFuture switchToNoneCipher()
                             throws IOException

Description copied from interface: ClientSession

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.

Specified by:

switchToNoneCipher in interface ClientSession

Returns:

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

Throws:

IOException - if a key exchange is already running

createChannel

public ClientChannel createChannel(String type)
                            throws IOException

Description copied from interface: ClientSession

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

Specified by:

createChannel in interface ClientSession

Throws:

IOException

createChannel

public ClientChannel createChannel(String type,
                          String subType)
                            throws IOException

Description copied from interface: ClientSession

Create a channel of the given type and subtype.

Specified by:

createChannel in interface ClientSession

Throws:

IOException

createShellChannel

public ChannelShell createShellChannel()
                                throws IOException

Description copied from interface: ClientSession

Create a channel to start a shell.

Specified by:

createShellChannel in interface ClientSession

Throws:

IOException

createExecChannel

public ChannelExec createExecChannel(String command)
                              throws IOException

Description copied from interface: ClientSession

Create a channel to execute a command.

Specified by:

createExecChannel in interface ClientSession

Throws:

IOException

createSubsystemChannel

public ChannelSubsystem createSubsystemChannel(String subsystem)
                                        throws IOException

Description copied from interface: ClientSession

Create a subsystem channel.

Specified by:

createSubsystemChannel in interface ClientSession

Throws:

IOException

createDirectTcpipChannel

public ChannelDirectTcpip createDirectTcpipChannel(SshdSocketAddress local,
                                          SshdSocketAddress remote)
                                            throws IOException

Description copied from interface: ClientSession

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

Specified by:

createDirectTcpipChannel in interface ClientSession

Throws:

IOException

createScpClient

public ScpClient createScpClient()

Description copied from interface: ClientSession

Create an SCP client from this session.

Specified by:

createScpClient in interface ClientSession

createSftpClient

public SftpClient createSftpClient()
                            throws IOException

Description copied from interface: ClientSession

Create an SFTP client from this session.

Specified by:

createSftpClient in interface ClientSession

Throws:

IOException

startLocalPortForwarding

public SshdSocketAddress startLocalPortForwarding(SshdSocketAddress local,
                                         SshdSocketAddress remote)
                                           throws IOException

Description copied from interface: ClientSession

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

Specified by:

startLocalPortForwarding in interface ClientSession

Throws:

IOException

stopLocalPortForwarding

public void stopLocalPortForwarding(SshdSocketAddress local)
                             throws IOException

Description copied from interface: ClientSession

Stop forwarding the given local address.

Specified by:

stopLocalPortForwarding in interface ClientSession

Throws:

IOException

startRemotePortForwarding

public SshdSocketAddress startRemotePortForwarding(SshdSocketAddress remote,
                                          SshdSocketAddress local)
                                            throws IOException

Description copied from interface: ClientSession

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

Specified by:

startRemotePortForwarding in interface ClientSession

Throws:

IOException

stopRemotePortForwarding

public void stopRemotePortForwarding(SshdSocketAddress remote)
                              throws IOException

Description copied from interface: ClientSession

Stop forwarding of the given remote address.

Specified by:

stopRemotePortForwarding in interface ClientSession

Throws:

IOException

startDynamicPortForwarding

public SshdSocketAddress startDynamicPortForwarding(SshdSocketAddress local)
                                             throws IOException

Description copied from interface: ClientSession

Start dynamic local port forwarding using a SOCKS proxy.

Specified by:

startDynamicPortForwarding in interface ClientSession

Returns:

Throws:

IOException

stopDynamicPortForwarding

public void stopDynamicPortForwarding(SshdSocketAddress local)
                               throws IOException

Description copied from interface: ClientSession

Stop a previously started dynamic port forwarding.

Specified by:

stopDynamicPortForwarding in interface ClientSession

Throws:

IOException

handleMessage

protected void handleMessage(Buffer buffer)
                      throws Exception

Description copied from class: AbstractSession

Abstract method for processing incoming decoded packets. The given buffer will hold the decoded packet, starting from the command byte at the read position. Packets must be processed within this call or be copied because the given buffer is meant to be changed and updated when this method returns.

Overrides:

handleMessage in class AbstractSession

Parameters:

buffer - the buffer containing the packet

Throws:

Exception - if an exeption occurs while handling this packet.

waitFor

public int waitFor(int mask,
          long timeout)

Description copied from interface: ClientSession

Wait for a specific state.

Specified by:

waitFor in interface ClientSession

readIdentification

protected boolean readIdentification(Buffer buffer)
                              throws IOException

Description copied from class: AbstractSession

Read the other side identification. This method is specific to the client or server side, but both should call AbstractSession.doReadIdentification(org.apache.sshd.common.util.Buffer,boolean) and store the result in the needed property.

Specified by:

readIdentification in class AbstractSession

Parameters:

buffer - the buffer containing the remote identification

Returns:

true if the identification has been fully read or false if more data is needed

Throws:

IOException - if an error occurs such as a bad protocol version

sendKexInit

protected void sendKexInit()
                    throws IOException

Specified by:

sendKexInit in class AbstractSession

Throws:

IOException

receiveKexInit

protected void receiveKexInit(Buffer buffer)
                       throws IOException

Specified by:

receiveKexInit in class AbstractSession

Throws:

IOException

checkKeys

protected void checkKeys()
                  throws SshException

Specified by:

checkKeys in class AbstractSession

Throws:

SshException

sendEvent

protected void sendEvent(SessionListener.Event event)
                  throws IOException

Overrides:

sendEvent in class AbstractSession

Throws:

IOException

sendInitialServiceRequest

protected void sendInitialServiceRequest()
                                  throws IOException

Throws:

IOException

startService

public void startService(String name)
                  throws Exception

Specified by:

startService in class AbstractSession

Throws:

Exception

getMetadataMap

public Map<Object,Object> getMetadataMap()

Description copied from interface: ClientSession

Access to the metadata.

Specified by:

getMetadataMap in interface ClientSession