Top Description Inners Methods
org.apache.sshd.common.channel

public Interface RequestHandler<T>

Known Direct Subinterfaces
org.apache.sshd.common.session.ConnectionServiceRequestHandler, org.apache.sshd.common.channel.ChannelRequestHandler
Known Direct Implementers
org.apache.sshd.common.channel.AbstractRequestHandler
Annotations
@FunctionalInterface
Type Parameters
<T>
Request type
Imports
java.util.Collections, .EnumSet, .Set, org.apache.sshd.common.util.GenericUtils, org.apache.sshd.common.util.buffer.Buffer
A global request handler.
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
RequestHandler.Result

Method Summary

Modifier and TypeMethod and Description
public RequestHandler.Result

Returns:

The Result
process(T
The input parameter
t, String
The request string
request, boolean
Whether a reply is requested
wantReply, Buffer
The Buffer with request specific data
buffer)

Process an SSH request.

Method Detail

processback to summary
public RequestHandler.Result process(T t, String request, boolean wantReply, Buffer buffer) throws Exception

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
t:T

The input parameter

request:String

The request string

wantReply:boolean

Whether a reply is requested

buffer:Buffer

The Buffer with request specific data

Returns:RequestHandler.Result

The Result

Exceptions
Exception:
If failed to handle the request - Note: in order to signal an unsupported request the Result#Unsupported value should be returned
org.apache.sshd.common.channel back to summary

public final Enum RequestHandler.Result

extends Enum<RequestHandler.Result>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final RequestHandler.Result
Replied

public static final RequestHandler.Result
ReplyFailure

public static final RequestHandler.Result
ReplySuccess

public static final RequestHandler.Result
Unsupported

public static final Set<RequestHandler.Result>
VALUES

Constructor Summary

AccessConstructor and Description
private
Result()

Method Summary

Modifier and TypeMethod and Description
public static RequestHandler.Result

Returns:

The matching Result value (case insensitive) or null if no match found
fromName(String
The result name - ignored if null/empty
name)

public static RequestHandler.Result
valueOf(String name)

public static RequestHandler.Result[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Repliedback to summary
public static final RequestHandler.Result Replied
ReplyFailureback to summary
public static final RequestHandler.Result ReplyFailure
ReplySuccessback to summary
public static final RequestHandler.Result ReplySuccess
Unsupportedback to summary
public static final RequestHandler.Result Unsupported
VALUESback to summary
public static final Set<RequestHandler.Result> VALUES

Constructor Detail

Resultback to summary
private Result()

Method Detail

fromNameback to summary
public static RequestHandler.Result fromName(String name)
Parameters
name:String

The result name - ignored if null/empty

Returns:RequestHandler.Result

The matching Result value (case insensitive) or null if no match found

valueOfback to summary
public static RequestHandler.Result valueOf(String name)
valuesback to summary
public static RequestHandler.Result[] values()