com.opsmatters.newrelic.api.services

Class HttpContext

java.lang.Object

com.opsmatters.newrelic.api.services.HttpContext

public class HttpContext
extends Object

Represents the set of HTTP operations to be used with the API calls.

Author:

Gerald Curley (opsmatters)

Constructor Summary

Constructors

Constructor and Description
HttpContext(javax.ws.rs.client.Client client, String protocol, String hostname, int port) Constructor that takes a client, protocol, hostname and port.

Method Summary

Modifier and Type	Method and Description
void	DELETE(String partialUrl) Execute a DELETE call against the partial URL.
void	DELETE(String partialUrl, Map<String,Object> headers, List<String> queryParams) Execute a DELETE call against the partial URL.
protected void	executeDeleteRequest(URI uri) Execute a DELETE request.
protected void	executeDeleteRequest(URI uri, Map<String,Object> headers, List<String> queryParams) Execute a DELETE request.
protected <T> com.google.common.base.Optional<T>	executeGetRequest(URI uri, javax.ws.rs.core.GenericType<T> returnType) Execute a GET request and return the result.
protected <T> com.google.common.base.Optional<T>	executeGetRequest(URI uri, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a GET request and return the result.
protected void	executePatchRequest(URI uri, Object obj) Execute a PATCH request.
protected void	executePatchRequest(URI uri, Object obj, Map<String,Object> headers, List<String> queryParams) Execute a PATCH request.
protected <T> com.google.common.base.Optional<T>	executePatchRequest(URI uri, Object obj, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a PATCH request with a return object.
protected com.google.common.base.Optional<javax.ws.rs.core.Response>	executePostRequest(URI uri, Object obj) Execute a POST request.
protected <T> com.google.common.base.Optional<T>	executePostRequest(URI uri, Object obj, javax.ws.rs.core.GenericType<T> returnType) Execute a POST request with a return object.
protected com.google.common.base.Optional<javax.ws.rs.core.Response>	executePostRequest(URI uri, Object obj, Map<String,Object> headers) Execute a POST request.
protected <T> com.google.common.base.Optional<T>	executePostRequest(URI uri, Object obj, Map<String,Object> headers, javax.ws.rs.core.GenericType<T> returnType) Execute a POST request with a return object.
protected void	executePutRequest(URI uri, Object obj) Execute a PUT request.
protected void	executePutRequest(URI uri, Object obj, Map<String,Object> headers, List<String> queryParams) Execute a PUT request.
protected <T> com.google.common.base.Optional<T>	executePutRequest(URI uri, Object obj, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a PUT request with a return object.
<T> com.google.common.base.Optional<T>	GET(String partialUrl, javax.ws.rs.core.GenericType<T> returnType) Execute a GET call against the partial URL and deserialize the results.
<T> com.google.common.base.Optional<T>	GET(String partialUrl, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a GET call against the partial URL and deserialize the results.
String	getUriPrefix() Returns the uri prefix for resources used by the client.
void	PATCH(String partialUrl, Object payload) Execute a PATCH call against the partial URL.
<T> com.google.common.base.Optional<T>	PATCH(String partialUrl, Object payload, javax.ws.rs.core.GenericType<T> returnType) Execute a PATCH call against the partial URL.
void	PATCH(String partialUrl, Object payload, Map<String,Object> headers, List<String> queryParams) Execute a PATCH call against the partial URL.
<T> com.google.common.base.Optional<T>	PATCH(String partialUrl, Object payload, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a PATCH call against the partial URL.
com.google.common.base.Optional<javax.ws.rs.core.Response>	POST(String partialUrl, Object payload) Execute a POST call against the partial URL.
<T> com.google.common.base.Optional<T>	POST(String partialUrl, Object payload, javax.ws.rs.core.GenericType<T> returnType) Execute a POST call against the partial URL.
com.google.common.base.Optional<javax.ws.rs.core.Response>	POST(String partialUrl, Object payload, Map<String,Object> headers) Execute a POST call against the partial URL.
<T> com.google.common.base.Optional<T>	POST(String partialUrl, Object payload, Map<String,Object> headers, javax.ws.rs.core.GenericType<T> returnType) Execute a POST call against the partial URL.
void	PUT(String partialUrl, Object payload) Execute a PUT call against the partial URL.
<T> com.google.common.base.Optional<T>	PUT(String partialUrl, Object payload, javax.ws.rs.core.GenericType<T> returnType) Execute a PUT call against the partial URL.
void	PUT(String partialUrl, Object payload, Map<String,Object> headers, List<String> queryParams) Execute a PUT call against the partial URL.
<T> com.google.common.base.Optional<T>	PUT(String partialUrl, Object payload, Map<String,Object> headers, List<String> queryParams, javax.ws.rs.core.GenericType<T> returnType) Execute a PUT call against the partial URL.
void	setThrowExceptions(boolean throwExceptions) Set to true if an exception should be thrown on an error HTTP response.
void	setUriPrefix(String uriPrefix) Sets the uri prefix for resources used by the client.
boolean	throwExceptions() Returns true if an exception should be thrown on an error HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpContext

public HttpContext(javax.ws.rs.client.Client client,
                   String protocol,
                   String hostname,
                   int port)

Constructor that takes a client, protocol, hostname and port.

Parameters:

client - The Jersey client

protocol - The protocol used to connect to the server

hostname - The hostname of the server

port - The port of the server

Method Detail

GET

public <T> com.google.common.base.Optional<T> GET(String partialUrl,
                                                  javax.ws.rs.core.GenericType<T> returnType)

Execute a GET call against the partial URL and deserialize the results.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

returnType - The expected return type

Returns:

The return type

GET

public <T> com.google.common.base.Optional<T> GET(String partialUrl,
                                                  Map<String,Object> headers,
                                                  List<String> queryParams,
                                                  javax.ws.rs.core.GenericType<T> returnType)

Execute a GET call against the partial URL and deserialize the results.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

returnType - The expected return type

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

Returns:

The return type

PUT

public void PUT(String partialUrl,
                Object payload)

Execute a PUT call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PUT

PUT

public void PUT(String partialUrl,
                Object payload,
                Map<String,Object> headers,
                List<String> queryParams)

Execute a PUT call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PUT

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

PUT

public <T> com.google.common.base.Optional<T> PUT(String partialUrl,
                                                  Object payload,
                                                  javax.ws.rs.core.GenericType<T> returnType)

Execute a PUT call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PUT

returnType - The expected return type

Returns:

The return type

PUT

public <T> com.google.common.base.Optional<T> PUT(String partialUrl,
                                                  Object payload,
                                                  Map<String,Object> headers,
                                                  List<String> queryParams,
                                                  javax.ws.rs.core.GenericType<T> returnType)

Execute a PUT call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PUT

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

returnType - The expected return type

Returns:

The return type

POST

public com.google.common.base.Optional<javax.ws.rs.core.Response> POST(String partialUrl,
                                                                       Object payload)

Execute a POST call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the POST

Returns:

The response to the POST

POST

public com.google.common.base.Optional<javax.ws.rs.core.Response> POST(String partialUrl,
                                                                       Object payload,
                                                                       Map<String,Object> headers)

Execute a POST call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the POST

headers - A set of headers to add to the request

Returns:

The response to the POST

POST

public <T> com.google.common.base.Optional<T> POST(String partialUrl,
                                                   Object payload,
                                                   javax.ws.rs.core.GenericType<T> returnType)

Execute a POST call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the POST

returnType - The expected return type

Returns:

The return type

POST

public <T> com.google.common.base.Optional<T> POST(String partialUrl,
                                                   Object payload,
                                                   Map<String,Object> headers,
                                                   javax.ws.rs.core.GenericType<T> returnType)

Execute a POST call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the POST

headers - A set of headers to add to the request

returnType - The expected return type

Returns:

The return type

PATCH

public void PATCH(String partialUrl,
                  Object payload)

Execute a PATCH call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PATCH

PATCH

public void PATCH(String partialUrl,
                  Object payload,
                  Map<String,Object> headers,
                  List<String> queryParams)

Execute a PATCH call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PATCH

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

PATCH

public <T> com.google.common.base.Optional<T> PATCH(String partialUrl,
                                                    Object payload,
                                                    javax.ws.rs.core.GenericType<T> returnType)

Execute a PATCH call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PATCH

returnType - The expected return type

Returns:

The return type

PATCH

public <T> com.google.common.base.Optional<T> PATCH(String partialUrl,
                                                    Object payload,
                                                    Map<String,Object> headers,
                                                    List<String> queryParams,
                                                    javax.ws.rs.core.GenericType<T> returnType)

Execute a PATCH call against the partial URL.

Type Parameters:

T - The type parameter used for the return object

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PATCH

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

returnType - The expected return type

Returns:

The return type

DELETE

public void DELETE(String partialUrl)

Execute a DELETE call against the partial URL.

Parameters:

partialUrl - The partial URL to build

DELETE

public void DELETE(String partialUrl,
                   Map<String,Object> headers,
                   List<String> queryParams)

Execute a DELETE call against the partial URL.

Parameters:

partialUrl - The partial URL to build

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

executeGetRequest

protected <T> com.google.common.base.Optional<T> executeGetRequest(URI uri,
                                                                   javax.ws.rs.core.GenericType<T> returnType)

Execute a GET request and return the result.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

returnType - The type to marshall the result back into

Returns:

The return type

executeGetRequest

protected <T> com.google.common.base.Optional<T> executeGetRequest(URI uri,
                                                                   Map<String,Object> headers,
                                                                   List<String> queryParams,
                                                                   javax.ws.rs.core.GenericType<T> returnType)

Execute a GET request and return the result.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

returnType - The type to marshall the result back into

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

Returns:

The return type

executePutRequest

protected void executePutRequest(URI uri,
                                 Object obj)

Execute a PUT request.

Parameters:

uri - The URI to call

obj - The object to use for the PUT

executePutRequest

protected void executePutRequest(URI uri,
                                 Object obj,
                                 Map<String,Object> headers,
                                 List<String> queryParams)

Execute a PUT request.

Parameters:

uri - The URI to call

obj - The object to use for the PUT

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

executePutRequest

protected <T> com.google.common.base.Optional<T> executePutRequest(URI uri,
                                                                   Object obj,
                                                                   Map<String,Object> headers,
                                                                   List<String> queryParams,
                                                                   javax.ws.rs.core.GenericType<T> returnType)

Execute a PUT request with a return object.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

obj - The object to use for the PUT

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

returnType - The type to marshall the result back into

Returns:

The return type

executePostRequest

protected com.google.common.base.Optional<javax.ws.rs.core.Response> executePostRequest(URI uri,
                                                                                        Object obj)

Execute a POST request.

Parameters:

uri - The URI to call

obj - The object to use for the POST

Returns:

The response to the POST

executePostRequest

protected com.google.common.base.Optional<javax.ws.rs.core.Response> executePostRequest(URI uri,
                                                                                        Object obj,
                                                                                        Map<String,Object> headers)

Execute a POST request.

Parameters:

uri - The URI to call

obj - The object to use for the POST

headers - A set of headers to add to the request

Returns:

The response to the POST

executePostRequest

protected <T> com.google.common.base.Optional<T> executePostRequest(URI uri,
                                                                    Object obj,
                                                                    javax.ws.rs.core.GenericType<T> returnType)

Execute a POST request with a return object.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

obj - The object to use for the POST

returnType - The type to marshall the result back into

Returns:

The return type

executePostRequest

protected <T> com.google.common.base.Optional<T> executePostRequest(URI uri,
                                                                    Object obj,
                                                                    Map<String,Object> headers,
                                                                    javax.ws.rs.core.GenericType<T> returnType)

Execute a POST request with a return object.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

obj - The object to use for the POST

headers - A set of headers to add to the request

returnType - The type to marshall the result back into

Returns:

The return type

executePatchRequest

protected void executePatchRequest(URI uri,
                                   Object obj)

Execute a PATCH request.

Parameters:

uri - The URI to call

obj - The object to use for the PATCH

executePatchRequest

protected void executePatchRequest(URI uri,
                                   Object obj,
                                   Map<String,Object> headers,
                                   List<String> queryParams)

Execute a PATCH request.

Parameters:

uri - The URI to call

obj - The object to use for the PATCH

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

executePatchRequest

protected <T> com.google.common.base.Optional<T> executePatchRequest(URI uri,
                                                                     Object obj,
                                                                     Map<String,Object> headers,
                                                                     List<String> queryParams,
                                                                     javax.ws.rs.core.GenericType<T> returnType)

Execute a PATCH request with a return object.

Type Parameters:

T - The type parameter used for the return object

Parameters:

uri - The URI to call

obj - The object to use for the PATCH

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

returnType - The type to marshall the result back into

Returns:

The return type

executeDeleteRequest

protected void executeDeleteRequest(URI uri)

Execute a DELETE request.

Parameters:

uri - The URI to call

executeDeleteRequest

protected void executeDeleteRequest(URI uri,
                                    Map<String,Object> headers,
                                    List<String> queryParams)

Execute a DELETE request.

Parameters:

uri - The URI to call

headers - A set of headers to add to the request

queryParams - A set of query parameters to add to the request

setThrowExceptions

public void setThrowExceptions(boolean throwExceptions)

Set to true if an exception should be thrown on an error HTTP response.

Parameters:

throwExceptions - true if an exception should be thrown on an error HTTP response

throwExceptions

public boolean throwExceptions()

Returns true if an exception should be thrown on an error HTTP response.

Returns:

true if an exception should be thrown on an error HTTP response

setUriPrefix

public void setUriPrefix(String uriPrefix)

Sets the uri prefix for resources used by the client.

Parameters:

uriPrefix - The uri prefix for the client

getUriPrefix

public String getUriPrefix()

Returns the uri prefix for resources used by the client.

Returns:

The uri prefix for the client