Top Description Fields Constructors Methods
org.apache.sshd.server.global

public Class TcpipForwardHandler

extends AbstractConnectionServiceRequestHandler
Class Inheritance
Imports
java.util.Objects, java.util.function.IntUnaryOperator, org.apache.sshd.common.SshConstants, org.apache.sshd.common.forward.Forwarder, org.apache.sshd.common.session.ConnectionService, .Session, org.apache.sshd.common.session.helpers.AbstractConnectionServiceRequestHandler, org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.common.util.functors.Int2IntFunction, org.apache.sshd.common.util.net.SshdSocketAddress
Handler for "tcpip-forward" global request.
Author
Apache MINA SSHD Project
See Also
RFC4254 section 7

Field Summary

Modifier and TypeField and Description
public static final TcpipForwardHandler
INSTANCE

public static final String
REQUEST

public static final IntUnaryOperator
RESPONSE_BUFFER_GROWTH_FACTOR

Default growth factor function used to resize response buffers

Constructor Summary

AccessConstructor and Description
public
TcpipForwardHandler()

Method Summary

Modifier and TypeMethod and Description
public RequestHandler.Result
process(ConnectionService
The input parameter
connectionService, String
The request string
request, boolean
Whether a reply is requested
wantReply, Buffer
The Buffer with request specific data
buffer)

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionServiceRequestHandler.process.

Implements org.apache.sshd.common.session.ConnectionServiceRequestHandler.process.

Process an SSH request.

Field Detail

INSTANCEback to summary
public static final TcpipForwardHandler INSTANCE
REQUESTback to summary
public static final String REQUEST
RESPONSE_BUFFER_GROWTH_FACTORback to summary
public static final IntUnaryOperator RESPONSE_BUFFER_GROWTH_FACTOR

Default growth factor function used to resize response buffers

Constructor Detail

TcpipForwardHandlerback to summary
public TcpipForwardHandler()

Method Detail

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

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionServiceRequestHandler.process.

Implements org.apache.sshd.common.session.ConnectionServiceRequestHandler.process.

Doc from org.apache.sshd.common.channel.RequestHandler.process.

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
connectionService:ConnectionService

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

Annotations
@Override
Exceptions
Exception:
If failed to handle the request - Note: in order to signal an unsupported request the Result#Unsupported value should be returned