org.dataone.client.utils

Class HttpUtils

java.lang.Object

org.dataone.client.utils.HttpUtils

public class HttpUtils
extends Object

A utility class to simplify creation and configuration of HttpClients. In an effort to conform to HTTP/1.1, a PoolingConnectionManager is used, and the number of parallel connections per server is adjusted to conform to current browser norms.

Author:

rnahf

See Also:

http://www.browserscope.org/?category=network,


Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_MAX_ENTRIES
static int	CACHE_MAX_OBJECT_SIZE
static long	DEFAULT_KEEP_ALIVE_SECONDS
static int	MAX_CONNECTIONS The maximum number of connections allowed in total by the HttpClient
static int	MAX_CONNECTIONS_PER_ROUTE The number of parallel connections allowed per route / server Use caution resetting this one: more is not better:
static boolean	MONITOR_STALE_CONNECTIONS
static String	SCHEME_NAME
static boolean	USE_CACHING_CLIENT

Constructor Summary

Constructors

Constructor and Description
HttpUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	buildConnectionRegistry()
static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	buildConnectionRegistry(X509Session x509Session)
static org.apache.http.conn.ConnectionKeepAliveStrategy	buildD1KeepAliveStrategy(long defaultKeepAliveTimeout) Builds a custom keep-alive strategy that uses the defaultKeepAliveTimeout value if one not returned in the response headers.
static org.apache.http.client.HttpClient	createHttpClient(String authToken) Creates an HttpClient configured with the authorization token credentials.
static org.apache.http.client.HttpClient	createHttpClient(X509Session x509session) Creates an HttpClient configured with the X509 credentials.
static org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder(String authToken) Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified.
static org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder(String authToken, Boolean monitorStaleConnections) Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified.
static org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder(X509Session x509session) Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified.
static org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder(X509Session x509session, Boolean monitorStaleConnections) Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified.
static X509Session	selectSession(String subjectString)
static void	setupSSL_v4_1(org.apache.http.impl.client.AbstractHttpClient httpClient, X509Session x509Session) Provided to assist with backwards compatibility with v4.1.x era DefaultHttpClient (now deprecated).

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_NAME

public static final String SCHEME_NAME

See Also:

Constant Field Values

MONITOR_STALE_CONNECTIONS

public static final boolean MONITOR_STALE_CONNECTIONS

MAX_CONNECTIONS

public static final int MAX_CONNECTIONS

The maximum number of connections allowed in total by the HttpClient

MAX_CONNECTIONS_PER_ROUTE

public static final int MAX_CONNECTIONS_PER_ROUTE

The number of parallel connections allowed per route / server Use caution resetting this one: more is not better:

See Also:

https://redmine.dataone.org/issues/7463#note-1

DEFAULT_KEEP_ALIVE_SECONDS

public static final long DEFAULT_KEEP_ALIVE_SECONDS

USE_CACHING_CLIENT

public static final boolean USE_CACHING_CLIENT

CACHE_MAX_ENTRIES

public static final int CACHE_MAX_ENTRIES

CACHE_MAX_OBJECT_SIZE

public static final int CACHE_MAX_OBJECT_SIZE

Constructor Detail

HttpUtils

public HttpUtils()

Method Detail

setupSSL_v4_1

public static void setupSSL_v4_1(org.apache.http.impl.client.AbstractHttpClient httpClient,
                                 X509Session x509Session)

Provided to assist with backwards compatibility with v4.1.x era DefaultHttpClient (now deprecated). d1_libclient_java v1.x used this method to set up SSL after creating the DefaultHttpClient, so should be used if you are working with the deprecated DefaultHttpClients.

With the current CertificateManager implementation, a null value for the session object causes the certificate at the default location to be used. If the certificate is not found, a warning will be logged and SSL scheme setup will continue.

Parameters:

session -

createHttpClient

public static org.apache.http.client.HttpClient createHttpClient(X509Session x509session)
                                                          throws UnrecoverableKeyException,
                                                                 KeyManagementException,
                                                                 NoSuchAlgorithmException,
                                                                 KeyStoreException,
                                                                 CertificateException,
                                                                 InstantiationException,
                                                                 IllegalAccessException,
                                                                 IOException,
                                                                 MarshallingException

