com.sshtools.client

Class SshClientContext

java.lang.Object

com.sshtools.common.nio.ProtocolContext

com.sshtools.common.ssh.SshContext

com.sshtools.client.SshClientContext

All Implemented Interfaces:

ExecutorServiceProvider

public class SshClientContext
extends SshContext

Holds the configuration for an SSH connection.

Field Summary

Fields inherited from class com.sshtools.common.ssh.SshContext

byteBufferPool, CIPHER_AES128_CBC, CIPHER_AES128_CTR, CIPHER_AES192_CBC, CIPHER_AES192_CTR, CIPHER_AES256_CBC, CIPHER_AES256_CTR, CIPHER_ARCFOUR, CIPHER_ARCFOUR_128, CIPHER_ARCFOUR_256, CIPHER_BLOWFISH_CBC, CIPHER_TRIPLEDES_CBC, CIPHER_TRIPLEDES_CTR, ciphersCS, ciphersSC, COMPRESSION_NONE, COMPRESSION_ZLIB, compressionLevel, compressionsCS, compressionsSC, daemon, executor, forwardingBufferMaxQueueCount, forwardingPolicy, HMAC_MD5, HMAC_MD5_96, HMAC_MD5_ETM, HMAC_RIPEMD160, HMAC_RIPEMD160_ETM, HMAC_SHA1, HMAC_SHA1_96, HMAC_SHA1_ETM, HMAC_SHA256, HMAC_SHA256_96, HMAC_SHA256_ETM, HMAC_SHA512, HMAC_SHA512_96, HMAC_SHA512_ETM, idleAuthenticationTimeoutSeconds, idleConnectionTimeout, keepAliveDataMaxLength, keepAliveInterval, KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1, KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256, KEX_DIFFIE_HELLMAN_GROUP1_SHA1, KEX_DIFFIE_HELLMAN_GROUP14_SHA1, KEYBOARD_INTERACTIVE_AUTHENTICATION, keyExchanges, killTunnelsOnRemoteForwardingCancel, locale, macCS, macSC, MAX_NUM_BYTES_BEFORE_REKEY, MAX_NUM_PACKETS_BEFORE_REKEY, maxAuthentications, maxChannels, maximumPacketLength, maximumSocketsBacklogPerRemotelyForwardedConnection, minDHGroupExchangeKeySize, PASSWORD_AUTHENTICATION, prefCipherCS, prefCipherSC, prefCompressionCS, prefCompressionSC, prefKeyExchange, prefMacCS, prefMacSC, prefPublicKey, PUBLIC_KEY_ECDSA_SHA2_NISPTP_256, PUBLIC_KEY_ECDSA_SHA2_NISPTP_384, PUBLIC_KEY_ECDSA_SHA2_NISPTP_521, PUBLIC_KEY_SSHDSS, PUBLIC_KEY_SSHRSA, PUBLICKEY_AUTHENTICATION, publicKeys, softwareVersionComments

Fields inherited from class com.sshtools.common.nio.ProtocolContext

keepAlive, receiveBufferSize, reuseAddress, sendBufferSize, tcpNoDelay

Constructor Summary

Constructors

Constructor and Description
SshClientContext(SshEngine daemon)
SshClientContext(SshEngine daemon, ComponentManager componentManager)

Method Summary

