net.sf.sshapi

Class AbstractProvider

java.lang.Object

net.sf.sshapi.AbstractProvider

All Implemented Interfaces:

SshProvider

Direct Known Subclasses:

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

public abstract class AbstractProvider
extends java.lang.Object
implements SshProvider

Abstract implementation of an SshProvider, providing some common methods. All providers will probably want to extend this.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProvider(java.lang.String name)

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)
protected abstract SshClient	doCreateClient(SshConfiguration configuration)
protected abstract void	doSupportsConfiguration(SshConfiguration configuration)
java.lang.String	getName() Get the name of the library that is used for this provider.
protected void	setSupportsDefaultConfiguration(boolean supportsDefaultConfiguration)
boolean	supportsConfiguration(SshConfiguration configuration) Examine the configuration to see if this provider supports it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.sshapi.SshProvider

getCapabilities, getSupportedCiphers, getSupportedCompression, getSupportedKeyExchange, getSupportedMAC, getSupportedPublicKey, seed

Constructor Detail

AbstractProvider

protected AbstractProvider(java.lang.String name)

Method Detail

setSupportsDefaultConfiguration

protected void setSupportsDefaultConfiguration(boolean supportsDefaultConfiguration)

getName

public java.lang.String getName()

Description copied from interface: SshProvider

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

Specified by:

getName in interface SshProvider

Returns:

provider name

supportsConfiguration

public final boolean supportsConfiguration(SshConfiguration configuration)

Description copied from interface: SshProvider

Examine the configuration to see if this provider supports it.

Specified by:

supportsConfiguration in interface SshProvider

Parameters:

configuration - configuration

Returns:

configuration is supported

createClient

public final SshClient createClient(SshConfiguration configuration)

Description copied from interface: SshProvider

Create a new client instance with the specified configuration.

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

Specified by:

createClient in interface SshProvider

Parameters:

configuration - configuration

Returns:

client

doSupportsConfiguration

protected abstract void doSupportsConfiguration(SshConfiguration configuration)

doCreateClient

protected abstract SshClient doCreateClient(SshConfiguration configuration)

createIdentityManager

public SshIdentityManager createIdentityManager(SshConfiguration configuration)

Description copied from interface: SshProvider

Create an @SshIdentityManager (if supported)

Specified by:

createIdentityManager in interface SshProvider

Parameters:

configuration - configuration

Returns:

identity manager

createHostKeyManager

public SshHostKeyManager createHostKeyManager(SshConfiguration configuration)
                                       throws SshException

Description copied from interface: SshProvider

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.

Specified by:

createHostKeyManager in interface SshProvider

Parameters:

configuration - configuration

Returns:

host key manager

Throws:

SshException

connectToLocalAgent

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

Description copied from interface: SshProvider

Create a connection to the local agent.

Specified by:

connectToLocalAgent in interface SshProvider

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:

SshException

connectToLocalAgent

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

Description copied from interface: SshProvider

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

Specified by:

connectToLocalAgent in interface SshProvider

Parameters:

application - the application connecting

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

Returns:

connected agent client

Throws:

SshException

connectToLocalAgent

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

Description copied from interface: SshProvider

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

Specified by:

connectToLocalAgent in interface SshProvider

Parameters:

application - the application connecting

Returns:

connected agent client

Throws:

SshException