com.helger.network.proxy.settings

Interface IProxySettings

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProxySettings

public interface IProxySettings
extends Serializable

Generic proxy settings interface.

Since:

9.1.3

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default PasswordAuthentication	getAsPasswordAuthentication()
default Proxy	getAsProxy()
Proxy	getAsProxy(boolean bResolveHostname)
String	getProxyHost()
String	getProxyPassword()
int	getProxyPort()
Proxy.Type	getProxyType()
String	getProxyUserName()
default boolean	hasInetSocketAddress(InetSocketAddress aAddr) Check if hostname and port match the ones from the provided InetSocketAddress.
default boolean	hasProxyPassword()
default boolean	hasProxyUserName()
boolean	hasSocketAddress(SocketAddress aAddr) Check if these settings have the provided socket address.

Method Detail

getProxyType

@Nonnull
Proxy.Type getProxyType()

Returns:

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

getProxyHost

@Nullable
String getProxyHost()

Returns:

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

getProxyPort

int getProxyPort()

Returns:

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

getProxyUserName

@Nullable
String getProxyUserName()

Returns:

The proxy user name. May be null.

hasProxyUserName

default boolean hasProxyUserName()

getProxyPassword

@Nullable
String getProxyPassword()

Returns:

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

hasProxyPassword

default boolean hasProxyPassword()

hasInetSocketAddress

default boolean hasInetSocketAddress(@Nullable
                                     InetSocketAddress aAddr)

Check if hostname and port match the ones from the provided InetSocketAddress.

Parameters:

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

Returns:

true if the unresolved hostname and the port match.

hasSocketAddress

boolean hasSocketAddress(@Nullable
                         SocketAddress aAddr)

Check if these settings have the provided socket address.

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:

hasInetSocketAddress(InetSocketAddress)

getAsProxy

@Nonnull
default Proxy getAsProxy()

Returns:

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

See Also:

getProxyHost(), getProxyPort()

getAsProxy

@Nonnull
Proxy getAsProxy(boolean bResolveHostname)

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:

getProxyHost(), getProxyPort()

getAsPasswordAuthentication

@Nullable
default PasswordAuthentication getAsPasswordAuthentication()

Returns:

The PasswordAuthentication instances matching the credentials contained in this object or null if no username is present.