com.maverick.sshd

Class ConnectionProtocol

java.lang.Object

com.maverick.sshd.ConnectionProtocol

All Implemented Interfaces:

Service

public class ConnectionProtocol
extends Object
implements Service

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

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
void	addGlobalRequestHandler(GlobalRequestHandler handler)
void	disconnect() Disconnect the current connection.
protected void	doProcessMessage(byte[] msg)
List<Channel>	getActiveChannels()
SshContext	getContext() Get the connections ConfigurationContext.
int	getIdleTimeoutSeconds() How long does the service allow idle for?
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()
SocketAddress	getRemoteAddress() Get the address of the remote client.
static RemoteForwardingManager	getRemoteForwardingManager()
String	getSessionIdentifier()
TransportProtocol	getTransport() Get the underlying transport.
String	getUsername() Get the username for the connected user.
String	getUUID()
void	idle() Transport level idle
void	init(TransportProtocol transport) Initialize the service.
boolean	openChannel(Channel channel)
boolean	processMessage(byte[] msg) Process a transport message.
void	sendChannelOpenConfirmation(Channel channel, byte[] responsedata)
void	sendChannelOpenFailure(Channel channel, int reason, String desc)
void	sendGlobalRequest(GlobalRequest request)
void	start() Start the service.
void	stop() Stop the service

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

init

public void init(TransportProtocol transport)
          throws IOException

Description copied from interface: Service

Initialize the service.

Specified by:

init in interface Service

Throws:

IOException

addGlobalRequestHandler

public void addGlobalRequestHandler(GlobalRequestHandler handler)

idle

public void idle()

Description copied from interface: Service

Transport level idle

Specified by:

idle in interface Service

getRemoteForwardingManager

public static RemoteForwardingManager getRemoteForwardingManager()

getRemoteAddress

public SocketAddress getRemoteAddress()

Get the address of the remote client.

Returns:

SocketAddress

getLocalAddress

public 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 String getUsername()

Get the username for the connected user.

Returns:

String

stop

public void stop()

Description copied from interface: Service

Stop the service

Specified by:

stop in interface Service

getSessionIdentifier

public String getSessionIdentifier()

openChannel

public boolean openChannel(Channel channel)

getActiveChannels

public List<Channel> getActiveChannels()

getMaxChannels

public int getMaxChannels()

disconnect

public void disconnect()

Disconnect the current connection.

processMessage

public boolean processMessage(byte[] msg)
                       throws 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:

IOException

doProcessMessage

protected void doProcessMessage(byte[] msg)
                         throws IOException

Throws:

IOException

sendGlobalRequest

public void sendGlobalRequest(GlobalRequest request)

getQueueSize

public int getQueueSize()

sendChannelOpenConfirmation

public void sendChannelOpenConfirmation(Channel channel,
                                        byte[] responsedata)

sendChannelOpenFailure

public void sendChannelOpenFailure(Channel channel,
                                   int reason,
                                   String desc)

getContext

public SshContext getContext()

Get the connections ConfigurationContext.

Returns:

SshContext

getTransport

public TransportProtocol 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

getUUID

public 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: