Package org.apache.hc.core5.reactor

Class SocksProxyProtocolHandler

java.lang.Object

org.apache.hc.core5.reactor.SocksProxyProtocolHandler

All Implemented Interfaces:

IOEventHandler

final class SocksProxyProtocolHandler
extends Object
implements IOEventHandler

Implements the client side of SOCKS protocol version 5 as per https://tools.ietf.org/html/rfc1928. Supports SOCKS username/password authentication as per https://tools.ietf.org/html/rfc1929.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	SocksProxyProtocolHandler.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte	ATYP_DOMAINNAME
private ByteBuffer	buffer
private static final byte	CLIENT_VERSION
private static final byte	COMMAND_CONNECT
private final InternalDataChannel	dataChannel
private final IOEventHandlerFactory	eventHandlerFactory
private static final int	MAX_COMMAND_CONNECT_LENGTH
private static final int	MAX_DNS_NAME_LENGTH
private static final byte	NO_AUTHENTICATION_REQUIRED
private final IOReactorConfig	reactorConfig
private final IOSessionRequest	sessionRequest
private SocksProxyProtocolHandler.State	state
private static final byte	SUCCESS
private static final byte	USERNAME_PASSWORD
private static final byte	USERNAME_PASSWORD_VERSION

Constructor Summary

Constructors

Constructor	Description
SocksProxyProtocolHandler(InternalDataChannel dataChannel, IOSessionRequest sessionRequest, IOEventHandlerFactory eventHandlerFactory, IOReactorConfig reactorConfig)

Method Summary

Modifier and Type	Method	Description
void	connected(IOSession session)	Triggered after the given session has been just created.
private byte[]	cred(String cred)
void	disconnected(IOSession session)	Triggered when the given session has been terminated.
void	exception(IOSession session, Exception cause)	Triggered when the given session throws a exception.
private boolean	fillBuffer(ByteChannel channel)
void	inputReady(IOSession session, ByteBuffer src)	Triggered when the given session has input pending.
void	outputReady(IOSession session)	Triggered when the given session is ready for output.
private void	prepareConnectCommand()
private void	setBufferLimit(int newLimit)
void	timeout(IOSession session, Timeout timeout)	Triggered when the given session has timed out.
private boolean	writeAndPrepareRead(ByteChannel channel, int readSize)
private boolean	writeBuffer(ByteChannel channel)

Methods inherited from class java.lang.Object

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

Field Details

MAX_DNS_NAME_LENGTH

private static final int MAX_DNS_NAME_LENGTH

See Also:

• Constant Field Values

MAX_COMMAND_CONNECT_LENGTH

private static final int MAX_COMMAND_CONNECT_LENGTH

See Also:

• Constant Field Values

CLIENT_VERSION

private static final byte CLIENT_VERSION

See Also:

• Constant Field Values

NO_AUTHENTICATION_REQUIRED

private static final byte NO_AUTHENTICATION_REQUIRED

See Also:

• Constant Field Values

USERNAME_PASSWORD

private static final byte USERNAME_PASSWORD

See Also:

• Constant Field Values

USERNAME_PASSWORD_VERSION

private static final byte USERNAME_PASSWORD_VERSION

See Also:

• Constant Field Values

SUCCESS

private static final byte SUCCESS

See Also:

• Constant Field Values

COMMAND_CONNECT

private static final byte COMMAND_CONNECT

See Also:

• Constant Field Values

ATYP_DOMAINNAME

private static final byte ATYP_DOMAINNAME

See Also:

• Constant Field Values

dataChannel

private final InternalDataChannel dataChannel

sessionRequest

private final IOSessionRequest sessionRequest

eventHandlerFactory

private final IOEventHandlerFactory eventHandlerFactory

reactorConfig

private final IOReactorConfig reactorConfig

buffer

private ByteBuffer buffer

state

private SocksProxyProtocolHandler.State state

Constructor Details

SocksProxyProtocolHandler

SocksProxyProtocolHandler(InternalDataChannel dataChannel,
 IOSessionRequest sessionRequest,
 IOEventHandlerFactory eventHandlerFactory,
 IOReactorConfig reactorConfig)

Method Details

connected

public void connected(IOSession session)
               throws IOException

Description copied from interface: IOEventHandler

Triggered after the given session has been just created.

Specified by:

connected in interface IOEventHandler

Parameters:

session - the I/O session.

Throws:

IOException

outputReady

public void outputReady(IOSession session)
                 throws IOException

Description copied from interface: IOEventHandler

Triggered when the given session is ready for output.

Specified by:

outputReady in interface IOEventHandler

Parameters:

session - the I/O session.

Throws:

IOException

cred

private byte[] cred(String cred)
             throws IOException

Throws:

IOException

inputReady

public void inputReady(IOSession session,
 ByteBuffer src)
                throws IOException

Description copied from interface: IOEventHandler

Triggered when the given session has input pending.

Specified by:

inputReady in interface IOEventHandler

Parameters:

session - the I/O session.

Throws:

IOException

prepareConnectCommand

private void prepareConnectCommand()
                            throws IOException

Throws:

IOException

setBufferLimit

private void setBufferLimit(int newLimit)

writeAndPrepareRead

private boolean writeAndPrepareRead(ByteChannel channel,
 int readSize)
                             throws IOException

Throws:

IOException

writeBuffer

private boolean writeBuffer(ByteChannel channel)
                     throws IOException

Throws:

IOException

fillBuffer

private boolean fillBuffer(ByteChannel channel)
                    throws IOException

Throws:

IOException

timeout

public void timeout(IOSession session,
 Timeout timeout)
             throws IOException

Description copied from interface: IOEventHandler

Triggered when the given session has timed out.

Specified by:

timeout in interface IOEventHandler

Parameters:

session - the I/O session.

timeout - the timeout.

Throws:

IOException

exception

public void exception(IOSession session,
 Exception cause)

Description copied from interface: IOEventHandler

Triggered when the given session throws a exception.

Specified by:

exception in interface IOEventHandler

Parameters:

session - the I/O session.

disconnected

public void disconnected(IOSession session)

Description copied from interface: IOEventHandler

Triggered when the given session has been terminated.

Specified by:

disconnected in interface IOEventHandler

Parameters:

session - the I/O session.