HttpContext (Bitly Java API 1.0.2 API)

java.lang.Object
- com.opsmatters.bitly.api.services.HttpContext

```
public class HttpContext
extends Object
```
Base class for HTTP operations using API calls.

Author:

Gerald Curley (opsmatters)

Field Summary

Fields
Modifier and Type Field and Description

protected static Type ERROR

Fields
Modifier and Type	Field and Description
`protected static Type`	`ERROR`

Constructor Summary

Constructors
Constructor and Description

HttpContext(String protocol, String hostname, int port)
Constructor that takes a protocol, hostname and port.

Constructors
Constructor and Description
`HttpContext(String protocol, String hostname, int port)` Constructor that takes a protocol, hostname and port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`DELETE(String partialUrl)` Execute a DELETE call against the partial URL.
`void`	`DELETE(String partialUrl, Map<String,String> 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,String> headers, List<String> queryParams)` Execute a DELETE request.
`protected <T> com.google.common.base.Optional<T>`	`executeGetRequest(URI uri, Map<String,String> headers, List<String> queryParams, Type returnType)` Execute a GET request and return the result.
`protected <T> com.google.common.base.Optional<T>`	`executeGetRequest(URI uri, Type 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,String> headers, List<String> queryParams)` Execute a PATCH request.
`protected <T> com.google.common.base.Optional<T>`	`executePatchRequest(URI uri, Object obj, Map<String,String> headers, List<String> queryParams, Type returnType)` Execute a PATCH request with a return object.
`protected com.google.common.base.Optional<org.apache.http.HttpResponse>`	`executePostRequest(URI uri, Object obj)` Execute a POST request.
`protected com.google.common.base.Optional<org.apache.http.HttpResponse>`	`executePostRequest(URI uri, Object obj, Map<String,String> headers)` Execute a POST request.
`protected <T> com.google.common.base.Optional<T>`	`executePostRequest(URI uri, Object obj, Map<String,String> headers, Type returnType)` Execute a POST request with a return object.
`protected <T> com.google.common.base.Optional<T>`	`executePostRequest(URI uri, Object obj, Type returnType)` Execute a POST request with a return object.
`<T> com.google.common.base.Optional<T>`	`GET(String partialUrl, Map<String,String> headers, List<String> queryParams, Type returnType)` Execute a GET call against the partial URL and deserialize the results.
`<T> com.google.common.base.Optional<T>`	`GET(String partialUrl, Type returnType)` Execute a GET call against the partial URL and deserialize the results.
`void`	`PATCH(String partialUrl, Object payload)` Execute a PATCH call against the partial URL.
`void`	`PATCH(String partialUrl, Object payload, Map<String,String> 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,String> headers, List<String> queryParams, Type returnType)` Execute a PATCH call against the partial URL.
`<T> com.google.common.base.Optional<T>`	`PATCH(String partialUrl, Object payload, Type returnType)` Execute a PATCH call against the partial URL.
`com.google.common.base.Optional<org.apache.http.HttpResponse>`	`POST(String partialUrl, Object payload)` Execute a POST call against the partial URL.
`com.google.common.base.Optional<org.apache.http.HttpResponse>`	`POST(String partialUrl, Object payload, Map<String,String> headers)` Execute a POST call against the partial URL.
`<T> com.google.common.base.Optional<T>`	`POST(String partialUrl, Object payload, Map<String,String> headers, Type returnType)` Execute a POST call against the partial URL.
`<T> com.google.common.base.Optional<T>`	`POST(String partialUrl, Object payload, Type returnType)` Execute a POST call against the partial URL.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ERROR
```
protected static final Type ERROR
```

Constructor Detail
- HttpContext
```
public HttpContext(String protocol,
                   String hostname,
                   int port)
```
  Constructor that takes a protocol, hostname and port.
  
  Parameters:
  
  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,
                                                  Type returnType)
                                           throws IOException,
                                                  URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

GET

public <T> com.google.common.base.Optional<T> GET(String partialUrl,
                                                  Map<String,String> headers,
                                                  List<String> queryParams,
                                                  Type returnType)
                                           throws IOException,
                                                  URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

POST

public com.google.common.base.Optional<org.apache.http.HttpResponse> POST(String partialUrl,
                                                                          Object payload)
                                                                   throws IOException

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
Throws:: IOException - if there is a communication error.

POST

public com.google.common.base.Optional<org.apache.http.HttpResponse> POST(String partialUrl,
                                                                          Object payload,
                                                                          Map<String,String> headers)
                                                                   throws IOException

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
Throws:: IOException - if there is a communication error.

POST

