SshContext (Maverick Next Generation API - Packaging 2.0.0-BETA-8 API)

java.lang.Object
- com.sshtools.nio.ProtocolContext
- - com.sshtools.ssh.SshContext

All Implemented Interfaces:

ExecutorServiceProvider

Direct Known Subclasses:

SshClientContext, SshServerContext
```
public abstract class SshContext
extends ProtocolContext
implements ExecutorServiceProvider
```
This class defines an SSH context for listening interfaces on the SshEngine.

Author:

Lee David Painter

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteBufferPool`	`byteBufferPool`
`static String`	`CIPHER_AES128_CBC`
`static String`	`CIPHER_AES128_CTR`
`static String`	`CIPHER_AES192_CBC`
`static String`	`CIPHER_AES192_CTR`
`static String`	`CIPHER_AES256_CBC`
`static String`	`CIPHER_AES256_CTR`
`static String`	`CIPHER_ARCFOUR`
`static String`	`CIPHER_ARCFOUR_128`
`static String`	`CIPHER_ARCFOUR_256`
`static String`	`CIPHER_BLOWFISH_CBC`
`static String`	`CIPHER_TRIPLEDES_CBC`
`static String`	`CIPHER_TRIPLEDES_CTR`
`protected ComponentFactory<SshCipher>`	`ciphersCS`
`protected ComponentFactory<SshCipher>`	`ciphersSC`
`static String`	`COMPRESSION_NONE` Compression off
`static String`	`COMPRESSION_ZLIB` ZLIB compression
`protected int`	`compressionLevel`
`protected ComponentFactory<SshCompression>`	`compressionsCS`
`protected ComponentFactory<SshCompression>`	`compressionsSC`
`protected SshEngine`	`daemon`
`protected ExecutorService`	`executor`
`protected int`	`forwardingBufferMaxQueueCount`
`protected ForwardingCallback`	`forwardingCallback`
`protected ForwardingPolicy`	`forwardingPolicy`
`static String`	`HMAC_MD5` MD5 message authentication
`static String`	`HMAC_MD5_96` MD5 96 bit message authentication
`static String`	`HMAC_MD5_ETM`
`static String`	`HMAC_RIPEMD160`
`static String`	`HMAC_RIPEMD160_ETM`
`static String`	`HMAC_SHA1` SHA1 message authentication
`static String`	`HMAC_SHA1_96` SHA1 96 bit message authentication
`static String`	`HMAC_SHA1_ETM`
`static String`	`HMAC_SHA256`
`static String`	`HMAC_SHA256_96`
`static String`	`HMAC_SHA256_ETM`
`static String`	`HMAC_SHA512`
`static String`	`HMAC_SHA512_96`
`static String`	`HMAC_SHA512_ETM`
`protected int`	`idleAuthenticationTimeoutSeconds`
`protected int`	`idleConnectionTimeout`
`protected int`	`keepAliveDataMaxLength`
`protected int`	`keepAliveInterval`
`static String`	`KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1` Constant for the algorithm name "diffie-hellman-group-exchange-sha1".
`static String`	`KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256`
`static String`	`KEX_DIFFIE_HELLMAN_GROUP1_SHA1` Constant for the algorithm name "diffie-hellman-group1-sha1".
`static String`	`KEX_DIFFIE_HELLMAN_GROUP14_SHA1` Constant for the algorithm name "diffie-hellman-group14-sha1".
`static String`	`KEYBOARD_INTERACTIVE_AUTHENTICATION`
`protected ComponentFactory<SshKeyExchange<? extends SshContext>>`	`keyExchanges`
`protected boolean`	`killTunnelsOnRemoteForwardingCancel`
`protected Locale`	`locale`
`protected ComponentFactory<SshHmac>`	`macCS`
`protected ComponentFactory<SshHmac>`	`macSC`
`protected int`	`MAX_NUM_BYTES_BEFORE_REKEY`
`protected int`	`MAX_NUM_PACKETS_BEFORE_REKEY`
`protected int`	`maxAuthentications`
`protected int`	`maxChannels`
`protected int`	`maximumPacketLength`
`protected int`	`maximumSocketsBacklogPerRemotelyForwardedConnection`
`protected int`	`minDHGroupExchangeKeySize`
`static String`	`PASSWORD_AUTHENTICATION` Identifier for password authentication
`protected String`	`prefCipherCS`
`protected String`	`prefCipherSC`
`protected String`	`prefCompressionCS`
`protected String`	`prefCompressionSC`
`protected String`	`prefKeyExchange`
`protected String`	`prefMacCS`
`protected String`	`prefMacSC`
`protected String`	`prefPublicKey`
`static String`	`PUBLIC_KEY_ECDSA_SHA2_NISPTP_256` ECDSA 256 bit Public Key
`static String`	`PUBLIC_KEY_ECDSA_SHA2_NISPTP_384` ECDSA 384 bit Public Key
`static String`	`PUBLIC_KEY_ECDSA_SHA2_NISPTP_521` ECDSA 521 bit Public Key
`static String`	`PUBLIC_KEY_SSHDSS` SSH2 DSA Public Key
`static String`	`PUBLIC_KEY_SSHRSA` SSH2 RSA Public Key
`static String`	`PUBLICKEY_AUTHENTICATION` Identifier for public key authentication
`protected ComponentFactory<SshPublicKey>`	`publicKeys`
`protected SocketConnectionFactory`	`socketConnectionFactory`
`protected String`	`softwareVersionComments`

Fields inherited from class com.sshtools.nio.ProtocolContext
keepAlive, receiveBufferSize, reuseAddress, sendBufferSize, tcpNoDelay

Constructor Summary

Constructors
Constructor and Description
`SshContext(ComponentManager componentManager)` Constructs a default context but does not set the daemon
`SshContext(SshEngine daemon, ComponentManager componentManager)` Constructs a default context

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`configureKeyExchanges()`
`abstract ProtocolEngine`	`createEngine()` Create a protocol engine.
`void`	`enableFIPSMode()`
`ByteBufferPool`	`getByteBufferPool()`
`abstract ChannelFactory<? extends SshContext>`	`getChannelFactory()`
`int`	`getChannelLimit()` Get the maximum number of open channels allowed by each client.
`String`	`getCiphersCS()`
`String`	`getCiphersSC()` Get the ciphers for the Server->Client stream.
`ComponentManager`	`getComponentManager()`
`int`	`getCompressionLevel()` Get the current compression level
`abstract ConnectionManager<? extends SshContext>`	`getConnectionManager()`
`SshEngineContext`	`getDaemonContext()`
`SshEngine`	`getEngine()` Get the instance of the SSHD for this context.
`ExecutorService`	`getExecutorService()`
`int`	`getForwardingBufferMaxQueueCount()`
`ForwardingCallback`	`getForwardingCallback()` Get the forwarding callback implementation for this server context.
`abstract ForwardingManager<? extends SshContext>`	`getForwardingManager()`
`ForwardingPolicy`	`getForwardingPolicy()`
`abstract GlobalRequestHandler<? extends SshContext>`	`getGlobalRequestHandler(String requestname)`
`int`	`getIdleAuthenticationTimeoutSeconds()`
`int`	`getIdleConnectionTimeoutSeconds()` Should the connection be disconnected on session timeout?
`int`	`getKeepAliveDataMaxLength()` Get the maximum data length for the keep-alive packet.
`int`	`getKeepAliveInterval()` Get the current keep-alive interval (in seconds).
`int`	`getKeyExchangePacketLimit()` Get the number of packets to send before a key exchange is forced
`String`	`getKeyExchanges()` Get the ciphers for the Server->Client stream.
`int`	`getKeyExchangeTransferLimit()` Get the number of bytes to transfer before a key exchange is forced.
`Locale`	`getLocale()`
`String`	`getMacsCS()` Get the ciphers for the Client->Server stream.
`String`	`getMacsSC()` Get the ciphers for the Server->Client stream.
`int`	`getMaxAuthentications()` Get the maximum number of failed authentications allowed for each connection.
`int`	`getMaximumPacketLength()` Get the maximum supported length of an SSH packet.
`int`	`getMaximumSocketsBacklogPerRemotelyForwardedConnection()`
`int`	`getMinDHGroupExchangeKeySize()`
`String`	`getPreferredCipherCS()` Get the currently preferred cipher for the Client->Server stream.
`String`	`getPreferredCipherSC()` Get the currently preferred cipher for the Server->Client stream.
`String`	`getPreferredCompressionCS()` Get the currently preferred compression for the Client->Server stream.
`String`	`getPreferredCompressionSC()` Get the currently preferred compression for the Server->Client stream.
`String`	`getPreferredKeyExchange()` Get the currently preferred key exchange method.
`String`	`getPreferredMacCS()` Get the currently preferred mac for the Client->Server stream.
`String`	`getPreferredMacSC()` Get the currently supported mac for the Server-Client stream.
`abstract String`	`getPreferredPublicKey()`
`String`	`getPublicKeys()` Get the ciphers for the Server->Client stream.
`boolean`	`getRemoteForwardingCancelKillsTunnels()` Determines whether the cancellation of a remote forwarding drops currently active tunnels
`SocketConnectionFactory`	`getSocketConnectionFactory()`
`String`	`getSoftwareVersionComments()` Get the software/version/comments field that is to be used in the SSH protocols negotiation procedure.
`abstract String`	`getSupportedPublicKeys()`
`void`	`init(SshEngine daemon)` Initialise the SshContext by setting the daemon
`protected String`	`listPublicKeys(String... keys)`
`void`	`setChannelLimit(int maxChannels)` Set the maximum number of open channels allowed by each client (defaults to 100).
`void`	`setCipherPreferredPositionCS(String name, int position)`
`void`	`setCipherPreferredPositionSC(String name, int position)`
`void`	`setCompressionLevel(int compressionLevel)` Set the compression level to use if compression is enabled
`void`	`setExecutorService(ExecutorService executor)`
`void`	`setForwardingBufferMaxQueueCount(int forwardingBufferMaxQueueCount)`
`void`	`setForwardingCallback(ForwardingCallback forwardingCallback)` Set the forwarding callback implementation for this server context.
`void`	`setForwardingPolicy(ForwardingPolicy forwardingPolicy)`
`void`	`setIdleAuthenticationTimeoutSeconds(int idleAuthenticationTimeoutSeconds)`
`void`	`setIdleConnectionTimeoutSeconds(int idleConnectionTimeout)` Inform the context that the connection should be disconnected on session timeout
`void`	`setKeepAliveDataMaxLength(int keepAliveDataMaxLength)` Set the maximum data length for the keep-alive packet.
`void`	`setKeepAliveInterval(int keepAliveInterval)` Set the keep-alive interval (in seconds).
`void`	`setKeyExchangePacketLimit(int MAX_NUM_PACKETS_BEFORE_REKEY)` This tells the server how many packets to use before a key exchange.
`void`	`setKeyExchangePreferredPosition(String name, int position)`
`void`	`setKeyExchangeTransferLimit(int MAX_NUM_BYTES_BEFORE_REKEY)` This limit tells the server when to force a key exchange.
`void`	`setLocale(Locale locale)`
`void`	`setMacPreferredPositionCS(String name, int position)`
`void`	`setMacPreferredPositionSC(String name, int position)`
`void`	`setMaxAuthentications(int maxAuthentications)` Set the maximum number of failed authentications allowed for each connection.
`void`	`setMaximumPacketLength(int maximumPacketLength)` Set the maximum supported length of an SSH packet.
`void`	`setMaximumSocketsBacklogPerRemotelyForwardedConnection(int maximumSocketsBacklogPerRemotelyForwardedConnection)`
`void`	`setMinDHGroupExchangeKeySize(int minDHGroupExchangeKeySize)`
`void`	`setPreferredCipherCC(String[] order)` Set the preferred CS cipher order
`void`	`setPreferredCipherCS(int[] order)` Set the preferred SC cipher order
`void`	`setPreferredCipherCS(String name)` Set the preferred cipher for the Client->Server stream.
`void`	`setPreferredCipherSC(int[] order)` Set the preferred SC cipher order
`void`	`setPreferredCipherSC(String name)` Set the preferred cipher for the Server->Client stream.
`void`	`setPreferredCipherSC(String[] order)` Set the preferred SC cipher order
`void`	`setPreferredCompressionCS(String name)` Set the preferred compression for the Client->Server stream.
`void`	`setPreferredCompressionSC(String name)` Set the preferred compression for the Server->Client stream.
`void`	`setPreferredKeyExchange(String name)` Set the preferred key exchange method.
`void`	`setPreferredKeyExchange(String[] order)`
`void`	`setPreferredMacCS(int[] order)` Set the preferred CS Mac order
`void`	`setPreferredMacCS(String name)` Set the preferred MAC for the Client->Server stream.
`void`	`setPreferredMacCS(String[] order)`
`void`	`setPreferredMacSC(int[] order)` Set the preferred SC Mac order
`void`	`setPreferredMacSC(String name)` Set the preferred mac for the Server->Client stream.
`void`	`setPreferredMacSC(String[] order)`
`void`	`setPublicKeyPreferredPosition(String name, int position)`
`void`	`setRemoteForwardingCancelKillsTunnels(boolean killTunnelsOnRemoteForwardingCancel)` When the user cancels a remote forwarding should active tunnels be dropped?
`void`	`setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)`
`void`	`setSoftwareVersionComments(String softwareVersionComments)` Set the current implementations software/version/comments field that is used during the SSH protocols negotiation procedure.
`void`	`shutdown()`
`ComponentFactory<SshCipher>`	`supportedCiphersCS()` Returns a factory implementation that enables configuration of the available ciphers.
`ComponentFactory<SshCipher>`	`supportedCiphersSC()`
`ComponentFactory<SshCompression>`	`supportedCompressionsCS()` Get the supported compression algorithms.
`ComponentFactory<SshCompression>`	`supportedCompressionsSC()`
`ComponentFactory<SshKeyExchange<? extends SshContext>>`	`supportedKeyExchanges()` Get the supported key exchange methods.
`ComponentFactory<SshHmac>`	`supportedMacsCS()` Get the supported message authentication algorithms.
`ComponentFactory<SshHmac>`	`supportedMacsSC()`
`ComponentFactory<SshPublicKey>`	`supportedPublicKeys()`

Methods inherited from class com.sshtools.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

- Field Detail
  - CIPHER_TRIPLEDES_CBC
```
public static final String CIPHER_TRIPLEDES_CBC
```
    See Also:
    
    Constant Field Values
  - CIPHER_TRIPLEDES_CTR
```
public static final String CIPHER_TRIPLEDES_CTR
```
    See Also:
    
    Constant Field Values
  - CIPHER_BLOWFISH_CBC
```
public static final String CIPHER_BLOWFISH_CBC
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES128_CBC
```
public static final String CIPHER_AES128_CBC
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES192_CBC
```
public static final String CIPHER_AES192_CBC
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES256_CBC
```
public static final String CIPHER_AES256_CBC
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES128_CTR
```
public static final String CIPHER_AES128_CTR
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES192_CTR
```
public static final String CIPHER_AES192_CTR
```
    See Also:
    
    Constant Field Values
  - CIPHER_AES256_CTR
