pt.lsts.neptus.util.http.client

Class HttpClientConnectionHelper

java.lang.Object

pt.lsts.neptus.util.http.client.HttpClientConnectionHelper

public class HttpClientConnectionHelper
extends java.lang.Object

This helper class encapsulates the use of Apache's HttpComponents. It uses a CloseableHttpClient and PoolingHttpClientConnectionManager. Additionally it allows the use of proxy connection with the call of ProxyInfoProvider. To start the comms. call initializeComm() and at the end cleanUp() to close the comms.

Author:

pdias

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECTION_TIMEOUT
static int	DEFAULT_MAX_CONNECTIONS_PER_ROUTE
static int	MAX_TOTAL_CONNECTIONS

Constructor Summary

Constructors

Constructor and Description
HttpClientConnectionHelper()
HttpClientConnectionHelper(int maxTotalConnections, int defaultMaxConnectionsPerRoute, int connectionTimeout, boolean initializeProxyRoutePlanner)
HttpClientConnectionHelper(int maxTotalConnections, int defaultMaxConnectionsPerRoute, int connectionTimeout, boolean initializeProxyRoutePlanner, java.lang.String userAgent)
HttpClientConnectionHelper(java.lang.String userAgent)

Method Summary

Modifier and Type	Method and Description
void	autenticateProxyIfNeeded(org.apache.http.HttpResponse iGetResultCode)
void	autenticateProxyIfNeeded(org.apache.http.HttpResponse iGetResultCode, org.apache.http.client.protocol.HttpClientContext localContext) Call this after calling client.execute in order to execute proxy authentication if needed.
void	cleanUp() This has to be called to cleanup.
org.apache.http.impl.client.CloseableHttpClient	getClient()
int	getConnectionTimeout()
int	getDefaultMaxConnectionsPerRoute()
org.apache.http.impl.conn.PoolingHttpClientConnectionManager	getHttpConnectionManager()
int	getMaxTotalConnections()
void	initializeComm() Call this to initialize the comms.
boolean	isInitializeProxyRoutePlanner()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TOTAL_CONNECTIONS

public static final int MAX_TOTAL_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MAX_CONNECTIONS_PER_ROUTE

public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE

See Also:

Constant Field Values

CONNECTION_TIMEOUT

public static final int CONNECTION_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

HttpClientConnectionHelper

public HttpClientConnectionHelper()

HttpClientConnectionHelper

public HttpClientConnectionHelper(java.lang.String userAgent)

HttpClientConnectionHelper

public HttpClientConnectionHelper(int maxTotalConnections,
                                  int defaultMaxConnectionsPerRoute,
                                  int connectionTimeout,
                                  boolean initializeProxyRoutePlanner,
                                  java.lang.String userAgent)

HttpClientConnectionHelper

public HttpClientConnectionHelper(int maxTotalConnections,
                                  int defaultMaxConnectionsPerRoute,
                                  int connectionTimeout,
                                  boolean initializeProxyRoutePlanner)

Parameters:

maxTotalConnections -

defaultMaxConnectionsPerRoute -

connectionTimeout -

initializeProxyRoutePlanner -

Method Detail

initializeComm

public void initializeComm()

Call this to initialize the comms.

cleanUp

public void cleanUp()

This has to be called to cleanup. After calling this no more connections are feasible.

getClient

public org.apache.http.impl.client.CloseableHttpClient getClient()

Returns:

the client

getHttpConnectionManager

public org.apache.http.impl.conn.PoolingHttpClientConnectionManager getHttpConnectionManager()

Returns:

the httpConnectionManager

getMaxTotalConnections

public int getMaxTotalConnections()

Returns:

the maxTotalConnections

getDefaultMaxConnectionsPerRoute

public int getDefaultMaxConnectionsPerRoute()

Returns:

the defaultMaxConnectionsPerRoute

getConnectionTimeout

public int getConnectionTimeout()

Returns:

the connectionTimeout

isInitializeProxyRoutePlanner

public boolean isInitializeProxyRoutePlanner()

Returns:

the initializeProxyRoutePlanner

autenticateProxyIfNeeded

public void autenticateProxyIfNeeded(org.apache.http.HttpResponse iGetResultCode)

autenticateProxyIfNeeded

public void autenticateProxyIfNeeded(org.apache.http.HttpResponse iGetResultCode,
                                     org.apache.http.client.protocol.HttpClientContext localContext)

Call this after calling client.execute in order to execute proxy authentication if needed.

Parameters:

iGetResultCode -

localContext -