Skip navigation links

HTTPClient
Class HttpClientConfiguration

java.lang.Object
HTTPClient.HttpClientConfiguration

All Implemented Interfaces:

SystemPropertyNames

public class HttpClientConfiguration

extends java.lang.Object

implements SystemPropertyNames

This class is a placeholder for all of the system properties that HTTPClient currently supports. Accessors and Modifiers will be added for each property, to make configuration more dynamic. Each property represented in this class is on a per-VM basis, and will affect every instance of HTTPConnection created.

Field Summary

Fields inherited from interface HTTPClient.SystemPropertyNames

AUTHENTICATION_SCHEME_SYSTEM_PROPERTY_NAMESPACE, HTTP_CLIENT_SYSTEM_PROPERTY_NAMESPACE, NTLM_SYSTEM_PROPERTY_NAMESPACE, SYSPROP_DEFAULT_HOSTNAME_VERIFIER, SYSPROP_DEFAULT_NTLM_DOMAIN_NAME, SYSPROP_PREFER_ORACLE_SSL

Method Summary

static NVPair[]	getAuthenticationSchemes() Determines the runtime-declared authentication schemes.
static java.lang.String	getDefaultHostnameVerifier() Determines the default HostnameVerifier implementation class name.
static java.lang.String	getDefaultNtlmDomainName() Determines the default NT user domain name for NTLM authentication.
static boolean	getDeferStreamed() Deferring the handling of responses to requests which used an output stream.
static boolean	getForceHTTP1_0() Returns a flag that determines if HTTPClient is sending requests exclusively in HTTP/1.0 mode.
static boolean	getInOneTwo() Returns the JDK status.
static int	getMaxAuthTries() Get the maximum authorization retries count
static boolean	getNagleAlgorithmEnabled() Returns the flag the determines the enabled status of the Nagle Algorithm.
static boolean	getNeverPipeline() Returns the pipelineing configuration of HTTPClient.
static boolean	getNoChunkingFlag() Returns the no chunking flag.
static boolean	getNoKeepAlives() Returns the flag that determines if HTTPClient uses keep-alive connections.
static java.lang.String[]	getNonProxyHosts() Returns the list of servers that HTTPClient will not proxy for.
static java.lang.String	getProxyHost() Returns the host name of the proxy server.
static int	getProxyPort() Returns the proxy port of the proxy server.
static int	getSocketIdleTimeout() Returns the time (in seconds) before an idle socket will be closed.
static java.lang.String	getSocksHost() Returns the name of the SOCKS host.
static int	getSocksPort() Returns the port number of the socks host.
static int	getSocksVersion() Returns the version of SOCKS being used.
static java.lang.String	getVersion() Returns the version of HTTPClient being used.
static boolean	isPreferOracleSsl() Determines the current preference for using the Oracle SSL library over JSSE.
static void	readConfigurationProperties() HttpClient system property configuration is read in using the currently documented system properties.
static void	setDefaults()
static void	setSocketIdleTime(int idleTimeout) Sets the socket idle timeout to be used in subsequent HTTPConnection instances.
static java.util.Vector	setupDefaultModuleList() Sets up the default module list by first trying the value of the system property HTTPClient.Modules.

Methods inherited from class java.lang.Object

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

Method Detail

setDefaults

public static void setDefaults()

readConfigurationProperties

public static void readConfigurationProperties()

HttpClient system property configuration is read in using the currently documented system properties. This method also looks for HTTPClient.log.level system property, which is provided as a convenience for the developer who wants to override the logging.properties file for ease of use. If this system property is set, the level specified will override the settings in the logging.properties file. If this property if not set, then the standard logging.properties settings apply. HTTPClient uses only the log levels specified in the JDK. The following list explains how the JDK logging levels correspond to HTTPClient events and logging: WARNING - HTTPClient logs exceptions and errors at this level INFO - HTTPClient does not log any statements to the INFO level CONFIG - System properties and configuration information are logged at this level FINE - Request/Response headers logged at this level FINER - Detailed connection management/socket management/response handling/URLConnection handling FINEST - Module handling code (cookie mgmt, authorization, retry, redirection, etc) ALL - Everything logged in HTTPClient is visible at this level.

getNoChunkingFlag

public static boolean getNoChunkingFlag()

Returns the no chunking flag. Chunked transfer encoding is disabled if true, or enabled if false.

Returns:

the value of the no chunking flag

getVersion

public static java.lang.String getVersion()

Returns the version of HTTPClient being used.