```
public static final String CIPHER_AES256_CTR
```
    See Also:
    
    Constant Field Values
  - CIPHER_ARCFOUR
```
public static final String CIPHER_ARCFOUR
```
    See Also:
    
    Constant Field Values
  - CIPHER_ARCFOUR_128
```
public static final String CIPHER_ARCFOUR_128
```
    See Also:
    
    Constant Field Values
  - CIPHER_ARCFOUR_256
```
public static final String CIPHER_ARCFOUR_256
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA1
```
public static final String HMAC_SHA1
```
    SHA1 message authentication
    
    See Also:
    
    Constant Field Values
  - HMAC_SHA1_ETM
```
public static final String HMAC_SHA1_ETM
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA1_96
```
public static final String HMAC_SHA1_96
```
    SHA1 96 bit message authentication
    
    See Also:
    
    Constant Field Values
  - HMAC_MD5
```
public static final String HMAC_MD5
```
    MD5 message authentication
    
    See Also:
    
    Constant Field Values
  - HMAC_MD5_ETM
```
public static final String HMAC_MD5_ETM
```
    See Also:
    
    Constant Field Values
  - HMAC_MD5_96
```
public static final String HMAC_MD5_96
```
    MD5 96 bit message authentication
    
    See Also:
    
    Constant Field Values
  - HMAC_SHA256