Modifier and Type	Method and Description
void	addAuthenticator(ClientAuthenticator auth)
void	addGlobalRequestHandler(GlobalRequestHandler<SshClientContext> handler)
void	addStateListener(ConnectionStateListener<SshClientContext> stateListener)
protected void	configureKeyExchanges()
ProtocolEngine	createEngine(ConnectRequestFuture connectFuture) Create a protocol engine.
List<ClientAuthenticator>	getAuthenticators()
BannerDisplay	getBannerDisplay()
ChannelFactory<SshClientContext>	getChannelFactory()
ConnectionManager<SshClientContext>	getConnectionManager()
SshEngineContext	getDaemonContext()
SshEngine	getEngine() Get the instance of the SSHD for this context.
ForwardingManager<SshClientContext>	getForwardingManager()
GlobalRequestHandler<SshClientContext>	getGlobalRequestHandler(String name)
String	getPreferredPublicKey()
int	getSessionMaxPacketSize()
int	getSessionMaxWindowSize()
SocketConnectionFactory	getSocketConnectionFactory()
Collection<ConnectionStateListener<SshClientContext>>	getStateListeners()
int	getSubsystemCacheSize()
String	getSupportedPublicKeys()
int	getTerminalColumns()
int	getTerminalHeight()
byte[]	getTerminalModes()
int	getTerminalRows()
String	getTerminalType()
int	getTerminalWidth()
String	getUsername() Get the username of this connection.
boolean	isAllocatePseudoTerminal()
void	keysExchanged()
void	setAllocatePseudoTerminal(boolean allocatePseudoTerminal)
void	setBannerDisplay(BannerDisplay bannerDisplay)
void	setConnectionManager(ConnectionManager<SshClientContext> connectionManager)
void	setForwardingManager(ForwardingManager<SshClientContext> forwardingManager)
void	setSubsystemCacheSize(int subsystemCacheSize)
void	setTerminalColumns(int cols)
void	setTerminalHeight(int height)
void	setTerminalModes(byte[] modes)
void	setTerminalRows(int rows)
void	setTerminalType(String term)
void	setTerminalWidth(int width)
void	setUsername(String username) Set the username for this connection.
ComponentFactory<SshKeyExchange<?>>	supportedKeyExchanges() Get the supported key exchange methods.

Methods inherited from class com.sshtools.common.ssh.SshContext

addOperationListener, enableFIPSMode, getByteBufferPool, getChannelLimit, getCiphersCS, getCiphersSC, getComponentManager, getCompressionLevel, getExecutorListeners, getExecutorService, getForwardingBufferMaxQueueCount, getForwardingPolicy, getIdleAuthenticationTimeoutSeconds, getIdleConnectionTimeoutSeconds, getKeepAliveDataMaxLength, getKeepAliveInterval, getKeyExchangePacketLimit, getKeyExchanges, getKeyExchangeTransferLimit, getLocale, getMacsCS, getMacsSC, getMaxAuthentications, getMaximumPacketLength, getMaximumSocketsBacklogPerRemotelyForwardedConnection, getMinDHGroupExchangeKeySize, getPreferredCipherCS, getPreferredCipherSC, getPreferredCompressionCS, getPreferredCompressionSC, getPreferredKeyExchange, getPreferredMacCS, getPreferredMacSC, getPublicKeys, getRemoteForwardingCancelKillsTunnels, getSoftwareVersionComments, init, listPublicKeys, removeOperationListener, setChannelLimit, setCipherPreferredPositionCS, setCipherPreferredPositionSC, setCompressionLevel, setForwardingBufferMaxQueueCount, setForwardingPolicy, setIdleAuthenticationTimeoutSeconds, setIdleConnectionTimeoutSeconds, setKeepAliveDataMaxLength, setKeepAliveInterval, setKeyExchangePacketLimit, setKeyExchangePreferredPosition, setKeyExchangeTransferLimit, setLocale, setMacPreferredPositionCS, setMacPreferredPositionSC, setMaxAuthentications, setMaximumPacketLength, setMaximumSocketsBacklogPerRemotelyForwardedConnection, setMinDHGroupExchangeKeySize, setPreferredCipherCC, setPreferredCipherCS, setPreferredCipherCS, setPreferredCipherSC, setPreferredCipherSC, setPreferredCipherSC, setPreferredCompressionCS, setPreferredCompressionSC, setPreferredKeyExchange, setPreferredKeyExchange, setPreferredMacCS, setPreferredMacCS, setPreferredMacCS, setPreferredMacSC, setPreferredMacSC, setPreferredMacSC, setPublicKeyPreferredPosition, setRemoteForwardingCancelKillsTunnels, setSocketConnectionFactory, setSoftwareVersionComments, shutdown, supportedCiphersCS, supportedCiphersSC, supportedCompressionsCS, supportedCompressionsSC, supportedMacsCS, supportedMacsSC, supportedPublicKeys

Methods inherited from class com.sshtools.common.nio.ProtocolContext

createConnection, createConnectionImpl, getReceiveBufferSize, getSendBufferSize, getSocketOptionKeepAlive, getSocketOptionReuseAddress, getSocketOptionTcpNoDelay, setReceiveBufferSize, setSendBufferSize, setSocketHandlerImpl, setSocketOptionKeepAlive, setSocketOptionReuseAddress, setSocketOptionTcpNoDelay

Methods inherited from class java.lang.Object

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

Constructor Detail

SshClientContext

public SshClientContext(SshEngine daemon,
                        ComponentManager componentManager)
                 throws IOException

