com.helger.network.proxy.settings

Class ProxySettings

java.lang.Object

com.helger.network.proxy.settings.ProxySettings

All Implemented Interfaces:

IProxySettings, Serializable

@Immutable
public final class ProxySettings
extends Object
implements IProxySettings

Immutable default implementation of IProxySettings

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProxySettings(Proxy.Type eProxyType, String sProxyHost, int nProxyPort)
ProxySettings(Proxy.Type eProxyType, String sProxyHost, int nProxyPort, String sProxyUserName, String sProxyPassword)

Method Summary

Modifier and Type	Method and Description
static ProxySettings	createNoProxySettings()
boolean	equals(Object o)
Proxy	getAsProxy(boolean bResolveHostname)
String	getProxyHost()
String	getProxyPassword()
int	getProxyPort()
Proxy.Type	getProxyType()
String	getProxyUserName()
int	hashCode()
boolean	hasSocketAddress(SocketAddress aAddr) Check if these settings have the provided socket address.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.network.proxy.settings.IProxySettings

getAsPasswordAuthentication, getAsProxy, hasInetSocketAddress, hasProxyPassword, hasProxyUserName

Constructor Detail

ProxySettings

public ProxySettings(@Nonnull
                     Proxy.Type eProxyType,
                     @Nullable
                     String sProxyHost,
                     @Nonnegative
                     int nProxyPort)

ProxySettings

public ProxySettings(@Nonnull
                     Proxy.Type eProxyType,
                     @Nullable
                     String sProxyHost,
                     @Nonnegative
                     int nProxyPort,
                     @Nullable
                     String sProxyUserName,
                     @Nullable
                     String sProxyPassword)

Method Detail

getProxyType

@Nonnull
public Proxy.Type getProxyType()

Specified by:

getProxyType in interface IProxySettings

Returns:

The proxy type to be used. May not be null.

getProxyHost

@Nullable
public String getProxyHost()

Specified by:

getProxyHost in interface IProxySettings

Returns:

The proxy host name of IP address. May be null if proxy type is DIRECT.

getProxyPort

@Nonnegative
public int getProxyPort()

Specified by:

getProxyPort in interface IProxySettings

Returns:

The proxy port for this HTTP proxy type. Should be > 0. May be ≤ 0 if the proxy type is DIRECT.

getProxyUserName

@Nullable
public String getProxyUserName()

Specified by:

getProxyUserName in interface IProxySettings

Returns:

The proxy user name. May be null.

getProxyPassword

@Nullable
public String getProxyPassword()

Specified by:

getProxyPassword in interface IProxySettings

Returns:

The proxy password for the provided user. May be null. Note: an empty password may be valid. Only null indicates "no password".

hasSocketAddress

public boolean hasSocketAddress(@Nullable
                                SocketAddress aAddr)

Description copied from interface: IProxySettings

Check if these settings have the provided socket address.

Specified by:

hasSocketAddress in interface IProxySettings

Parameters:

aAddr - The socket address to compare to. May be null.

Returns:

true if the proxy type is DIRECT and the address is null, or if the object is of type InetSocketAddress and the values match.

See Also:

IProxySettings.hasInetSocketAddress(InetSocketAddress)

getAsProxy

@Nonnull
public Proxy getAsProxy(boolean bResolveHostname)

Specified by:

getAsProxy in interface IProxySettings

Parameters:

bResolveHostname - true to resolve host names (needed in production) or false to not resolve them (mainly for testing purposes). This flag has no impact if the proxy type is DIRECT.

Returns:

A non-null Proxy instance. Only uses proxy host and port.

See Also:

IProxySettings.getProxyHost(), IProxySettings.getProxyPort()

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

createNoProxySettings

@Nonnull
 @ReturnsMutableCopy
public static ProxySettings createNoProxySettings()