```
public static final String HMAC_SHA256
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA256_ETM
```
public static final String HMAC_SHA256_ETM
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA256_96
```
public static final String HMAC_SHA256_96
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA512
```
public static final String HMAC_SHA512
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA512_ETM
```
public static final String HMAC_SHA512_ETM
```
    See Also:
    
    Constant Field Values
  - HMAC_SHA512_96
```
public static final String HMAC_SHA512_96
```
    See Also:
    
    Constant Field Values
  - HMAC_RIPEMD160
```
public static final String HMAC_RIPEMD160
```
    See Also:
    
    Constant Field Values
  - HMAC_RIPEMD160_ETM
```
public static final String HMAC_RIPEMD160_ETM
```
    See Also:
    
    Constant Field Values
  - COMPRESSION_NONE
```
public static final String COMPRESSION_NONE
```
    Compression off
    
    See Also:
    
    Constant Field Values
  - COMPRESSION_ZLIB
```
public static final String COMPRESSION_ZLIB
```
    ZLIB compression
    
    See Also:
    
    Constant Field Values
  - KEX_DIFFIE_HELLMAN_GROUP1_SHA1
```
public static final String KEX_DIFFIE_HELLMAN_GROUP1_SHA1
```
    Constant for the algorithm name "diffie-hellman-group1-sha1".
    
    See Also:
    
    Constant Field Values
  - KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1