Throws:

IOException

SshClientContext

public SshClientContext(SshEngine daemon)
                 throws IOException

Throws:

IOException

Method Detail

createEngine

public ProtocolEngine createEngine(ConnectRequestFuture connectFuture)
                            throws IOException

Description copied from class: ProtocolContext

Create a protocol engine.

Specified by:

createEngine in class SshContext

Returns:

ProtocolEngine

Throws:

IOException

getEngine

public final SshEngine getEngine()

Description copied from class: SshContext

Get the instance of the SSHD for this context.

Overrides:

getEngine in class SshContext

Returns:

Daemon

setUsername

public void setUsername(String username)

Set the username for this connection.

Parameters:

username -

getUsername

public String getUsername()

Get the username of this connection.

Returns:

addStateListener

public void addStateListener(ConnectionStateListener<SshClientContext> stateListener)

getStateListeners

public Collection<ConnectionStateListener<SshClientContext>> getStateListeners()

getForwardingManager

public ForwardingManager<SshClientContext> getForwardingManager()

Specified by:

getForwardingManager in class SshContext

setForwardingManager

public void setForwardingManager(ForwardingManager<SshClientContext> forwardingManager)

keysExchanged

public void keysExchanged()

configureKeyExchanges

protected void configureKeyExchanges()

Specified by:

configureKeyExchanges in class SshContext

getSupportedPublicKeys

public String getSupportedPublicKeys()

Specified by:

getSupportedPublicKeys in class SshContext

supportedKeyExchanges

public ComponentFactory<SshKeyExchange<?>> supportedKeyExchanges()

Description copied from class: SshContext

Get the supported key exchange methods.

There are no optional key exchange algorithms currently available and this method is supplied in preperation for future enhancements.

Overrides:

supportedKeyExchanges in class SshContext

Returns:

the component factory

getPreferredPublicKey

public String getPreferredPublicKey()

Specified by:

getPreferredPublicKey in class SshContext

getConnectionManager

public ConnectionManager<SshClientContext> getConnectionManager()

Specified by:

getConnectionManager in class SshContext

setConnectionManager

public void setConnectionManager(ConnectionManager<SshClientContext> connectionManager)

addAuthenticator

public void addAuthenticator(ClientAuthenticator auth)

getAuthenticators

public List<ClientAuthenticator> getAuthenticators()

getBannerDisplay

public BannerDisplay getBannerDisplay()

setBannerDisplay

public void setBannerDisplay(BannerDisplay bannerDisplay)

setTerminalType

public void setTerminalType(String term)

getTerminalType

public String getTerminalType()

setTerminalColumns

public void setTerminalColumns(int cols)

getTerminalColumns

public int getTerminalColumns()

setTerminalRows

public void setTerminalRows(int rows)

getTerminalRows

public int getTerminalRows()

setTerminalHeight

public void setTerminalHeight(int height)

getTerminalHeight

public int getTerminalHeight()

setTerminalWidth

public void setTerminalWidth(int width)

getTerminalWidth

public int getTerminalWidth()

setAllocatePseudoTerminal

public void setAllocatePseudoTerminal(boolean allocatePseudoTerminal)

isAllocatePseudoTerminal

public boolean isAllocatePseudoTerminal()

setTerminalModes

public void setTerminalModes(byte[] modes)

getTerminalModes

public byte[] getTerminalModes()

getSubsystemCacheSize

public int getSubsystemCacheSize()

setSubsystemCacheSize

public void setSubsystemCacheSize(int subsystemCacheSize)

getChannelFactory

public ChannelFactory<SshClientContext> getChannelFactory()

Specified by:

getChannelFactory in class SshContext

getDaemonContext

public SshEngineContext getDaemonContext()

Overrides:

getDaemonContext in class SshContext

addGlobalRequestHandler

public void addGlobalRequestHandler(GlobalRequestHandler<SshClientContext> handler)

getGlobalRequestHandler

public GlobalRequestHandler<SshClientContext> getGlobalRequestHandler(String name)

Specified by:

getGlobalRequestHandler in class SshContext

getSocketConnectionFactory

public SocketConnectionFactory getSocketConnectionFactory()

Overrides:

getSocketConnectionFactory in class SshContext

getSessionMaxPacketSize

public int getSessionMaxPacketSize()

getSessionMaxWindowSize

public int getSessionMaxWindowSize()