net.sf.sshapi

Interface SshProvider

All Known Implementing Classes:

AbstractProvider, GanymedSshProvider, J2SshProvider, JschSshProvider, LibsshSshProvider, MaverickSshProvider, MaverickSshProvider, TrileadSshProvider

public interface SshProvider

Every SSH API implementation must provide one implementation of this interface. It is responsible for providing information about capabilities and creating SshClient instances.

Method Summary

Modifier and Type	Method and Description
SshAgent	connectToLocalAgent(java.lang.String application) Create a connection to the local agent using default or auto-detected settings.
SshAgent	connectToLocalAgent(java.lang.String application, int protocol) Create a connection to the local agent using default or auto-detected settings.
SshAgent	connectToLocalAgent(java.lang.String application, java.lang.String location, int socketType, int protocol) Create a connection to the local agent.
SshClient	createClient(SshConfiguration configuration) Create a new client instance with the specified configuration.
SshHostKeyManager	createHostKeyManager(SshConfiguration configuration) Create a SshHostKeyManager that may be used to list, add and remove valid host keys.
SshIdentityManager	createIdentityManager(SshConfiguration configuration) Create an @SshIdentityManager (if supported)
java.util.List	getCapabilities() Get a list of the capabilities of this implementation (Capability objects)
java.lang.String	getName() Get the name of the library that is used for this provider.
java.util.List	getSupportedCiphers(int protocolVersion) Get a list of supported ciphers.
java.util.List	getSupportedCompression() Get a list of supported compression types.
java.util.List	getSupportedKeyExchange() Get a list of supported key exchange algorithms.
java.util.List	getSupportedMAC() Get a list of supported MAC types.
java.util.List	getSupportedPublicKey() Get a list of supported public key algorithms.
void	seed(long seed) Seed the random number generator.
boolean	supportsConfiguration(SshConfiguration configuration) Examine the configuration to see if this provider supports it.

Method Detail

getName

java.lang.String getName()

Get the name of the library that is used for this provider.

Returns:

provider name

createHostKeyManager

SshHostKeyManager createHostKeyManager(SshConfiguration configuration)
                                throws SshException

Create a SshHostKeyManager that may be used to list, add and remove valid host keys. An implementation is not required to provide this functionality, but vendors do, so this interface provides a common way to access them.

Parameters:

configuration - configuration

Returns:

host key manager

Throws:

SshException

java.lang.UnsupportedOperationException - if not supported

createIdentityManager

SshIdentityManager createIdentityManager(SshConfiguration configuration)

Create an @SshIdentityManager (if supported)

Parameters:

configuration - configuration

Returns:

identity manager

Throws:

java.lang.UnsupportedOperationException - if not supported

getSupportedCiphers

java.util.List getSupportedCiphers(int protocolVersion)

Get a list of supported ciphers. Each element will be a String of the cipher name. If SshConfiguration.SSH1_OR_SSH2 is specified, the list will contain cipher names for both version (in practice, SSH1 only supported one cipher).

If the provider does not support SSH1, it should throw an UnsupportedOperationException if SshConfiguration.SSH1_ONLY is requested. The same applies for SSH2

Parameters:

protocolVersion - version of protocol

Returns:

supported ciphers

Throws:

java.lang.UnsupportedOperationException - if protocol version not supported

getSupportedMAC

java.util.List getSupportedMAC()

Get a list of supported MAC types. Each element will be a String of the MAC type name.

NOTE: Only applicable to SSH2

Returns:

supported MAC types

Throws:

java.lang.UnsupportedOperationException - if SSH2 not supported

getSupportedCompression

java.util.List getSupportedCompression()

Get a list of supported compression types. Each element will be a String of the compression type name.

NOTE: Only applicable to SSH2

Returns:

supported compression type names

Throws:

java.lang.UnsupportedOperationException - if SSH2 not supported

getSupportedKeyExchange

java.util.List getSupportedKeyExchange()

Get a list of supported key exchange algorithms. Each element will be a String of the key exchange name.

NOTE: Only applicable to SSH2

Returns:

supported key exchange names

Throws:

java.lang.UnsupportedOperationException - if SSH2 not supported

getSupportedPublicKey

java.util.List getSupportedPublicKey()

Get a list of supported public key algorithms. Each element will be a String of the public key name.

NOTE: Only applicable to SSH2

Returns:

supported public key names

Throws:

java.lang.UnsupportedOperationException - if SSH2 not supported

getCapabilities

java.util.List getCapabilities()

Get a list of the capabilities of this implementation (Capability objects)

Returns:

list of capabilities

See Also:

Capability

supportsConfiguration

boolean supportsConfiguration(SshConfiguration configuration)

Examine the configuration to see if this provider supports it.

Parameters:

configuration - configuration

Returns:

configuration is supported

createClient

SshClient createClient(SshConfiguration configuration)

Create a new client instance with the specified configuration.

IMPLEMENTATION NOTE: The provider implementation is expected to invoke SshClient.init(SshProvider) after construction.

Parameters:

configuration - configuration

Returns:

client

Throws:

java.lang.UnsupportedOperationException - if the provider configuration is not valid

connectToLocalAgent

SshAgent connectToLocalAgent(java.lang.String application)
                      throws SshException

Create a connection to the local agent using default or auto-detected settings.

Parameters:

application - the application connecting

Returns:

connected agent client

Throws:

java.lang.UnsupportedOperationException - if the provider configuration is not valid

SshException

connectToLocalAgent

SshAgent connectToLocalAgent(java.lang.String application,
                             int protocol)
                      throws SshException

Create a connection to the local agent using default or auto-detected settings.

Parameters:

application - the application connecting

protocol - protocol. One of SshAgent.AUTO_PROTOCOL, SshAgent.OPENSSH_PROTOCOL or SshAgent.RFC_PROTOCOL.

Returns:

connected agent client

Throws:

java.lang.UnsupportedOperationException - if the provider configuration is not valid

SshException

connectToLocalAgent

SshAgent connectToLocalAgent(java.lang.String application,
                             java.lang.String location,
                             int socketType,
                             int protocol)
                      throws SshException

Create a connection to the local agent.

Parameters:

application - the application connecting

location - the location of the agent, in the form "localhost:port"

socketType - the type of socket. One of SshAgent.TCPIP_AGENT_SOCKET_TYPE or SshAgent.UNIX_DOMAIN_AGENT_SOCKET_TYPE.

protocol - protocol. One of SshAgent.AUTO_PROTOCOL, SshAgent.OPENSSH_PROTOCOL or SshAgent.RFC_PROTOCOL.

Returns:

connected agent client

Throws:

java.lang.UnsupportedOperationException - if the provider configuration is not valid

SshException

seed

void seed(long seed)

Seed the random number generator.

Parameters:

seed - seed