```
public static final String KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1
```
    Constant for the algorithm name "diffie-hellman-group-exchange-sha1".
    
    See Also:
    
    Constant Field Values
  - KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256
```
public static final String KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256
```
    See Also:
    
    Constant Field Values
  - KEX_DIFFIE_HELLMAN_GROUP14_SHA1
```
public static final String KEX_DIFFIE_HELLMAN_GROUP14_SHA1
```
    Constant for the algorithm name "diffie-hellman-group14-sha1".
    
    See Also:
    
    Constant Field Values
  - PUBLIC_KEY_SSHDSS
```
public static final String PUBLIC_KEY_SSHDSS
```
    SSH2 DSA Public Key
    
    See Also:
    
    Constant Field Values
  - PUBLIC_KEY_SSHRSA
```
public static final String PUBLIC_KEY_SSHRSA
```
    SSH2 RSA Public Key
    
    See Also:
    
    Constant Field Values
  - PUBLIC_KEY_ECDSA_SHA2_NISPTP_256
```
public static final String PUBLIC_KEY_ECDSA_SHA2_NISPTP_256
```
    ECDSA 256 bit Public Key
    
    See Also:
    
    Constant Field Values
  - PUBLIC_KEY_ECDSA_SHA2_NISPTP_384
```
public static final String PUBLIC_KEY_ECDSA_SHA2_NISPTP_384
```
    ECDSA 384 bit Public Key
    
    See Also:
    
    Constant Field Values
  - PUBLIC_KEY_ECDSA_SHA2_NISPTP_521
```
public static final String PUBLIC_KEY_ECDSA_SHA2_NISPTP_521
```
    ECDSA 521 bit Public Key
    
    See Also:
    
    Constant Field Values
  - PASSWORD_AUTHENTICATION
```
public static final String PASSWORD_AUTHENTICATION
```
    Identifier for password authentication
    
    See Also:
    
    Constant Field Values
  - PUBLICKEY_AUTHENTICATION
```
public static final String PUBLICKEY_AUTHENTICATION
```
    Identifier for public key authentication
    
    See Also:
    
    Constant Field Values
  - KEYBOARD_INTERACTIVE_AUTHENTICATION
```
public static final String KEYBOARD_INTERACTIVE_AUTHENTICATION
```
    See Also:
    
    Constant Field Values
  - maximumSocketsBacklogPerRemotelyForwardedConnection
```
protected int maximumSocketsBacklogPerRemotelyForwardedConnection
```
  - socketConnectionFactory
```
protected SocketConnectionFactory socketConnectionFactory
```
  - compressionsCS
```
protected ComponentFactory<SshCompression> compressionsCS
```
  - compressionsSC
```
protected ComponentFactory<SshCompression> compressionsSC
```
  - ciphersCS
```
protected ComponentFactory<SshCipher> ciphersCS
```
  - ciphersSC
```
protected ComponentFactory<SshCipher> ciphersSC
```
  - keyExchanges
```
protected ComponentFactory<SshKeyExchange<? extends SshContext>> keyExchanges
```
  - macCS
```
protected ComponentFactory<SshHmac> macCS
```
  - macSC
```
protected ComponentFactory<SshHmac> macSC
```
  - publicKeys
```
protected ComponentFactory<SshPublicKey> publicKeys
```
  - prefCipherCS
```
protected String prefCipherCS
```
  - prefCipherSC
```
protected String prefCipherSC
```
  - prefMacCS
```
protected String prefMacCS
```
  - prefMacSC
```
protected String prefMacSC
```
  - prefCompressionCS
```
protected String prefCompressionCS
```
  - prefCompressionSC
```
protected String prefCompressionSC
```
  - prefKeyExchange
```
protected String prefKeyExchange
```
  - prefPublicKey
```
protected String prefPublicKey
```
  - maxChannels
```
protected int maxChannels
```
  - maxAuthentications
```
protected int maxAuthentications
```
  - compressionLevel
```
protected int compressionLevel
```
  - maximumPacketLength
```
protected int maximumPacketLength
```
  - MAX_NUM_PACKETS_BEFORE_REKEY
```
protected int MAX_NUM_PACKETS_BEFORE_REKEY
```
  - MAX_NUM_BYTES_BEFORE_REKEY
```
protected int MAX_NUM_BYTES_BEFORE_REKEY
```
  - daemon
```
protected SshEngine daemon
```
  - softwareVersionComments
```
protected String softwareVersionComments
```
  - killTunnelsOnRemoteForwardingCancel
```
protected boolean killTunnelsOnRemoteForwardingCancel
```
  - idleConnectionTimeout
```
protected int idleConnectionTimeout
```
  - idleAuthenticationTimeoutSeconds
```
protected int idleAuthenticationTimeoutSeconds
```
  - keepAliveInterval
```
protected int keepAliveInterval
```
  - keepAliveDataMaxLength
```
protected int keepAliveDataMaxLength
```
  - forwardingCallback
```
protected ForwardingCallback forwardingCallback
```
  - executor
