net.sf.sshapi

Class AbstractClient

java.lang.Object

net.sf.sshapi.AbstractClient

All Implemented Interfaces:

SshClient

Direct Known Subclasses:

LibsshClient

public abstract class AbstractClient
extends java.lang.Object
implements SshClient

Abstract implementation of a SshClient. All provider client implementations will probably want to extend this as it provides some basic common services.

Constructor Summary

Constructors

Constructor and Description
AbstractClient(SshConfiguration configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addChannelHandler(SshChannelHandler channelFactory) Adds a channel handler to those invoked when custom channel creation requests are received.
void	addPortForwardListener(SshPortForwardListener listener) Add a listener that is notified when channels are opened on this port forward.
boolean	authenticate(SshAuthenticator authenticator) Authenticate using a single authenticator.
protected java.util.Map	createAuthenticatorMap(SshAuthenticator[] authenticators)
SshPublicKeySubsystem	createPublicKeySubsystem() Create an instance of a SshPublicKeySubsystem, if the provider supports it.
protected void	firePortForwardChannelClosed(int type, SshPortForwardTunnel channel)
protected void	firePortForwardChannelOpened(int type, SshPortForwardTunnel channel)
SshConfiguration	getConfiguration() Get the configuration this client is using
SshProvider	getProvider() Get the provider that created this client.
int	getTimeout() Get the timeout on the underlying transport (usually a Socket, if supported).
void	init(SshProvider provider) Called after instantiation to initialise the client and supply the provider that created it.
void	removeChannelHandler(SshChannelHandler channelFactory) Remove a channel handler from the list of those invoked when custom channel creation requests are received.
void	removePortForwardListener(SshPortForwardListener listener) Remove a listener that is notified when channels are opened on this port forward.
void	setTimeout(int timeout) Set the timeout on the underlying transport (usually a Socket, if supported).

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.SshClient

authenticate, connect, createCommand, createLocalForward, createRemoteForward, createSCPClient, createSftpClient, createShell, createTunneledSocketFactory, disconnect, getChannelCount, getRemoteIdentification, getRemoteProtocolVersion, getUsername, isAuthenticated, isConnected

Constructor Detail

AbstractClient

public AbstractClient(SshConfiguration configuration)

Constructor.

Parameters:

configuration - configuration

Method Detail

addPortForwardListener

public void addPortForwardListener(SshPortForwardListener listener)

Description copied from interface: SshClient

Add a listener that is notified when channels are opened on this port forward.

Specified by:

addPortForwardListener in interface SshClient

Parameters:

listener - listener to add

removePortForwardListener

public void removePortForwardListener(SshPortForwardListener listener)

Description copied from interface: SshClient

Remove a listener that is notified when channels are opened on this port forward.

Specified by:

removePortForwardListener in interface SshClient

Parameters:

listener - listener to remove

getConfiguration

public SshConfiguration getConfiguration()

Description copied from interface: SshClient

Get the configuration this client is using

Specified by:

getConfiguration in interface SshClient

Returns:

configuration

init

public final void init(SshProvider provider)

Description copied from interface: SshClient

Called after instantiation to initialise the client and supply the provider that created it. This method should not be be called directly.

Specified by:

init in interface SshClient

Parameters:

provider - provider

getProvider

public final SshProvider getProvider()

Description copied from interface: SshClient

Get the provider that created this client.

Specified by:

getProvider in interface SshClient

Returns:

provider

authenticate

public final boolean authenticate(SshAuthenticator authenticator)
                           throws SshException

Description copied from interface: SshClient

Authenticate using a single authenticator. In practice, will most likely just call SshClient.authenticate(SshAuthenticator[]).

Specified by:

authenticate in interface SshClient

Parameters:

authenticator - authenticator.

Returns:

authenticated authenticated

Throws:

SshException

See Also:

#authenticate(SshAuthenticator[])}

addChannelHandler

public void addChannelHandler(SshChannelHandler channelFactory)
                       throws SshException

Description copied from interface: SshClient

Adds a channel handler to those invoked when custom channel creation requests are received.

Specified by:

addChannelHandler in interface SshClient

Parameters:

channelFactory - channel handler to add

Throws:

SshException

removeChannelHandler

public void removeChannelHandler(SshChannelHandler channelFactory)
                          throws SshException

Description copied from interface: SshClient

Remove a channel handler from the list of those invoked when custom channel creation requests are received.

Specified by:

removeChannelHandler in interface SshClient

Parameters:

channelFactory - channel handler to remove

Throws:

SshException

createAuthenticatorMap

protected java.util.Map createAuthenticatorMap(SshAuthenticator[] authenticators)

firePortForwardChannelOpened

protected void firePortForwardChannelOpened(int type,
                                            SshPortForwardTunnel channel)

firePortForwardChannelClosed

protected void firePortForwardChannelClosed(int type,
                                            SshPortForwardTunnel channel)

createPublicKeySubsystem

public SshPublicKeySubsystem createPublicKeySubsystem()
                                               throws SshException

Description copied from interface: SshClient

Create an instance of a SshPublicKeySubsystem, if the provider supports it.

Note, this method does not actually start the subsystems, you must call SshLifecycleComponent.open() to do that.

Remember to close the subsystem when you are finished with it using SshLifecycleComponent.close().

Specified by:

createPublicKeySubsystem in interface SshClient

Returns:

public key subsystem instance.

Throws:

SshException

setTimeout

public void setTimeout(int timeout)
                throws java.io.IOException

Description copied from interface: SshClient

Set the timeout on the underlying transport (usually a Socket, if supported). A timeout of zero indicates infinite timeout

Specified by:

setTimeout in interface SshClient

Parameters:

timeout - timeout

Throws:

java.io.IOException

getTimeout

public int getTimeout()
               throws java.io.IOException

Description copied from interface: SshClient

Get the timeout on the underlying transport (usually a Socket, if supported). A timeout of zero indicates infinite timeout

Specified by:

getTimeout in interface SshClient

Returns:

timeout

Throws:

java.io.IOException