de.larssh.utils.net

Class GlobalProxyConfiguration

java.lang.Object

de.larssh.utils.net.GlobalProxyConfiguration

public class GlobalProxyConfiguration
extends Object

Proxy related properties, described at Network Properties.

Usage example 1: The following shows how to set a global HTTP proxy.

 InetSocketAddress inetSocketAddress = new InetSocketAddress("proxy.example.com", "8080");
 GlobalProxyConfiguration.HTTP.setGlobalProxy(inetSocketAddress);
 

Usage example 2: The following shows how to unset the global HTTP proxy.

 GlobalProxyConfiguration.HTTP.unsetGlobalProxy();
 

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalProxyConfiguration	FTP FTP proxy related settings
static GlobalProxyConfiguration	HTTP HTTP proxy related settings
static GlobalProxyConfiguration	HTTPS HTTPS proxy related settings The HTTPS protocol handler will use the same nonProxyHosts property as the HTTP protocol.
static GlobalProxyConfiguration	SOCKS SOCKS proxy related properties The SOCKS protocol handler does not support the nonProxyHosts property.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GlobalProxyConfiguration(String name, Proxy.Type type, int defaultPort, String hostProperty, String portProperty, Optional<String> nonProxyHostsProperty, Optional<Collection<String>> defaultNonProxyHosts) Creates a new GlobalProxyConfiguration instance.

Method Summary

Modifier and Type	Method and Description
void	addNonProxyHosts(String... nonProxyHosts) Appends all of nonProxyHosts to the current protocols nonProxyHosts property if it is not already present.
Optional<Collection<String>>	getDefaultNonProxyHosts() Default nonProxyHosts
int	getDefaultPort() Default proxy port
String	getHostProperty() Host property name
String	getName() Name
Set<String>	getNonProxyHosts() Returns all patterns of the current protocols nonProxyHosts property.
Optional<String>	getNonProxyHostsProperty() nonProxyHosts property name
protected String	getNonProxyHostsPropertyOrThrow() Returns the current protocols nonProxyHosts property name.
String	getPortProperty() Port property name
Proxy.Type	getType() Proxy type
void	removeNonProxyHosts(String... nonProxyHosts) Removes all given patterns from the current protocols nonProxyHosts property.
void	resetNonProxyHosts() Resets the current protocols nonProxyHosts property.
void	setGlobalProxy(InetSocketAddress inetSocketAddress) Overwrites the JVM global current protocols proxy properties with the given host and port.
void	setNonProxyHosts(Collection<String> nonProxyHosts) Overwrites the current protocols nonProxyHosts property with the given patterns.
void	unsetGlobalProxy() Overwrites the JVM global current protocols proxy properties.

Methods inherited from class java.lang.Object

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

Field Detail

FTP

public static final GlobalProxyConfiguration FTP

FTP proxy related settings

HTTP

public static final GlobalProxyConfiguration HTTP

HTTP proxy related settings

HTTPS

public static final GlobalProxyConfiguration HTTPS

HTTPS proxy related settings

The HTTPS protocol handler will use the same nonProxyHosts property as the HTTP protocol. Use HTTP to modify that property.

SOCKS

public static final GlobalProxyConfiguration SOCKS

SOCKS proxy related properties

The SOCKS protocol handler does not support the nonProxyHosts property.

Constructor Detail

GlobalProxyConfiguration

protected GlobalProxyConfiguration(String name,
                                   Proxy.Type type,
                                   int defaultPort,
                                   String hostProperty,
                                   String portProperty,
                                   Optional<String> nonProxyHostsProperty,
                                   Optional<Collection<String>> defaultNonProxyHosts)

Creates a new GlobalProxyConfiguration instance.

Parameters:

name - Name

type - Proxy type

defaultPort - Default proxy port

hostProperty - Host property name

portProperty - Port property name

nonProxyHostsProperty - nonProxyHosts property name

defaultNonProxyHosts - Default nonProxyHosts

Method Detail

addNonProxyHosts

public void addNonProxyHosts(String... nonProxyHosts)

Appends all of nonProxyHosts to the current protocols nonProxyHosts property if it is not already present.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Parameters:

nonProxyHosts - any number of hosts that should be accessed without going through the proxy

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

getNonProxyHosts

public Set<String> getNonProxyHosts()

Returns all patterns of the current protocols nonProxyHosts property.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Returns:

patterns of the current protocols nonProxyHosts property

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

getNonProxyHostsPropertyOrThrow

protected String getNonProxyHostsPropertyOrThrow()

Returns the current protocols nonProxyHosts property name.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Returns:

the current protocols nonProxyHosts property name

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

removeNonProxyHosts

public void removeNonProxyHosts(String... nonProxyHosts)

Removes all given patterns from the current protocols nonProxyHosts property.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Parameters:

nonProxyHosts - any number of hosts that should not be accessed with going through the proxy

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

resetNonProxyHosts

public void resetNonProxyHosts()

Resets the current protocols nonProxyHosts property.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Afterwards nothing but the default nonProxyHosts are set.

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

setGlobalProxy

public void setGlobalProxy(InetSocketAddress inetSocketAddress)

Overwrites the JVM global current protocols proxy properties with the given host and port.

Parameters:

inetSocketAddress - host and port to apply globally

setNonProxyHosts

public void setNonProxyHosts(Collection<String> nonProxyHosts)

Overwrites the current protocols nonProxyHosts property with the given patterns.

For protocols not supporting the nonProxyHosts property an UnsupportedOperationException is thrown.

Parameters:

nonProxyHosts - any number of hosts that should be accessed without going through the proxy

Throws:

UnsupportedOperationException - for protocols not supporting the nonProxyHosts property

unsetGlobalProxy

public void unsetGlobalProxy()

Overwrites the JVM global current protocols proxy properties.

getName

public String getName()

Name

Returns:

name

getType

public Proxy.Type getType()

Proxy type

Returns:

proxy type

getDefaultPort

public int getDefaultPort()

Default proxy port

Returns:

default proxy port

getHostProperty

public String getHostProperty()

Host property name

Returns:

host property name

getPortProperty

public String getPortProperty()

Port property name

Returns:

port property name

getNonProxyHostsProperty

public Optional<String> getNonProxyHostsProperty()

nonProxyHosts property name

Returns:

nonProxyHosts property name

getDefaultNonProxyHosts

public Optional<Collection<String>> getDefaultNonProxyHosts()

Default nonProxyHosts

Returns:

default nonProxyHosts