com.att.nsa.apiClient.http

Class HttpClient

java.lang.Object

com.att.nsa.apiClient.http.HttpClient

@NotThreadSafe
public class HttpClient
extends Object

A client for typical server interaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClient.ConnectionType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	kDefault_PoolMaxInTotal
protected static int	kDefault_PoolMaxPerRoute
static int	kDefault_SocketTimeoutMs

Constructor Summary

Constructors

Constructor and Description
HttpClient(HttpClient.ConnectionType ct, Collection<String> cluster, int stdSvcPort) Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port.
HttpClient(HttpClient.ConnectionType ct, Collection<String> cluster, int stdSvcPort, String clientSignature) Construct an HTTP client for a given cluster with a standard service port to use when the hosts don't specify a port and a client signature that identifies this client across runs.
HttpClient(HttpClient.ConnectionType ct, Collection<String> cluster, int stdSvcPort, String clientSignature, CacheUse defCacheUse, int maxObjCacheSize, long maxObjCacheTime, TimeUnit maxObjCacheTimeUnit) Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port.
HttpClient(HttpClient.ConnectionType ct, Collection<String> cluster, int stdSvcPort, String clientSignature, CacheUse defCacheUse, int maxObjCacheSize, long maxObjCacheTime, TimeUnit maxObjCacheTimeUnit, int maxPoolSize, int maxPoolPerRoute, int soTimeoutMs) Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port.

Method Summary

Modifier and Type	Method and Description
void	clearApiCredentials() Create the API credentials so that any following transactions do not authenticate.
void	clearHttpBasicCredentials() Clear the HTTP basic auth credentials for the transaction.
void	delete(String path)
org.json.JSONObject	get(String path) Get an object from the cluster using the default caching strategy.
org.json.JSONObject	get(String path, CacheUse cu) Get an object from the cluster using the caching strategy provided.
EntityLruCache<org.json.JSONObject>	getCache() Deprecated. The internal cache shouldn't be needed outside of this implementation
protected String	getCurrentApiKey()
void	installTracer(HttpTracer t) Install a tracer (useful for diagnostics; not a great idea for production).
void	patch(String oid, org.json.JSONObject obj)
void	patch(String path, org.json.JSONObject obj, CacheUse cu)
org.json.JSONObject	post(String path, org.json.JSONArray obj, boolean expectEntity)
org.json.JSONObject	post(String path, org.json.JSONObject obj, boolean expectEntity)
org.json.JSONObject	post(String path, String contentType, byte[] rawBytes, boolean expectEntity)
void	put(String path, org.json.JSONObject obj)
void	put(String path, org.json.JSONObject obj, CacheUse cu)
void	removeTracer() Remove an installed tracer.
void	replaceLogger(org.slf4j.Logger log) Replace the logger used by this class.
protected void	reportProblemWithResponse()
HttpClient	sendMetricsTo(com.att.nsa.metrics.CdmMetricsRegistry metrics, String metricsNamePrefix) Register a metrics registry and name prefix
void	setApiCredentials(String apiKey, String apiSecret) Set credentials for any following transactions
void	setHttpBasicCredentials(String username, String password) Set HTTP basic auth credentials for the transaction.

Methods inherited from class java.lang.Object

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

Field Detail

kDefault_PoolMaxInTotal

protected static final int kDefault_PoolMaxInTotal

See Also:

Constant Field Values

kDefault_PoolMaxPerRoute

protected static final int kDefault_PoolMaxPerRoute

See Also:

Constant Field Values

kDefault_SocketTimeoutMs

public static final int kDefault_SocketTimeoutMs

See Also:

Constant Field Values

Constructor Detail

HttpClient

public HttpClient(HttpClient.ConnectionType ct,
                  Collection<String> cluster,
                  int stdSvcPort)
           throws MalformedURLException

Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port. This client will not use a cache by default.

Parameters:

cluster - a set of hosts to use

stdSvcPort - the default port for this service if none is provided on a host entry

Throws:

MalformedURLException

GeneralSecurityException

HttpClient

public HttpClient(HttpClient.ConnectionType ct,
                  Collection<String> cluster,
                  int stdSvcPort,
                  String clientSignature)
           throws MalformedURLException

Construct an HTTP client for a given cluster with a standard service port to use when the hosts don't specify a port and a client signature that identifies this client across runs.

Parameters:

cluster -

stdSvcPort - the default port for this service if none is provided on a host entry

clientSignature - an optional string that identifies this client for consistent host selection across restarts

Throws:

MalformedURLException

GeneralSecurityException

HttpClient

public HttpClient(HttpClient.ConnectionType ct,
                  Collection<String> cluster,
                  int stdSvcPort,
                  String clientSignature,
                  CacheUse defCacheUse,
                  int maxObjCacheSize,
                  long maxObjCacheTime,
                  TimeUnit maxObjCacheTimeUnit)
           throws MalformedURLException

Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port. This client will use the the caching strategy provided by default with size and time limits as given.

