org.snf4j.core.proxy

Class Socks5ProxyHandler

java.lang.Object

org.snf4j.core.handler.AbstractHandler

org.snf4j.core.handler.AbstractStreamHandler

org.snf4j.core.proxy.AbstractProxyHandler

org.snf4j.core.proxy.AbstractSocksProxyHandler

org.snf4j.core.proxy.Socks5ProxyHandler

All Implemented Interfaces:

IHandler, IStreamHandler, IStreamReader

public class Socks5ProxyHandler
extends AbstractSocksProxyHandler

Handles client proxy connections via the SOCKS Protocol Version 5. For more details about the protocol refer to RFC 1928.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
Socks5ProxyHandler(InetSocketAddress address) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command and the default (10 seconds) connection timeout.
Socks5ProxyHandler(InetSocketAddress address, ISessionConfig config) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, the default (10 seconds) connection timeout and configuration.
Socks5ProxyHandler(InetSocketAddress address, ISessionConfig config, ISessionStructureFactory factory) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, the default (10 seconds) connection timeout, configuration and factory.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command and the default (10 seconds) connection timeout.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command, ISessionConfig config) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, the default (10 seconds) connection timeout and configuration.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command, ISessionConfig config, ISessionStructureFactory factory) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, the default (10 seconds) connection timeout, configuration and factory.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command, String username, String password) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password and the default (10 seconds) connection timeout.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command, String username, String password, ISessionConfig config) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password, the default (10 seconds) connection timeout and configuration.
Socks5ProxyHandler(InetSocketAddress address, Socks5Command command, String username, String password, ISessionConfig config, ISessionStructureFactory factory) Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password, the default (10 seconds) connection timeout, configuration and factory.
Socks5ProxyHandler(InetSocketAddress address, String username, String password) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password and the default (10 seconds) connection timeout.
Socks5ProxyHandler(InetSocketAddress address, String username, String password, ISessionConfig config) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password, the default (10 seconds) connection timeout and configuration.
Socks5ProxyHandler(InetSocketAddress address, String username, String password, ISessionConfig config, ISessionStructureFactory factory) Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password, the default (10 seconds) connection timeout, configuration and factory.

Method Summary

Modifier and Type	Method and Description
Socks5ProxyHandler	connectionTimeout(long connectionTimeout) Configures the proxy connection timeout.

Methods inherited from class org.snf4j.core.proxy.AbstractSocksProxyHandler

addReplyListener, available, available, event, getAddress, getReplies, handleReady, read, read, read

Methods inherited from class org.snf4j.core.proxy.AbstractProxyHandler

getFactory, timer

Methods inherited from class org.snf4j.core.handler.AbstractStreamHandler

getSession, setSession

Methods inherited from class org.snf4j.core.handler.AbstractHandler

event, exception, getConfig, getName, incident, timer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.handler.IHandler

event, exception, getConfig, getName, incident, timer

Constructor Detail

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command and the default (10 seconds) connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          ISessionConfig config)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, the default (10 seconds) connection timeout and configuration.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

config - the session configuration object, or null to use the default configuration

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          ISessionConfig config,
                          ISessionStructureFactory factory)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, the default (10 seconds) connection timeout, configuration and factory.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

config - the session configuration object, or null to use the default configuration

factory - the factory that will be used to configure the internal structure of the associated session, or null to use the default factory

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          String username,
                          String password)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password and the default (10 seconds) connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          String username,
                          String password,
                          ISessionConfig config)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password, the default (10 seconds) connection timeout and configuration.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

config - the session configuration object, or null to use the default configuration

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          String username,
                          String password,
                          ISessionConfig config,
                          ISessionStructureFactory factory)

Constructs a SOCKS5 proxy connection handler with the specified destination address, the default (CONNECT) command, user's name/password, the default (10 seconds) connection timeout, configuration and factory.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

config - the session configuration object, or null to use the default configuration

factory - the factory that will be used to configure the internal structure of the associated session, or null to use the default factory

Throws:

IllegalArgumentException - if the address is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command and the default (10 seconds) connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

Throws:

IllegalArgumentException - if the address or the command is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command,
                          ISessionConfig config)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, the default (10 seconds) connection timeout and configuration.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

config - the session configuration object, or null to use the default configuration

Throws:

IllegalArgumentException - if the address or the command is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command,
                          ISessionConfig config,
                          ISessionStructureFactory factory)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, the default (10 seconds) connection timeout, configuration and factory.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

config - the session configuration object, or null to use the default configuration

factory - the factory that will be used to configure the internal structure of the associated session, or null to use the default factory

Throws:

IllegalArgumentException - if the address or the command is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command,
                          String username,
                          String password)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password and the default (10 seconds) connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

Throws:

IllegalArgumentException - if the address or the command is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command,
                          String username,
                          String password,
                          ISessionConfig config)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password, the default (10 seconds) connection timeout and configuration.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

config - the session configuration object, or null to use the default configuration

Throws:

IllegalArgumentException - if the address or the command is null

Socks5ProxyHandler

public Socks5ProxyHandler(InetSocketAddress address,
                          Socks5Command command,
                          String username,
                          String password,
                          ISessionConfig config,
                          ISessionStructureFactory factory)

Constructs a SOCKS5 proxy connection handler with the specified destination address, SOCKS5 command, user's name/password, the default (10 seconds) connection timeout, configuration and factory.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Parameters:

address - the destination address to the host to which the connection should be proxied

command - the SCOCS5 command

username - the user's name, or null for an empty name

password - the user's password, or null for an empty password

config - the session configuration object, or null to use the default configuration

factory - the factory that will be used to configure the internal structure of the associated session, or null to use the default factory

Throws:

IllegalArgumentException - if the address or the command is null

Method Detail

connectionTimeout

public Socks5ProxyHandler connectionTimeout(long connectionTimeout)

Configures the proxy connection timeout.

NOTE: The connection timeout will have no effect if the associated session does not support a session timer.

Overrides:

connectionTimeout in class AbstractProxyHandler

Parameters:

connectionTimeout - the proxy connection timeout in milliseconds, or 0 to wait an infinite amount of time for establishing the HTTP tunnel

Returns:

this handler

Throws:

IllegalArgumentException - if the connection timeout is negative