Returns:

the HTTPClient version number

getNoKeepAlives

public static boolean getNoKeepAlives()

Returns the flag that determines if HTTPClient uses keep-alive connections. Keep-alive is disabled if this returns true, and enabled if this flag is false.

Returns:

the value of the no keep-alives flag

getForceHTTP1_0

public static boolean getForceHTTP1_0()

Returns a flag that determines if HTTPClient is sending requests exclusively in HTTP/1.0 mode. HTTPClient will send only HTTP/1.0 requests if enabled, or will try to use HTTP/1.1 first if this flag is false.

Returns:

the value of the force HTTP/1.0 flag

getNeverPipeline

public static boolean getNeverPipeline()

Returns the pipelineing configuration of HTTPClient. If this flag is true, HTTPClient will not attempt to pipeline requests. If this flag is false, HTTPClient will try to pipeline where appropriate.

Returns:

the value of the Never Pipeline flag.

getDeferStreamed

public static boolean getDeferStreamed()

Deferring the handling of responses to requests which used an output stream. Returns the deferStreamed flag. If false, then HTTPClient will not resend requests that used an HttpOutputStream.

Returns:

the value of the deferStreamedFlag.

getNagleAlgorithmEnabled

public static boolean getNagleAlgorithmEnabled()

Returns the flag the determines the enabled status of the Nagle Algorithm. If this method returns true, then the Nagle algorithm is used for socket connections. If this method returns false, then the Nagle algorithm is disabled for socket connections.

Returns:

the value of the enableNagleAlgorithm flag

getInOneTwo

public static boolean getInOneTwo()

Returns the JDK status. If true, then HTTPClient is running in JDK 1.2.

Returns:

the value of the JDK 1.2 flag

getProxyHost

public static java.lang.String getProxyHost()

Returns the host name of the proxy server.

Returns:

the host name of the proxy server.

getProxyPort

public static int getProxyPort()

Returns the proxy port of the proxy server.

Returns:

the port number of the proxy server

getNonProxyHosts

public static java.lang.String[] getNonProxyHosts()

Returns the list of servers that HTTPClient will not proxy for.

Returns:

an array of server names that HTTPClient will not proxy for.

getSocksHost

public static java.lang.String getSocksHost()

Returns the name of the SOCKS host.

Returns:

the name of the SOCKS host.

getDefaultNtlmDomainName

public static java.lang.String getDefaultNtlmDomainName()

Determines the default NT user domain name for NTLM authentication.

Returns:

The default NT user domain name for NTLM authentication.

getDefaultHostnameVerifier

public static java.lang.String getDefaultHostnameVerifier()

Determines the default HostnameVerifier implementation class name.

Returns:

The default HostnameVerifier implementation class name.

isPreferOracleSsl

public static boolean isPreferOracleSsl()

Determines the current preference for using the Oracle SSL library over JSSE.

Returns:

true to prefer using the Oracle SSL library over JSSE.

getAuthenticationSchemes

public static NVPair[] getAuthenticationSchemes()

Determines the runtime-declared authentication schemes.

Each name-value pair comprises the scheme name (name) mapped to the AuthenticationScheme implementation class name (value).

The returned array is appropriate for use by AuthenticationSchemeRegistry.loadSchemes().

Returns:

The runtime-declared authentication schemes.

getSocksPort

public static int getSocksPort()

Returns the port number of the socks host.

Returns:

the port number of the socks host.

getSocksVersion

public static int getSocksVersion()

Returns the version of SOCKS being used.

Returns:

the version of SOCKS being used.

getSocketIdleTimeout

public static int getSocketIdleTimeout()

Returns the time (in seconds) before an idle socket will be closed.

Returns:

the time (in seconds) before an idle socket will be closed.

setSocketIdleTime

public static void setSocketIdleTime(int idleTimeout)

Sets the socket idle timeout to be used in subsequent HTTPConnection instances. This setting only affects new connections. Existing connections continue to use the timeout value set when the connection was created. Unit is seconds.

Parameters:

idleTimeout -

getMaxAuthTries

public static int getMaxAuthTries()

Get the maximum authorization retries count

Returns:

int, the marimum authorization count.If HTTPClient.authorization.MaxRetry system property is not set, returns the default value of 4

setupDefaultModuleList

public static java.util.Vector setupDefaultModuleList()

Sets up the default module list by first trying the value of the system property HTTPClient.Modules.

Returns:

a Vector of HTTPClient.HTTPClientModule's.

Skip navigation links