```
protected ExecutorService executor
```
  - forwardingBufferMaxQueueCount
```
protected int forwardingBufferMaxQueueCount
```
  - locale
```
protected Locale locale
```
  - byteBufferPool
```
protected ByteBufferPool byteBufferPool
```
  - forwardingPolicy
```
protected ForwardingPolicy forwardingPolicy
```
  - minDHGroupExchangeKeySize
```
protected int minDHGroupExchangeKeySize
```
- Constructor Detail
  - SshContext
```
public SshContext(ComponentManager componentManager)
           throws IOException
```
    Constructs a default context but does not set the daemon
    
    Parameters:
    
    componentManager -
    
    Throws:
    
    IOException
  - SshContext
```
public SshContext(SshEngine daemon,
                  ComponentManager componentManager)
           throws IOException
```
    Constructs a default context
    
    Parameters:
    
    componentManager -
    
    Throws:
    
    IOException
- Method Detail
  - init
```
public void init(SshEngine daemon)
```
    Initialise the SshContext by setting the daemon
  - getConnectionManager
```
public abstract ConnectionManager<? extends SshContext> getConnectionManager()
```
  - createEngine
```
public abstract ProtocolEngine createEngine()
                                     throws IOException
```
    Description copied from class: ProtocolContext
    
    Create a protocol engine.
    
    Specified by:
    
    createEngine in class ProtocolContext
    
    Returns:
    
    ProtocolEngine
    
    Throws:
    
    IOException
  - getSupportedPublicKeys
```
public abstract String getSupportedPublicKeys()
```
  - configureKeyExchanges
```
protected abstract void configureKeyExchanges()
```
  - getPreferredPublicKey
```
public abstract String getPreferredPublicKey()
```
  - getChannelFactory
```
public abstract ChannelFactory<? extends SshContext> getChannelFactory()
```
  - getComponentManager
```
public ComponentManager getComponentManager()
```
  - setSocketConnectionFactory
```
public void setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)
```
    Overrides:
    
    setSocketConnectionFactory in class ProtocolContext
  - getSocketConnectionFactory
```
public SocketConnectionFactory getSocketConnectionFactory()
```
    Overrides:
    
    getSocketConnectionFactory in class ProtocolContext
  - getGlobalRequestHandler
```
public abstract GlobalRequestHandler<? extends SshContext> getGlobalRequestHandler(String requestname)
```
  - getEngine
```
public SshEngine getEngine()
```
    Get the instance of the SSHD for this context.
    
    Returns:
    
    Daemon
  - setChannelLimit
```
public void setChannelLimit(int maxChannels)
```
    Set the maximum number of open channels allowed by each client (defaults to 100).
    
    Parameters:
    
    maxChannels -
  - getChannelLimit
```
public int getChannelLimit()
```
    Get the maximum number of open channels allowed by each client.
    
    Returns:
    
    int
  - getMaxAuthentications
```
public int getMaxAuthentications()
```
    Get the maximum number of failed authentications allowed for each connection.
    
    Returns:
    
    int
  - setMaxAuthentications
```
public void setMaxAuthentications(int maxAuthentications)
```
    Set the maximum number of failed authentications allowed for each connection.
    
    Parameters:
    
    maxAuthentications -
  - supportedCiphersCS
```
public ComponentFactory<SshCipher> supportedCiphersCS()
```
    Returns a factory implementation that enables configuration of the available ciphers.
    
    The standard default ciphers installed are 3DES and Blowfish, however the J2SSH Maverick API on which this server is based also supports a number of optional ciphers AES, CAST and Twofish. These can be installed by adding the sshtools-cipher.jar to your class path and using the following code within your SSHD SshDaemon#configure(ConfigurationContext) method.
    // import the cipher package import com.sshtools.cipher.*; // Add AES context.supportedCiphers().add(AES128Cbc.AES128_CBC, AES128Cbc.class); context.supportedCiphers().add(AES192Cbc.AES192_CBC, AES192Cbc.class); context.supportedCiphers().add(AES256Cbc.AES256_CBC, AES256Cbc.class); // Add Twofish - note the 256 bit cipher has two different entries to maintain backwards compatibility context.supportedCiphers().add(Twofish128Cbc.TWOFISH128_CBC, Twofish128Cbc.class); context.supportedCiphers().add(Twofish192Cbc.TWOFISH192_CBC, Twofish192Cbc.class); context.supportedCiphers().add(Twofish256Cbc.TWOFISH256_CBC, Twofish256Cbc.class); context.supportedCiphers().add(Twofish256Cbc.TWOFISH_CBC, Twofish256Cbc.class); // Add CAST context.supportedCiphers().add(CAST128Cbc.CAST128_CBC, CAST128Cbc.class);
    Returns:
    
    the component factory
  - supportedCiphersSC
```
public ComponentFactory<SshCipher> supportedCiphersSC()
```
  - getPreferredCipherCS
```
public String getPreferredCipherCS()
```
    Get the currently preferred cipher for the Client->Server stream.
    
    Returns:
    
    the preferred Client-Server cipher
  - setPreferredCipherCS
```
public void setPreferredCipherCS(String name)
                          throws IOException,
                                 SshException
```
    Set the preferred cipher for the Client->Server stream.
    
    Use the static fields available within this class (or the com.sshtools.cipher classes) to identify the correct cipher.
    context.setPreferredCipherCS(ConfigurationContext.CIPHER_BLOWFISH_CBC);
    
    The default cipher is 3DES
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException - if the cipher is not supported
    
    SshException
  - getPreferredCipherSC
```
public String getPreferredCipherSC()
```
    Get the currently preferred cipher for the Server->Client stream.
    
    Returns:
    
    the preferred Server-Client cipher
  - getSoftwareVersionComments
