org.apache.sshd.client.session

Interface ClientProxyConnector

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 ClientProxyConnector

Provides a way to implement proxied connections where some metadata about the client is sent before the actual SSH protocol is executed - e.g., the PROXY protocol. The implementor should use the IoSession#write(Buffer) method to send any packets with the meta-data.

Method Summary

Modifier and Type	Method and Description
void	sendClientProxyMetadata(ClientSession session) Invoked just before the client identification is sent so that the proxy can send the meta-data to its peer.

Method Detail

sendClientProxyMetadata

void sendClientProxyMetadata(ClientSession session)
                      throws java.lang.Exception

Invoked just before the client identification is sent so that the proxy can send the meta-data to its peer. Upon successful return the SSH identification line is sent and the protocol proceeds as usual.

Parameters:

session - The ClientSession instance

Throws:

java.lang.Exception - If failed to send the data - which will also terminate the session