org.apache.sshd.common.channel

Interface RequestHandler<T>

Type Parameters:

T - Request type

All Known Subinterfaces:

ChannelRequestHandler, ConnectionServiceRequestHandler

All Known Implementing Classes:

AbstractChannelExitRequestHandler, AbstractChannelRequestHandler, AbstractConnectionServiceRequestHandler, AbstractOpenSshHostKeysHandler, AbstractRequestHandler, CancelTcpipForwardHandler, ExitSignalChannelRequestHandler, ExitStatusChannelRequestHandler, KeepAliveHandler, NoMoreSessionsHandler, OpenSshHostKeysHandler, OpenSshHostKeysHandler, PuttyRequestHandler, TcpipForwardHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RequestHandler<T>

A global request handler.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequestHandler.Result

Method Summary

Modifier and Type	Method and Description
RequestHandler.Result	process(T t, java.lang.String request, boolean wantReply, Buffer buffer) Process an SSH request.

Method Detail

process

RequestHandler.Result process(T t,
                              java.lang.String request,
                              boolean wantReply,
                              Buffer buffer)
                       throws java.lang.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 - 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:

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