```
public String getSoftwareVersionComments()
```
    Get the software/version/comments field that is to be used in the SSH protocols negotiation procedure.
    
    Returns:
    
    String
  - setSoftwareVersionComments
```
public void setSoftwareVersionComments(String softwareVersionComments)
```
    Set the current implementations software/version/comments field that is used during the SSH protocols negotiation procedure. This value MUST consist of printable US-ASCII characters with the exception of whitespace and the minus sign (-) and be no longer than 200 characters.
    
    Parameters:
    
    softwareVersionComments -
  - setPreferredCipherSC
```
public void setPreferredCipherSC(String name)
                          throws IOException,
                                 SshException
```
    Set the preferred cipher for the Server->Client stream.
    
    Use the static fields available within this class (or the com.sshtools.cipher classes) to identify the correct cipher.
    context.setPreferredCipherSC(ConfigurationContext.CIPHER_BLOWFISH_CBC);
    
    The default cipher is 3DES
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
    
    SshException
  - supportedMacsCS
```
public ComponentFactory<SshHmac> supportedMacsCS()
```
    Get the supported message authentication algorithms.
    
    There are no optional MAC algorithms currently available and this method is supplied in preperation for future enhancements.
    
    Returns:
    
    the component factory
  - supportedMacsSC
```
public ComponentFactory<SshHmac> supportedMacsSC()
```
  - getPreferredMacCS
```
public String getPreferredMacCS()
```
    Get the currently preferred mac for the Client->Server stream.
    
    Returns:
    
    the preferred Client-Server mac
  - setPreferredMacCS
```
public void setPreferredMacCS(String name)
                       throws IOException,
                              SshException
```
    Set the preferred MAC for the Client->Server stream.
    
    Use the static fields available within this class to identify the correct MAC.
    context.setPreferredMacCS(ConfigurationContext.HMAC_MD5);
    
    The default MAC is HMAC_SHA1
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
    
    SshException
  - getPreferredMacSC
```
public String getPreferredMacSC()
```
    Get the currently supported mac for the Server-Client stream.
    
    Returns:
    
    the preferred Server-Client mac
  - setRemoteForwardingCancelKillsTunnels
```
public void setRemoteForwardingCancelKillsTunnels(boolean killTunnelsOnRemoteForwardingCancel)
```
    When the user cancels a remote forwarding should active tunnels be dropped?
    
    Parameters:
    
    killTunnelsOnRemoteForwardingCancel - boolean
  - getRemoteForwardingCancelKillsTunnels
```
public boolean getRemoteForwardingCancelKillsTunnels()
```
    Determines whether the cancellation of a remote forwarding drops currently active tunnels
    
    Returns:
    
    boolean
  - setPreferredMacSC
```
public void setPreferredMacSC(String name)
                       throws IOException,
                              SshException
```
    Set the preferred mac for the Server->Client stream.
    
    Use the static fields available within this class to identify the correct MAC.
    context.setPreferredMacCS(ConfigurationContext.HMAC_MD5);
    
    The default MAC is HMAC_SHA1
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
    
    SshException
  - supportedCompressionsCS
```
public ComponentFactory<SshCompression> supportedCompressionsCS()
```
    Get the supported compression algorithms.
    
    There are no optional compression algorithms currently available and this method is supplied in preperation for future enhancements.
    
    Returns:
    
    the component factory
  - supportedCompressionsSC
```
public ComponentFactory<SshCompression> supportedCompressionsSC()
```
  - getPreferredCompressionCS
```
public String getPreferredCompressionCS()
```
    Get the currently preferred compression for the Client->Server stream.
    
    Returns:
    
    the preferred Client-Server compression
  - setPreferredCompressionCS
```
public void setPreferredCompressionCS(String name)
                               throws IOException
```
    Set the preferred compression for the Client->Server stream.
    
    It is recommended that you do not set the preferred compression so that the client has control over the compression selection.
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
  - getPreferredCompressionSC
```
public String getPreferredCompressionSC()
```
    Get the currently preferred compression for the Server->Client stream.
    
    Returns:
    
    the preferred Server->Client compression
  - setPreferredCompressionSC
```
public void setPreferredCompressionSC(String name)
                               throws IOException
```
    Set the preferred compression for the Server->Client stream.
    
    It is recommended that you do not set the preferred compression so that the client has control over the compression selection.
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
  - supportedKeyExchanges
```
public ComponentFactory<SshKeyExchange<? extends SshContext>> supportedKeyExchanges()
```
    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.
    
    Returns:
    
    the component factory
  - getPreferredKeyExchange
```
public String getPreferredKeyExchange()
```
    Get the currently preferred key exchange method.
    
    Returns:
    
    the preferred key exhcange
  - setPreferredKeyExchange
```
public void setPreferredKeyExchange(String name)
                             throws IOException,
                                    SshException
```
    Set the preferred key exchange method.
    
    There is only one supported key exchange algorithm and as such this method is supplied in preperation for future enhancements.
    
    Parameters:
    
    name -
    
    Throws:
    
    IOException
    
    SshException
  - setCompressionLevel
```
public void setCompressionLevel(int compressionLevel)
```
    Set the compression level to use if compression is enabled
    
    Parameters:
    
    compressionLevel - int
  - getCompressionLevel
```
public int getCompressionLevel()
```
    Get the current compression level
    
    Returns:
    
    int
  - getMaximumSocketsBacklogPerRemotelyForwardedConnection
```
public int getMaximumSocketsBacklogPerRemotelyForwardedConnection()
```
  - setMaximumSocketsBacklogPerRemotelyForwardedConnection
```
public void setMaximumSocketsBacklogPerRemotelyForwardedConnection(int maximumSocketsBacklogPerRemotelyForwardedConnection)
```
  - getCiphersSC
```
public String getCiphersSC()
```
    Get the ciphers for the Server->Client stream.
    
    Returns:
    
    the Server-Client ciphers in order of preference
  - getCiphersCS
