com.hds.hcpaw.fss.api

Class AnywhereConnector

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereConnector

public class AnywhereConnector
extends java.lang.Object

Connects to HCP Anywhere and runs HTTP requests. The connector also handles request body serialization and deserialization, and content streaming.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AnywhereConnector.Builder Builds an instance of an AnywhereConnector.
static class	AnywhereConnector.RequestMethod The HTTP method (or verb)

Method Summary

Modifier and Type	Method and Description
protected FssApiVersion	getLatestCommonApiVersion() Returns the latest FssApiVersion that is supported by both this client and the server.
protected <T> T	invokeNoBody(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.Class<T> responseType) Sends an HTTP request with no request body and returns the response body converted to an object of type T.
protected <T> T	invokeNoBody(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, java.io.OutputStream outputStream, java.lang.Class<T> responseType, java.lang.String responseHeaderKey) Sends an HTTP request with no request body.
protected <T> T	invokeWithFormData(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, java.lang.String username, java.lang.String password, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String content, java.lang.Class<T> responseType) Sends an HTTP request that sends form data and returns the response body converted to an object of type T.
protected <U> void	invokeWithObject(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, U body) Sends an HTTP request that sends a JSON string as the request body.
protected <U,T> T	invokeWithObject(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, U body, java.lang.Class<T> responseType) Sends an HTTP request that sends a JSON string as the request body and returns the response body converted to an object of type T.
protected <U,T> InputStreamResult<T>	invokeWithObject(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, U body, java.lang.Class<T> responseType, java.lang.String responseHeaderKey) Sends an HTTP request that sends a JSON string as the request body.
protected <U,T> T	invokeWithObject(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, U body, java.io.OutputStream outputStream, java.lang.Class<T> responseType, java.lang.String responseHeaderKey) Sends an HTTP request that sends a JSON string as the request body.
protected <T> T	invokeWithStream(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, java.io.InputStream content, java.io.OutputStream outputStream, java.lang.Class<T> responseType, java.lang.String responseHeaderKey) Sends an HTTP request that sends the contents of an InputStream as the request body.
protected <T> T	invokeWithStream(AnywhereConnector.RequestMethod method, FssApiVersion apiVersion, AuthToken auth, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String ifMatch, java.io.InputStream content, java.lang.Class<T> responseType) Sends an HTTP request that sends the contents of an InputStream as the request body and returns the response body converted to an object of type T.

Methods inherited from class java.lang.Object

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

Method Detail

getLatestCommonApiVersion

protected FssApiVersion getLatestCommonApiVersion()

Returns the latest FssApiVersion that is supported by both this client and the server. If no communications have yet occurred with the server via this AnywhereConnector, thereby rendering the latest common version unknown, then the latest version supported by this client is returned. Every time a request to the server is made via the methods of this AnywhereConnector, the latest common API version may be updated.

Returns:

the latest known FssApiVersion that is supported by both this client and the server, or the latest version supported by this client if the server's supported versions is unknown.

invokeWithFormData

protected <T> T invokeWithFormData(AnywhereConnector.RequestMethod method,
                                   FssApiVersion apiVersion,
                                   java.lang.String username,
                                   java.lang.String password,
                                   java.lang.String path,
                                   java.util.Map<java.lang.String,java.lang.String> parameters,
                                   java.lang.String content,
                                   java.lang.Class<T> responseType)
                            throws java.io.IOException,
                                   AnywhereException

Sends an HTTP request that sends form data and returns the response body converted to an object of type T. This request uses basic authentication.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request

username - username of user performing action

password - password for user performing action

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

content - the content to send as the request body, using MediaType MEDIA_TYPE_FORM_ENCODED

responseType - the Class of the JSON bean to be returned

Returns:

the JSON bean of type responseType from the HTTP response body

Throws:

java.io.IOException

AnywhereException

invokeWithStream

protected <T> T invokeWithStream(AnywhereConnector.RequestMethod method,
                                 FssApiVersion apiVersion,
                                 AuthToken auth,
                                 java.lang.String path,
                                 java.util.Map<java.lang.String,java.lang.String> parameters,
                                 java.lang.String ifMatch,
                                 java.io.InputStream content,
                                 java.lang.Class<T> responseType)
                          throws java.io.IOException,
                                 AnywhereException

Sends an HTTP request that sends the contents of an InputStream as the request body and returns the response body converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

ifMatch - the etag to be sent in the "If-Match" request header

content - The contents of this InputStream will be sent as the request body.

responseType - the Class of the JSON bean to be returned

Returns:

the JSON bean of type responseType from the HTTP response body

Throws:

java.io.IOException

AnywhereException

invokeWithStream

protected <T> T invokeWithStream(AnywhereConnector.RequestMethod method,
                                 FssApiVersion apiVersion,
                                 AuthToken auth,
                                 java.lang.String path,
                                 java.util.Map<java.lang.String,java.lang.String> parameters,
                                 java.io.InputStream content,
                                 java.io.OutputStream outputStream,
                                 java.lang.Class<T> responseType,
                                 java.lang.String responseHeaderKey)
                          throws java.io.IOException,
                                 AnywhereException

Sends an HTTP request that sends the contents of an InputStream as the request body. The response body is written to an OutputStream, and this method returns the value of a specified response header converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

content - The contents of this InputStream will be sent as the request body.

outputStream - The response body will be written to this OutputStream.