public <T> com.google.common.base.Optional<T> POST(String partialUrl,
                                                   Object payload,
                                                   Type returnType)
                                            throws IOException

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
Throws:: IOException - if there is a communication error.

POST

public <T> com.google.common.base.Optional<T> POST(String partialUrl,
                                                   Object payload,
                                                   Map<String,String> headers,
                                                   Type returnType)
                                            throws IOException

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
Throws:: IOException - if there is a communication error.

PATCH
```
public void PATCH(String partialUrl,
                  Object payload)
           throws IOException,
                  URISyntaxException
```
Execute a PATCH call against the partial URL.

Parameters:

partialUrl - The partial URL to build

payload - The object to use for the PATCH

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

PATCH
```
public void PATCH(String partialUrl,
                  Object payload,
                  Map<String,String> headers,
                  List<String> queryParams)
           throws IOException,
                  URISyntaxException
```
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

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

PATCH

public <T> com.google.common.base.Optional<T> PATCH(String partialUrl,
                                                    Object payload,
                                                    Type returnType)
                                             throws IOException,
                                                    URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

PATCH

public <T> com.google.common.base.Optional<T> PATCH(String partialUrl,
                                                    Object payload,
                                                    Map<String,String> headers,
                                                    List<String> queryParams,
                                                    Type returnType)
                                             throws IOException,
                                                    URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

DELETE
```
public void DELETE(String partialUrl)
            throws IOException,
                   URISyntaxException
```
Execute a DELETE call against the partial URL.

Parameters:

partialUrl - The partial URL to build

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

DELETE
```
public void DELETE(String partialUrl,
                   Map<String,String> headers,
                   List<String> queryParams)
            throws IOException,
                   URISyntaxException
```
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

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

executeGetRequest

protected <T> com.google.common.base.Optional<T> executeGetRequest(URI uri,
                                                                   Type returnType)
                                                            throws IOException,
                                                                   URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executeGetRequest

protected <T> com.google.common.base.Optional<T> executeGetRequest(URI uri,
                                                                   Map<String,String> headers,
                                                                   List<String> queryParams,
                                                                   Type returnType)
                                                            throws IOException,
                                                                   URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executePostRequest

protected com.google.common.base.Optional<org.apache.http.HttpResponse> executePostRequest(URI uri,
                                                                                           Object obj)
                                                                                    throws IOException

Execute a POST request.

Parameters:: uri - The URI to call; obj - The object to use for the POST
Returns:: The response to the POST
Throws:: IOException - if there is a communication error.

executePostRequest

protected com.google.common.base.Optional<org.apache.http.HttpResponse> executePostRequest(URI uri,
                                                                                           Object obj,
                                                                                           Map<String,String> headers)
                                                                                    throws IOException

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
Throws:: IOException - if there is a communication error.

executePostRequest

protected <T> com.google.common.base.Optional<T> executePostRequest(URI uri,
                                                                    Object obj,
                                                                    Type returnType)
                                                             throws IOException

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
Throws:: IOException - if there is a communication error.

executePostRequest

protected <T> com.google.common.base.Optional<T> executePostRequest(URI uri,
                                                                    Object obj,
                                                                    Map<String,String> headers,
                                                                    Type returnType)
                                                             throws IOException

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
Throws:: IOException - if there is a communication error.

executePatchRequest

protected void executePatchRequest(URI uri,
                                   Object obj)
                            throws IOException,
                                   URISyntaxException

Execute a PATCH request.

Parameters:: uri - The URI to call; obj - The object to use for the PATCH
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executePatchRequest

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

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executePatchRequest

protected <T> com.google.common.base.Optional<T> executePatchRequest(URI uri,
                                                                     Object obj,
                                                                     Map<String,String> headers,
                                                                     List<String> queryParams,
                                                                     Type returnType)
                                                              throws IOException,
                                                                     URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executeDeleteRequest

protected void executeDeleteRequest(URI uri)
                             throws IOException,
                                    URISyntaxException

Execute a DELETE request.

Parameters:: uri - The URI to call
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

executeDeleteRequest

protected void executeDeleteRequest(URI uri,
                                    Map<String,String> headers,
                                    List<String> queryParams)
                             throws IOException,
                                    URISyntaxException

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
Throws:: IOException - if there is a communication error.; URISyntaxException - if there is a format error in the URL.

Class HttpContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR

Constructor Detail

HttpContext

Method Detail

GET

GET

POST

POST

POST

POST

PATCH

PATCH

PATCH

PATCH

DELETE

DELETE

executeGetRequest

executeGetRequest

executePostRequest

executePostRequest

executePostRequest

executePostRequest

executePatchRequest

executePatchRequest

executePatchRequest

executeDeleteRequest

executeDeleteRequest