```
public String getCiphersCS()
```
  - getMacsCS
```
public String getMacsCS()
```
    Get the ciphers for the Client->Server stream.
    
    Returns:
    
    the Client-Server ciphers in order of preference
  - getMacsSC
```
public String getMacsSC()
```
    Get the ciphers for the Server->Client stream.
    
    Returns:
    
    the Server-Client ciphers in order of preference
  - getPublicKeys
```
public String getPublicKeys()
```
    Get the ciphers for the Server->Client stream.
    
    Returns:
    
    the Server-Client ciphers in order of preference
  - getKeyExchanges
```
public String getKeyExchanges()
```
    Get the ciphers for the Server->Client stream.
    
    Returns:
    
    the Server-Client ciphers in order of preference
  - setPreferredCipherSC
```
public void setPreferredCipherSC(int[] order)
                          throws SshException
```
    Set the preferred SC cipher order
    
    Parameters:
    
    order - , list of indices to be moved to the top.
    
    Throws:
    
    SshException
  - setPreferredCipherSC
```
public void setPreferredCipherSC(String[] order)
                          throws SshException
```
    Set the preferred SC cipher order
    
    Parameters:
    
    order -
    
    Throws:
    
    SshException
  - setPreferredCipherCS
```
public void setPreferredCipherCS(int[] order)
                          throws SshException
```
    Set the preferred SC cipher order
    
    Parameters:
    
    order - , list of indices to be moved to the top.
    
    Throws:
    
    SshException
  - setPreferredCipherCC
```
public void setPreferredCipherCC(String[] order)
                          throws SshException
```
    Set the preferred CS cipher order
    
    Parameters:
    
    order -
    
    Throws:
    
    SshException
  - setPreferredMacSC
```
public void setPreferredMacSC(int[] order)
                       throws SshException
```
    Set the preferred SC Mac order
    
    Parameters:
    
    order - , list of indices to be moved to the top.
    
    Throws:
    
    SshException
  - setPreferredMacSC
```
public void setPreferredMacSC(String[] order)
                       throws SshException
```
    Parameters:
    
    order -
    
    Throws:
    
    SshException
  - setPreferredKeyExchange
```
public void setPreferredKeyExchange(String[] order)
                             throws SshException
```
    Parameters:
    
    order -
    
    Throws:
    
    SshException
  - setPreferredMacCS
```
public void setPreferredMacCS(int[] order)
                       throws SshException
```
    Set the preferred CS Mac order
    
    Parameters:
    
    order - , list of indices to be moved to the top.
    
    Throws:
    
    SshException
  - setPreferredMacCS
```
public void setPreferredMacCS(String[] order)
                       throws SshException
```
    Throws:
    
    SshException
  - setCipherPreferredPositionCS
```
public void setCipherPreferredPositionCS(String name,
                                         int position)
                                  throws SshException
```
    Throws:
    
    SshException
  - setCipherPreferredPositionSC
```
public void setCipherPreferredPositionSC(String name,
                                         int position)
                                  throws SshException
```
    Throws:
    
    SshException
  - setMacPreferredPositionSC
```
public void setMacPreferredPositionSC(String name,
                                      int position)
                               throws SshException
```
    Throws:
    
    SshException
  - setMacPreferredPositionCS
```
public void setMacPreferredPositionCS(String name,
                                      int position)
                               throws SshException
```
    Throws:
    
    SshException
  - setPublicKeyPreferredPosition
```
public void setPublicKeyPreferredPosition(String name,
                                          int position)
                                   throws SshException
```
    Throws:
    
    SshException
  - setKeyExchangePreferredPosition
```
public void setKeyExchangePreferredPosition(String name,
                                            int position)
                                     throws SshException
```
    Throws:
    
    SshException
  - setForwardingCallback
```
public void setForwardingCallback(ForwardingCallback forwardingCallback)
```
    Set the forwarding callback implementation for this server context.
    
    Parameters:
    
    forwardingCallback - NNForwardingCallback
  - getForwardingCallback
```
public ForwardingCallback getForwardingCallback()
```
    Get the forwarding callback implementation for this server context.
    
    Returns:
    
    ForwardingCallback
  - setMaximumPacketLength
```
public void setMaximumPacketLength(int maximumPacketLength)
```
    Set the maximum supported length of an SSH packet.
    
    Parameters:
    
    maximumPacketLength - int
  - getMaximumPacketLength
```
public int getMaximumPacketLength()
```
    Get the maximum supported length of an SSH packet.
    
    Returns:
    
    int
  - setKeyExchangeTransferLimit
```
public void setKeyExchangeTransferLimit(int MAX_NUM_BYTES_BEFORE_REKEY)
```
    This limit tells the server when to force a key exchange.
    
    Parameters:
    
    MAX_NUM_BYTES_BEFORE_REKEY - int
  - setKeyExchangePacketLimit
```
public void setKeyExchangePacketLimit(int MAX_NUM_PACKETS_BEFORE_REKEY)
```
    This tells the server how many packets to use before a key exchange.
    
    Parameters:
    
    MAX_NUM_PACKETS_BEFORE_REKEY - int
  - getKeyExchangeTransferLimit
```
public int getKeyExchangeTransferLimit()
```
    Get the number of bytes to transfer before a key exchange is forced.
    
    Returns:
    
    int
  - getKeyExchangePacketLimit
```
public int getKeyExchangePacketLimit()
```
    Get the number of packets to send before a key exchange is forced
    
    Returns:
    
    int
  - getIdleConnectionTimeoutSeconds
```
public int getIdleConnectionTimeoutSeconds()
```
    Should the connection be disconnected on session timeout?
    
    Returns:
  - setIdleConnectionTimeoutSeconds