Parameters:

cluster -

stdSvcPort - the default port for this service if none is provided on a host entry

clientSignature - an optional string that identifies this client for consistent host selection

defCacheUse -

maxObjCacheSize -

maxObjCacheTime -

maxObjCacheTimeUnit -

Throws:

MalformedURLException

HttpClient

public HttpClient(HttpClient.ConnectionType ct,
                  Collection<String> cluster,
                  int stdSvcPort,
                  String clientSignature,
                  CacheUse defCacheUse,
                  int maxObjCacheSize,
                  long maxObjCacheTime,
                  TimeUnit maxObjCacheTimeUnit,
                  int maxPoolSize,
                  int maxPoolPerRoute,
                  int soTimeoutMs)
           throws MalformedURLException

Construct an HTTP client for the given cluster with a standard service port to use when the hosts don't specify a port. This client will use the the caching strategy provided by default with size and time limits as given.

Parameters:

cluster -

stdSvcPort - the default port for this service if none is provided on a host entry

clientSignature - an optional string that identifies this client for consistent host selection

defCacheUse -

maxObjCacheSize -

maxObjCacheTime -

maxObjCacheTimeUnit -

maxPoolSize - for HTTP client

maxPoolPerRoute - for HTTP client

soTimeoutMs - how long to wait for bytes on a socket

Throws:

MalformedURLException

Method Detail

setApiCredentials

public void setApiCredentials(String apiKey,
                              String apiSecret)

Set credentials for any following transactions

Parameters:

apiKey -

apiSecret -

clearApiCredentials

public void clearApiCredentials()

Create the API credentials so that any following transactions do not authenticate.

setHttpBasicCredentials

public void setHttpBasicCredentials(String username,
                                    String password)

Set HTTP basic auth credentials for the transaction.

Parameters:

username -

password -

clearHttpBasicCredentials

public void clearHttpBasicCredentials()

Clear the HTTP basic auth credentials for the transaction.

installTracer

public void installTracer(HttpTracer t)

Install a tracer (useful for diagnostics; not a great idea for production). Only one tracer can be installed at a time.

Parameters:

t -

removeTracer

public void removeTracer()

Remove an installed tracer.

replaceLogger

public void replaceLogger(org.slf4j.Logger log)

Replace the logger used by this class.

Parameters:

log -

get

public org.json.JSONObject get(String path)
                        throws HttpObjectNotFoundException,
                               HttpException,
                               IOException

Get an object from the cluster using the default caching strategy.

Parameters:

path -

Returns:

an object

Throws:

HttpObjectNotFoundException

HttpException

IOException

get

public org.json.JSONObject get(String path,
                               CacheUse cu)
                        throws HttpObjectNotFoundException,
                               HttpException,
                               IOException

Get an object from the cluster using the caching strategy provided.

Parameters:

path -

cu -

Returns:

an object

Throws:

HttpObjectNotFoundException

HttpException

IOException

put

public void put(String path,
                org.json.JSONObject obj)
         throws HttpObjectNotFoundException,
                HttpException,
                IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

put

public void put(String path,
                org.json.JSONObject obj,
                CacheUse cu)
         throws HttpObjectNotFoundException,
                HttpException,
                IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

patch

public void patch(String oid,
                  org.json.JSONObject obj)
           throws HttpObjectNotFoundException,
                  HttpException,
                  IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

patch

public void patch(String path,
                  org.json.JSONObject obj,
                  CacheUse cu)
           throws HttpObjectNotFoundException,
                  HttpException,
                  IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

post

public org.json.JSONObject post(String path,
                                org.json.JSONObject obj,
                                boolean expectEntity)
                         throws HttpObjectNotFoundException,
                                HttpException,
                                IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

post

public org.json.JSONObject post(String path,
                                org.json.JSONArray obj,
                                boolean expectEntity)
                         throws HttpObjectNotFoundException,
                                HttpException,
                                IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

post

public org.json.JSONObject post(String path,
                                String contentType,
                                byte[] rawBytes,
                                boolean expectEntity)
                         throws HttpObjectNotFoundException,
                                HttpException,
                                IOException

Throws:

HttpObjectNotFoundException

HttpException

IOException

delete

public void delete(String path)
            throws HttpException,
                   IOException

Throws:

HttpException

IOException

getCache

@Deprecated
public EntityLruCache<org.json.JSONObject> getCache()

Deprecated. The internal cache shouldn't be needed outside of this implementation

Get the internal object cache

Returns:

the internal cache

sendMetricsTo

public HttpClient sendMetricsTo(com.att.nsa.metrics.CdmMetricsRegistry metrics,
                                String metricsNamePrefix)

Register a metrics registry and name prefix

Parameters:

metrics -

metricsNamePrefix -

reportProblemWithResponse

protected void reportProblemWithResponse()

getCurrentApiKey

protected String getCurrentApiKey()