org.apache.sshd.server.channel

Class PuttyRequestHandler

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.channel.AbstractRequestHandler<Channel>

org.apache.sshd.common.channel.AbstractChannelRequestHandler

org.apache.sshd.server.channel.PuttyRequestHandler

All Implemented Interfaces:

ChannelRequestHandler, RequestHandler<Channel>

public class PuttyRequestHandler
extends AbstractChannelRequestHandler

Handles Putty specific channel requests as indicated by Appendix F: SSH-2 names specified for PuTTY

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.channel.RequestHandler

RequestHandler.Result

Field Summary

Fields

Modifier and Type	Field and Description
static PuttyRequestHandler	INSTANCE
static Set<PtyMode>	PUTTY_OPTIONS
static String	REQUEST_SUFFIX Suffix of all PUTTY related channel requests

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.channel.ChannelRequestHandler

CHANN2HNDLR

Constructor Summary

Constructors

Constructor and Description
PuttyRequestHandler()

Method Summary

Modifier and Type	Method and Description
static boolean	isPuttyClient(Session session)
static boolean	isPuttyClient(String clientVersion)
static boolean	isPuttyRequest(String request)
RequestHandler.Result	process(Channel channel, String request, boolean wantReply, Buffer buffer) Process an SSH request.
protected RequestHandler.Result	processPuttyOpcode(Channel channel, String request, String opcode, boolean wantReply, Buffer buffer)
static Map<PtyMode,Integer>	resolveShellTtyOptions(Map<PtyMode,Integer> modes)

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_SUFFIX

public static final String REQUEST_SUFFIX

Suffix of all PUTTY related channel requests

See Also:

Constant Field Values

PUTTY_OPTIONS

public static final Set<PtyMode> PUTTY_OPTIONS

INSTANCE

public static final PuttyRequestHandler INSTANCE

Constructor Detail

PuttyRequestHandler

public PuttyRequestHandler()

Method Detail

process

public RequestHandler.Result process(Channel channel,
                                     String request,
                                     boolean wantReply,
                                     Buffer buffer)
                              throws Exception

Description copied from interface: RequestHandler

Process an SSH request. If an exception is thrown, the ConnectionService will send a failure message if needed and the request will be considered handled.

Parameters:

channel - The input parameter

request - The request string

wantReply - Whether a reply is requested

buffer - The Buffer with request specific data

Returns:

The RequestHandler.Result

Throws:

Exception - If failed to handle the request - Note: in order to signal an unsupported request the RequestHandler.Result.Unsupported value should be returned

processPuttyOpcode

protected RequestHandler.Result processPuttyOpcode(Channel channel,
                                                   String request,
                                                   String opcode,
                                                   boolean wantReply,
                                                   Buffer buffer)
                                            throws Exception

Throws:

Exception

isPuttyRequest

public static boolean isPuttyRequest(String request)

Parameters:

request - The channel request value - ignored if null/empty

Returns:

true if the request ends in REQUEST_SUFFIX

isPuttyClient

public static boolean isPuttyClient(Session session)

Parameters:

session - The current Session - ignored if null

Returns:

true if it is a PUTTY session

See Also:

SessionContext.getClientVersion(), isPuttyClient(String)

isPuttyClient

public static boolean isPuttyClient(String clientVersion)

Parameters:

clientVersion - The client identification string - ignored if null/empty

Returns:

true if the identification starts with the SessionContext.DEFAULT_SSH_VERSION_PREFIX and it contains the "putty" string (case insensitive)

resolveShellTtyOptions

public static Map<PtyMode,Integer> resolveShellTtyOptions(Map<PtyMode,Integer> modes)