responseType - the Class of the JSON bean to be returned

responseHeaderKey - the name (key) of the response header in which the JSON of type responseType will be returned

Returns:

the JSON bean of type responseType from the HTTP response header with key responseHeaderKey

Throws:

java.io.IOException

AnywhereException

invokeWithObject

protected <U,T> T invokeWithObject(AnywhereConnector.RequestMethod method,
                                   FssApiVersion apiVersion,
                                   AuthToken auth,
                                   java.lang.String path,
                                   java.util.Map<java.lang.String,java.lang.String> parameters,
                                   U body,
                                   java.lang.Class<T> responseType)
                            throws java.io.IOException,
                                   AnywhereException

Sends an HTTP request that sends a JSON string as the request body and returns the response body converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the supplied body object and the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

body - the JSON bean to be sent as the request body. Will be converted to a JSON String.

responseType - the Class of the JSON bean to be returned

Returns:

the JSON bean of type responseType from the HTTP response body

Throws:

java.io.IOException

AnywhereException

invokeWithObject

protected <U> void invokeWithObject(AnywhereConnector.RequestMethod method,
                                    FssApiVersion apiVersion,
                                    AuthToken auth,
                                    java.lang.String path,
                                    java.util.Map<java.lang.String,java.lang.String> parameters,
                                    U body)
                             throws java.io.IOException,
                                    AnywhereException

Sends an HTTP request that sends a JSON string as the request body.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the supplied body object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

body - the JSON bean to be sent as the request body. Will be converted to a JSON String.

Throws:

java.io.IOException

AnywhereException

invokeWithObject

protected <U,T> T invokeWithObject(AnywhereConnector.RequestMethod method,
                                   FssApiVersion apiVersion,
                                   AuthToken auth,
                                   java.lang.String path,
                                   java.util.Map<java.lang.String,java.lang.String> parameters,
                                   U body,
                                   java.io.OutputStream outputStream,
                                   java.lang.Class<T> responseType,
                                   java.lang.String responseHeaderKey)
                            throws java.io.IOException,
                                   AnywhereException

Sends an HTTP request that sends a JSON string as the request body. The response body is written to an OutputStream, and this method returns the value of a specified response header converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the supplied body object and the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

body - the JSON bean to be sent as the request body. Will be converted to a JSON String.

outputStream - The response body will be written to this OutputStream.

responseType - the Class of the JSON bean to be returned

responseHeaderKey - the name (key) of the response header in which the JSON of type responseType will be returned

Returns:

the JSON bean of type responseType from the HTTP response header with key responseHeaderKey

Throws:

java.io.IOException

AnywhereException

invokeWithObject

protected <U,T> InputStreamResult<T> invokeWithObject(AnywhereConnector.RequestMethod method,
                                                      FssApiVersion apiVersion,
                                                      AuthToken auth,
                                                      java.lang.String path,
                                                      java.util.Map<java.lang.String,java.lang.String> parameters,
                                                      U body,
                                                      java.lang.Class<T> responseType,
                                                      java.lang.String responseHeaderKey)
                                               throws java.io.IOException,
                                                      AnywhereException

Sends an HTTP request that sends a JSON string as the request body. The Response from the request is returned.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the supplied body object and the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

body - the JSON bean to be sent as the request body. Will be converted to a JSON String.

responseType - the Class of the JSON bean returned in a header

responseHeaderKey - the name (key) of the response header in which the JSON of type responseType will be returned

Returns:

the Response from the HTTP request responseHeaderKey

Throws:

java.io.IOException

AnywhereException

invokeNoBody

protected <T> T invokeNoBody(AnywhereConnector.RequestMethod method,
                             FssApiVersion apiVersion,
                             AuthToken auth,
                             java.lang.String path,
                             java.util.Map<java.lang.String,java.lang.String> parameters,
                             java.io.OutputStream outputStream,
                             java.lang.Class<T> responseType,
                             java.lang.String responseHeaderKey)
                      throws java.io.IOException,
                             AnywhereException

Sends an HTTP request with no request body. The response body is written to an OutputStream, and this method returns the value of a specified response header converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

outputStream - The response body will be written to this OutputStream.

responseType - the Class of the JSON bean to be returned

responseHeaderKey - the name (key) of the response header in which the JSON of type responseType will be returned

Returns:

the JSON bean of type responseType from the HTTP response header with key responseHeaderKey

Throws:

java.io.IOException

AnywhereException

invokeNoBody

protected <T> T invokeNoBody(AnywhereConnector.RequestMethod method,
                             FssApiVersion apiVersion,
                             AuthToken auth,
                             java.lang.String path,
                             java.util.Map<java.lang.String,java.lang.String> parameters,
                             java.lang.Class<T> responseType)
                      throws java.io.IOException,
                             AnywhereException

Sends an HTTP request with no request body and returns the response body converted to an object of type T.

Parameters:

method - the HTTP AnywhereConnector.RequestMethod to use

apiVersion - the FssApiVersion to use for the request, and corresponding to the version of the returned object

auth - authentication token for the user performing the request

path - the endpoint to send the request to. Roughly equates to a URI. It does not include the protocol, server or port.

parameters - a Map from request parameter name to request parameter value. All entries in the Map will be added to the HTTP request as request parameters.

responseType - the Class of the JSON bean to be returned

Returns:

the JSON bean of type responseType from the HTTP response body

Throws:

java.io.IOException

AnywhereException