Creates an HttpClient configured with the X509 credentials.

Parameters:

x509session - - - the configuration object containing the X509 client certificate used for the connections

Returns:

Throws:

UnrecoverableKeyException

KeyManagementException

NoSuchAlgorithmException

KeyStoreException

CertificateException

InstantiationException

IllegalAccessException

IOException

MarshallingException

getHttpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder(X509Session x509session)
                                                                          throws UnrecoverableKeyException,
                                                                                 KeyManagementException,
                                                                                 NoSuchAlgorithmException,
                                                                                 KeyStoreException,
                                                                                 CertificateException,
                                                                                 InstantiationException,
                                                                                 IllegalAccessException,
                                                                                 IOException,
                                                                                 MarshallingException

Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified. Users would further customize with additional builder methods.

Parameters:

x509session - - the configuration object containing the X509 client certificate used for the connections

Returns:

- a session-configured HttpClientBuilder

Throws:

UnrecoverableKeyException

KeyManagementException

NoSuchAlgorithmException

KeyStoreException

CertificateException

InstantiationException

IllegalAccessException

IOException

MarshallingException

getHttpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder(X509Session x509session,
                                                                                 Boolean monitorStaleConnections)
                                                                          throws UnrecoverableKeyException,
                                                                                 KeyManagementException,
                                                                                 NoSuchAlgorithmException,
                                                                                 KeyStoreException,
                                                                                 CertificateException,
                                                                                 InstantiationException,
                                                                                 IllegalAccessException,
                                                                                 IOException,
                                                                                 MarshallingException

Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified. Users would further customize with additional builder methods.

Parameters:

x509session - - the configuration object containing the X509 client certificate used for the connections

monitorStaleConnections - - if not null chooses whether or not to monitorStaleConnections, otherwise uses the default setting determined from D1Client.http.monitorStaleConnections

Returns:

- a session-configured HttpClientBuilder

Throws:

UnrecoverableKeyException

KeyManagementException

NoSuchAlgorithmException

KeyStoreException

CertificateException

InstantiationException

IllegalAccessException

IOException

MarshallingException

createHttpClient

public static org.apache.http.client.HttpClient createHttpClient(String authToken)

Creates an HttpClient configured with the authorization token credentials.

Parameters:

authToken - - the configuration object containing the authorization token string used for the connections

Returns:

getHttpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder(String authToken)

Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified. Users would further customize with additional builder methods.

Parameters:

authToken - - the configuration object containing the authorization token string used for the connections

Returns:

getHttpClientBuilder

public static org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder(String authToken,
                                                                                 Boolean monitorStaleConnections)

Returns an HttpClientBuilder with the DataONE-standard ConnectionManager configuration specified. Users would further customize with additional builder methods.

Parameters:

authToken - - the configuration object containing the authorization token string used for the connections

monitorStaleConnections - - if not null, choose whether to monitor stale connections, otherwise use the configured default in D1Client.http.monitorStaleConnections

Returns:

selectSession

public static X509Session selectSession(String subjectString)
                                 throws IOException

Throws:

IOException

buildConnectionRegistry

public static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> buildConnectionRegistry(X509Session x509Session)
                                                                                                                    throws UnrecoverableKeyException,
                                                                                                                           KeyManagementException,
                                                                                                                           NoSuchAlgorithmException,
                                                                                                                           KeyStoreException,
                                                                                                                           CertificateException,
                                                                                                                           IOException

Throws:

UnrecoverableKeyException

KeyManagementException

NoSuchAlgorithmException

KeyStoreException

CertificateException

IOException

buildConnectionRegistry

public static org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> buildConnectionRegistry()

buildD1KeepAliveStrategy

public static org.apache.http.conn.ConnectionKeepAliveStrategy buildD1KeepAliveStrategy(long defaultKeepAliveTimeout)

Builds a custom keep-alive strategy that uses the defaultKeepAliveTimeout value if one not returned in the response headers. (This allows us to expire idle connections).

Parameters:

defaultKeepAliveTimeout - - number of seconds (to match units of the keep-alive timeout header)

Returns: