com.helger.network.proxy.config

Class SocksProxyConfig

java.lang.Object

com.helger.network.proxy.config.SocksProxyConfig

All Implemented Interfaces:

IProxyConfig, Serializable

@Immutable
public class SocksProxyConfig
extends Object
implements IProxyConfig

SOCKS proxy configuration.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SOCKS_PROXY_PORT
static String	SYSPROP_SOCKS_PROXY_HOST
static String	SYSPROP_SOCKS_PROXY_PORT

Constructor Summary

Constructors

Constructor and Description
SocksProxyConfig(String sHost) Create a SOCKS proxy config object based on the default port DEFAULT_SOCKS_PROXY_PORT.
SocksProxyConfig(String sHost, int nPort) Create a SOCKS proxy config object based on the given port.

Method Summary

Modifier and Type	Method and Description
void	activateGlobally() Activate this proxy configuration.
static void	deactivateGlobally()
boolean	equals(Object o)
Proxy	getAsProxy()
String	getHost()
int	getPort()
String	getProxyHost()
String	getProxyPort()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SYSPROP_SOCKS_PROXY_HOST

public static final String SYSPROP_SOCKS_PROXY_HOST

See Also:

Constant Field Values

SYSPROP_SOCKS_PROXY_PORT

public static final String SYSPROP_SOCKS_PROXY_PORT

See Also:

Constant Field Values

DEFAULT_SOCKS_PROXY_PORT

public static final int DEFAULT_SOCKS_PROXY_PORT

See Also:

Constant Field Values

Constructor Detail

SocksProxyConfig

public SocksProxyConfig(@Nonnull
                        String sHost)

Create a SOCKS proxy config object based on the default port DEFAULT_SOCKS_PROXY_PORT.

Parameters:

sHost - The SOCKS proxy host. May not be null.

SocksProxyConfig

public SocksProxyConfig(@Nonnull
                        String sHost,
                        @Nonnegative
                        int nPort)

Create a SOCKS proxy config object based on the given port.

Parameters:

sHost - The SOCKS proxy host. May not be null.

nPort - The port to use for communication. Must be ≥ 0.

Method Detail

getHost

@Nonnull
public String getHost()

getPort

@Nonnegative
public int getPort()

getProxyHost

@Nullable
public String getProxyHost()

Returns:

The current proxy host for SOCKS proxy type. May be null.

getProxyPort

@Nullable
public String getProxyPort()

Returns:

The current proxy port for SOCKS proxy type. May be null.

activateGlobally

public void activateGlobally()

Description copied from interface: IProxyConfig

Activate this proxy configuration.

Specified by:

activateGlobally in interface IProxyConfig

deactivateGlobally

public static void deactivateGlobally()

getAsProxy

@Nonnull
public Proxy getAsProxy()

Specified by:

getAsProxy in interface IProxyConfig

Returns:

This proxy configuration as standard Proxy object. May be null if no adequate object can be created.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object