Module org.shredzone.acme4j

Package org.shredzone.acme4j.connector

Class NetworkSettings

java.lang.Object

org.shredzone.acme4j.connector.NetworkSettings

public class NetworkSettings
extends Object

Contains network settings to be used for network connections.

Since:

2.8

Field Summary

Fields

Modifier and Type	Field	Description
static String	GZIP_PROPERTY_NAME	Name of the system property to control GZIP compression.

Constructor Summary

Constructors

Constructor	Description
NetworkSettings()

Method Summary

Modifier and Type	Method	Description
Authenticator	getAuthenticator()	Gets the Authenticator to be used, or null if none is to be set.
ProxySelector	getProxySelector()	Gets the ProxySelector to be used for connections.
Duration	getTimeout()	Gets the current network timeout.
boolean	isCompressionEnabled()	Checks if HTTP compression is enabled.
void	setAuthenticator(Authenticator authenticator)	Sets an Authenticator to be used if HTTP authentication is needed (e.g.
void	setCompressionEnabled(boolean compression)	Sets if HTTP compression is enabled.
void	setProxySelector(ProxySelector proxySelector)	Sets a ProxySelector that is to be used for all connections.
void	setTimeout(Duration timeout)	Sets the network timeout to be used for connections.

Methods inherited from class java.lang.Object

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

Field Detail

GZIP_PROPERTY_NAME

public static final String GZIP_PROPERTY_NAME

Name of the system property to control GZIP compression. Expects a boolean value.

See Also:

Constant Field Values

Constructor Detail

NetworkSettings

public NetworkSettings()

Method Detail

getProxySelector

public ProxySelector getProxySelector()

Gets the ProxySelector to be used for connections.

Since:

3.0.0

setProxySelector

public void setProxySelector(@Nullable
                             ProxySelector proxySelector)

Sets a ProxySelector that is to be used for all connections. If null, HttpClient.Builder.NO_PROXY is used, which is also the default.

Since:

3.0.0

getAuthenticator

@Nullable
public Authenticator getAuthenticator()

Gets the Authenticator to be used, or null if none is to be set.

Since:

3.0.0

setAuthenticator

public void setAuthenticator(@Nullable
                             Authenticator authenticator)

Sets an Authenticator to be used if HTTP authentication is needed (e.g. by a proxy). null means that no authenticator shall be set.

Since:

3.0.0

getTimeout

public Duration getTimeout()

Gets the current network timeout.

setTimeout

public void setTimeout(Duration timeout)

Sets the network timeout to be used for connections. Defaults to 10 seconds.

Parameters:

timeout - Network timeout Duration

isCompressionEnabled

public boolean isCompressionEnabled()

Checks if HTTP compression is enabled.

Since:

3.0.0

setCompressionEnabled

public void setCompressionEnabled(boolean compression)

Sets if HTTP compression is enabled. It is enabled by default, but can be disabled e.g. for debugging purposes.

acme4j gzip compression can also be controlled via the "org.shredzone.acme4j.gzip_compression" system property.

Since:

3.0.0