com.sshtools.synergy.ssh

Class ConnectionProtocol<T extends SshContext>

java.lang.Object

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

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

All Implemented Interfaces:

Service

public abstract class ConnectionProtocol<T extends SshContext>
extends ExecutorOperationSupport<SshContext>
implements Service

This class implements the SSH Connection Protocol as an SSH Transport Protocol service.

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection<T>	con
protected java.util.LinkedList<GlobalRequest>	outstandingRequests
static java.lang.String	SERVICE_NAME
protected java.lang.String	username

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

CALLBACKS, EVENTS, MESSAGES_INCOMING, MESSAGES_OUTGOING

Constructor Summary

Constructors

Constructor and Description
ConnectionProtocol(TransportProtocol<T> transport, java.lang.String username)

Method Summary

Modifier and Type	Method and Description
void	addGlobalRequestHandler(GlobalRequestHandler<T> handler)
protected abstract ChannelNG<T>	createChannel(java.lang.String channeltype, Connection<T> con)
void	disconnect() Disconnect the current connection.
java.util.List<ChannelNG<T>>	getActiveChannels()
Connection<T>	getConnection()
T	getContext() Get the connections ConfigurationContext.
int	getIdleTimeoutSeconds() How long does the service allow idle for?
java.net.SocketAddress	getLocalAddress() Get the local address to which the remote socket is connected.
int	getLocalPort() Get the local port ro which the remote socket is connected.
int	getMaxChannels()
int	getQueueSize()
java.net.SocketAddress	getRemoteAddress() Get the address of the remote client.
java.lang.String	getSessionIdentifier()
TransportProtocol<T>	getTransport() Get the underlying transport.
java.lang.String	getUsername() Get the username for the connected user.
java.lang.String	getUUID()
boolean	idle() The service has reached idle timeout seconds
protected abstract boolean	isClient()
protected abstract void	onStart()
protected abstract void	onStop()
void	openChannel(ChannelNG<T> channel)
protected void	processGlobalRequestFailure(byte[] msg) Process a global request failure
protected void	processGlobalRequestSuccess(byte[] m) Process a global request success response.
boolean	processMessage(byte[] msg) Process a transport message.
protected abstract boolean	processTCPIPCancel(com.sshtools.common.util.ByteArrayReader bar, com.sshtools.common.util.ByteArrayWriter msg)
protected abstract boolean	processTCPIPForward(com.sshtools.common.util.ByteArrayReader bar, com.sshtools.common.util.ByteArrayWriter response)
void	sendChannelOpenConfirmation(ChannelNG<T> channel, byte[] responsedata)
void	sendChannelOpenFailure(ChannelNG<T> channel, int reason, java.lang.String desc)
void	sendGlobalRequest(GlobalRequest request, boolean wantReply)
void	start() Start the service.
void	stop() Stop the service

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

Methods inherited from interface com.sshtools.synergy.ssh.Service

getName

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

outstandingRequests

protected java.util.LinkedList<GlobalRequest> outstandingRequests

username

protected java.lang.String username

con

protected Connection<T extends SshContext> con

Constructor Detail

ConnectionProtocol

public ConnectionProtocol(TransportProtocol<T> transport,
                          java.lang.String username)

Method Detail

addGlobalRequestHandler

public void addGlobalRequestHandler(GlobalRequestHandler<T> handler)

getRemoteAddress

public java.net.SocketAddress getRemoteAddress()

Get the address of the remote client.

Returns:

SocketAddress

getLocalAddress

public java.net.SocketAddress getLocalAddress()

Get the local address to which the remote socket is connected.

Returns:

InetAddress

getLocalPort

public int getLocalPort()

Get the local port ro which the remote socket is connected.

Returns:

int

getUsername

public java.lang.String getUsername()

Get the username for the connected user.

Returns:

String

onStop

protected abstract void onStop()

stop

public void stop()

Description copied from interface: Service

Stop the service

Specified by:

stop in interface Service

getSessionIdentifier

public java.lang.String getSessionIdentifier()

openChannel

public void openChannel(ChannelNG<T> channel)

getActiveChannels

public java.util.List<ChannelNG<T>> getActiveChannels()

getMaxChannels

public int getMaxChannels()

disconnect

public void disconnect()

Disconnect the current connection.

processMessage

public boolean processMessage(byte[] msg)
                       throws java.io.IOException

Description copied from interface: Service

Process a transport message. When a message is received by the TransportProtocol that is not a transport level message the message is passed onto the active service using this method. The service processes the message and returns a value to indicate whether the message was used.

Specified by:

processMessage in interface Service

Returns:

true if the message was processed, otherwise false

Throws:

java.io.IOException

processGlobalRequestSuccess

protected void processGlobalRequestSuccess(byte[] m)

Process a global request success response.

processGlobalRequestFailure

protected void processGlobalRequestFailure(byte[] msg)

Process a global request failure

processTCPIPCancel

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

Throws:

java.io.IOException

processTCPIPForward

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

Throws:

java.io.IOException

createChannel

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

Throws:

UnsupportedChannelException

PermissionDeniedException

ChannelOpenException

sendGlobalRequest

public void sendGlobalRequest(GlobalRequest request,
                              boolean wantReply)

getQueueSize

public int getQueueSize()

sendChannelOpenConfirmation

public void sendChannelOpenConfirmation(ChannelNG<T> channel,
                                        byte[] responsedata)

sendChannelOpenFailure

public void sendChannelOpenFailure(ChannelNG<T> channel,
                                   int reason,
                                   java.lang.String desc)

getContext

public T getContext()

Get the connections ConfigurationContext.

Specified by:

getContext in class ExecutorOperationSupport<SshContext>

Returns:

SshContext

getTransport

public TransportProtocol<T> getTransport()

Get the underlying transport. Use with Caution.

Returns:

TransportProtocol

start

public void start()

Description copied from interface: Service

Start the service.

Specified by:

start in interface Service

onStart

protected abstract void onStart()

getUUID

public java.lang.String getUUID()

getIdleTimeoutSeconds

public int getIdleTimeoutSeconds()

Description copied from interface: Service

How long does the service allow idle for?

Specified by:

getIdleTimeoutSeconds in interface Service

Returns:

idle

public boolean idle()

Description copied from interface: Service

The service has reached idle timeout seconds

Specified by:

idle in interface Service

Returns:

isClient

protected abstract boolean isClient()

getConnection

public Connection<T> getConnection()