com.sshtools.client

Class ConnectionProtocolClient

java.lang.Object

com.sshtools.common.ssh.ExecutorOperationSupport<SshContext>

com.sshtools.synergy.ssh.ConnectionProtocol<SshClientContext>

com.sshtools.client.ConnectionProtocolClient

All Implemented Interfaces:

Service

public class ConnectionProtocolClient
extends ConnectionProtocol<SshClientContext>

Implements the client side of the SSH connection prototocol

Field Summary

Fields inherited from class com.sshtools.synergy.ssh.ConnectionProtocol

con, outstandingRequests, SERVICE_NAME, username

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

CALLBACKS, EVENTS, MESSAGES_INCOMING, MESSAGES_OUTGOING

Constructor Summary

Constructors

Constructor and Description
ConnectionProtocolClient(TransportProtocol<SshClientContext> transport, java.lang.String username)

Method Summary

Modifier and Type	Method and Description
protected ChannelNG<SshClientContext>	createChannel(java.lang.String channeltype, Connection<SshClientContext> con) Create an SSH channel.
SshClientContext	getContext()
java.lang.String	getName() The name of the ssh service i.e.
protected boolean	isClient()
protected void	onStart()
protected void	onStop()
protected boolean	processTCPIPCancel(com.sshtools.common.util.ByteArrayReader bar, com.sshtools.common.util.ByteArrayWriter msg) Process remote forwarding cancel request.
protected boolean	processTCPIPForward(com.sshtools.common.util.ByteArrayReader bar, com.sshtools.common.util.ByteArrayWriter response) Process a request for remote forwarding.
int	startLocalForwarding(java.lang.String addressToBind, int portToBind, java.lang.String destinationHost, int destinationPort) Start local port forwarding.
int	startRemoteForwarding(java.lang.String addressToBind, int portToBind, java.lang.String destinationHost, int destinationPort) Start remote port forwarding.
void	stopLocalForwarding()
void	stopLocalForwarding(java.lang.String key)
void	stopLocalForwarding(java.lang.String addressToBind, int portToBind)
void	stopRemoteForwarding()
void	stopRemoteForwarding(java.lang.String addressToBind, int portToBind)

Methods inherited from class com.sshtools.synergy.ssh.ConnectionProtocol

addGlobalRequestHandler, disconnect, getActiveChannels, getConnection, getIdleLog, getIdleTimeoutSeconds, getLocalAddress, getLocalPort, getMaxChannels, getQueueSize, getRemoteAddress, getSessionIdentifier, getTransport, getUsername, getUUID, idle, openChannel, processGlobalRequestFailure, processGlobalRequestSuccess, processMessage, sendChannelOpenConfirmation, sendChannelOpenFailure, sendGlobalRequest, start, stop

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

addIncomingTask, addOutgoingTask, addTask, cleanupOperations

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionProtocolClient

public ConnectionProtocolClient(TransportProtocol<SshClientContext> transport,
                                java.lang.String username)

Method Detail

isClient

protected boolean isClient()

Specified by:

isClient in class ConnectionProtocol<SshClientContext>

onStart

protected void onStart()

Specified by:

onStart in class ConnectionProtocol<SshClientContext>

onStop

protected void onStop()

Specified by:

onStop in class ConnectionProtocol<SshClientContext>

startLocalForwarding

public int startLocalForwarding(java.lang.String addressToBind,
                                int portToBind,
                                java.lang.String destinationHost,
                                int destinationPort)
                         throws UnauthorizedException,
                                SshException

Start local port forwarding. Listening on a local interface and forwarding the data to a host on the remote network.

Parameters:

addressToBind -

portToBind -

destinationHost -

destinationPort -

Returns:

Throws:

UnauthorizedException

SshException

stopLocalForwarding

public void stopLocalForwarding()

stopLocalForwarding

public void stopLocalForwarding(java.lang.String addressToBind,
                                int portToBind)

stopLocalForwarding

public void stopLocalForwarding(java.lang.String key)

stopRemoteForwarding

public void stopRemoteForwarding(java.lang.String addressToBind,
                                 int portToBind)
                          throws SshException

Throws:

SshException

stopRemoteForwarding

public void stopRemoteForwarding()

startRemoteForwarding

public int startRemoteForwarding(java.lang.String addressToBind,
                                 int portToBind,
                                 java.lang.String destinationHost,
                                 int destinationPort)
                          throws SshException

Start remote port forwarding. Requests that the server starts a listening socket on the remote network and delivers data to a host on the local network.

Parameters:

addressToBind -

portToBind -

destinationHost -

destinationPort -

Returns:

Throws:

SshException

getContext

public SshClientContext getContext()

Overrides:

getContext in class ConnectionProtocol<SshClientContext>

processTCPIPCancel

protected boolean processTCPIPCancel(com.sshtools.common.util.ByteArrayReader bar,
                                     com.sshtools.common.util.ByteArrayWriter msg)
                              throws java.io.IOException

Process remote forwarding cancel request. This method does nothing since the client does not support opening of remote forwarding channels.

Specified by:

processTCPIPCancel in class ConnectionProtocol<SshClientContext>

Throws:

java.io.IOException

processTCPIPForward

protected boolean processTCPIPForward(com.sshtools.common.util.ByteArrayReader bar,
                                      com.sshtools.common.util.ByteArrayWriter response)
                               throws java.io.IOException

Process a request for remote forwarding. This method does nothing since the client does not support opening of remote forwarding channels.

Specified by:

processTCPIPForward in class ConnectionProtocol<SshClientContext>

Throws:

java.io.IOException

getName

public java.lang.String getName()

The name of the ssh service i.e. ssh-connection

createChannel

protected ChannelNG<SshClientContext> createChannel(java.lang.String channeltype,
                                                    Connection<SshClientContext> con)
                                             throws UnsupportedChannelException,
                                                    PermissionDeniedException,
                                                    ChannelOpenException

Create an SSH channel. This method delegates creation to the ChannelFactory installed on the current SshContext.

Specified by:

createChannel in class ConnectionProtocol<SshClientContext>

Throws:

ChannelOpenException

UnsupportedChannelException

PermissionDeniedException