```
public void setIdleConnectionTimeoutSeconds(int idleConnectionTimeout)
```
    Inform the context that the connection should be disconnected on session timeout
    
    Parameters:
    
    idleConnectionTimeout -
  - supportedPublicKeys
```
public ComponentFactory<SshPublicKey> supportedPublicKeys()
```
  - getKeepAliveInterval
```
public int getKeepAliveInterval()
```
    Get the current keep-alive interval (in seconds). The server sends an SSH_MSG_IGNORE every n seconds after no activity on a connection.
    
    Returns:
  - setKeepAliveInterval
```
public void setKeepAliveInterval(int keepAliveInterval)
```
    Set the keep-alive interval (in seconds). The server sends an SSH_MSG_IGNORE message every n seconds after no activity on a connection.
    
    Parameters:
    
    keepAliveInterval -
  - getKeepAliveDataMaxLength
```
public int getKeepAliveDataMaxLength()
```
    Get the maximum data length for the keep-alive packet.
    
    Returns:
  - setKeepAliveDataMaxLength
```
public void setKeepAliveDataMaxLength(int keepAliveDataMaxLength)
```
    Set the maximum data length for the keep-alive packet. Default is 128, the actual number of bytes is random up to this maximum.
    
    Parameters:
    
    keepAliveDataMaxLength -
  - setLocale
```
public void setLocale(Locale locale)
```
  - getLocale
```
public Locale getLocale()
```
  - enableFIPSMode
```
public void enableFIPSMode()
                    throws SshException
```
    Throws:
    
    SshException
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Specified by:
    
    getExecutorService in interface ExecutorServiceProvider
  - setExecutorService
```
public void setExecutorService(ExecutorService executor)
```
    Specified by:
    
    setExecutorService in interface ExecutorServiceProvider
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in class ProtocolContext
  - getByteBufferPool
```
public ByteBufferPool getByteBufferPool()
```
  - getForwardingBufferMaxQueueCount
```
public int getForwardingBufferMaxQueueCount()
```
  - setForwardingBufferMaxQueueCount
```
public void setForwardingBufferMaxQueueCount(int forwardingBufferMaxQueueCount)
```
  - getForwardingPolicy
```
public ForwardingPolicy getForwardingPolicy()
```
  - setForwardingPolicy
```
public void setForwardingPolicy(ForwardingPolicy forwardingPolicy)
```
  - getDaemonContext
```
public SshEngineContext getDaemonContext()
```
  - getIdleAuthenticationTimeoutSeconds
```
public int getIdleAuthenticationTimeoutSeconds()
```
  - setIdleAuthenticationTimeoutSeconds
```
public void setIdleAuthenticationTimeoutSeconds(int idleAuthenticationTimeoutSeconds)
```
  - getMinDHGroupExchangeKeySize
```
public int getMinDHGroupExchangeKeySize()
```
  - setMinDHGroupExchangeKeySize
```
public void setMinDHGroupExchangeKeySize(int minDHGroupExchangeKeySize)
```
  - getForwardingManager
```
public abstract ForwardingManager<? extends SshContext> getForwardingManager()
```
  - listPublicKeys
```
protected String listPublicKeys(String... keys)
```

Class SshContext

Field Summary

Fields inherited from class com.sshtools.nio.ProtocolContext

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.nio.ProtocolContext

Methods inherited from class java.lang.Object

Field Detail

CIPHER_TRIPLEDES_CBC

CIPHER_TRIPLEDES_CTR

CIPHER_BLOWFISH_CBC

CIPHER_AES128_CBC

CIPHER_AES192_CBC

CIPHER_AES256_CBC

CIPHER_AES128_CTR

CIPHER_AES192_CTR

CIPHER_AES256_CTR

CIPHER_ARCFOUR

CIPHER_ARCFOUR_128

CIPHER_ARCFOUR_256

HMAC_SHA1

HMAC_SHA1_ETM

HMAC_SHA1_96

HMAC_MD5

HMAC_MD5_ETM

HMAC_MD5_96

HMAC_SHA256

HMAC_SHA256_ETM

HMAC_SHA256_96

HMAC_SHA512

HMAC_SHA512_ETM

HMAC_SHA512_96

HMAC_RIPEMD160

HMAC_RIPEMD160_ETM

COMPRESSION_NONE

COMPRESSION_ZLIB

KEX_DIFFIE_HELLMAN_GROUP1_SHA1

KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA1

KEX_DIFFIE_HELLMAN_GROUP_EXCHANGE_SHA256

KEX_DIFFIE_HELLMAN_GROUP14_SHA1

PUBLIC_KEY_SSHDSS

PUBLIC_KEY_SSHRSA

PUBLIC_KEY_ECDSA_SHA2_NISPTP_256

PUBLIC_KEY_ECDSA_SHA2_NISPTP_384

PUBLIC_KEY_ECDSA_SHA2_NISPTP_521

PASSWORD_AUTHENTICATION

PUBLICKEY_AUTHENTICATION

KEYBOARD_INTERACTIVE_AUTHENTICATION

maximumSocketsBacklogPerRemotelyForwardedConnection

socketConnectionFactory

compressionsCS

compressionsSC

ciphersCS

ciphersSC

keyExchanges

macCS

macSC

publicKeys

prefCipherCS

prefCipherSC

prefMacCS

prefMacSC

prefCompressionCS

prefCompressionSC

prefKeyExchange

prefPublicKey

maxChannels

maxAuthentications

compressionLevel

maximumPacketLength

MAX_NUM_PACKETS_BEFORE_REKEY

MAX_NUM_BYTES_BEFORE_REKEY

daemon

softwareVersionComments

killTunnelsOnRemoteForwardingCancel

idleConnectionTimeout

idleAuthenticationTimeoutSeconds

keepAliveInterval

keepAliveDataMaxLength

forwardingCallback