com.onlinepayments.defaultimpl

Class DefaultCommunicator

java.lang.Object

com.onlinepayments.defaultimpl.DefaultCommunicator

All Implemented Interfaces:

Communicator, LoggingCapable, Closeable, AutoCloseable

public class DefaultCommunicator
extends Object
implements Communicator

Used to communicate with the Online Payments platform web services.

It contains all the logic to transform a request object to a HTTP request and a HTTP response to a response object.

Thread-safe.

Constructor Summary

Constructors

Constructor and Description
DefaultCommunicator(URI apiEndpoint, Connection connection, Authenticator authenticator, MetaDataProvider metaDataProvider, Marshaller marshaller)

Method Summary

Modifier and Type	Method and Description
protected void	addGenericHeaders(String httpMethod, URI uri, List<RequestHeader> requestHeaders, CallContext context) Adds the necessary headers to the given list of headers.
void	close() Releases any system resources associated with this object.
void	closeExpiredConnections() Utility method that delegates the call to this communicator's session's connection if that's an instance of PooledConnection.
void	closeIdleConnections(long idleTime, TimeUnit timeUnit) Utility method that delegates the call to this communicator's session's connection if that's an instance of PooledConnection.
<O> O	delete(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Class<O> responseType, CallContext context) Corresponds to the HTTP DELETE method.
void	disableLogging() Turns off logging.
void	enableLogging(CommunicatorLogger communicatorLogger) Turns on logging using the given communicator logger.
<O> O	get(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Class<O> responseType, CallContext context) Corresponds to the HTTP GET method.
URI	getApiEndpoint()
Authenticator	getAuthenticator()
Connection	getConnection()
protected String	getHeaderDateString() Returns the date in the preferred format for the HTTP date header (RFC1123).
Marshaller	getMarshaller()
MetaDataProvider	getMetaDataProvider()
<O> O	post(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Object requestBody, Class<O> responseType, CallContext context) Corresponds to the HTTP POST method.
protected <O> O	processResponse(int statusCode, InputStream bodyStream, List<ResponseHeader> headers, Class<O> responseType, String requestPath, CallContext context)
<O> O	put(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Object requestBody, Class<O> responseType, CallContext context) Corresponds to the HTTP PUT method.
protected void	throwExceptionIfNecessary(int statusCode, InputStream bodyStream, List<ResponseHeader> headers, String requestPath) Checks the status code and headers for errors and throws an exception if necessary.
protected URI	toAbsoluteURI(String relativePath, List<RequestParam> requestParameters)
protected void	updateContext(List<ResponseHeader> headers, CallContext context) Updates the given call context based on the contents of the given response.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommunicator

public DefaultCommunicator(URI apiEndpoint,
                           Connection connection,
                           Authenticator authenticator,
                           MetaDataProvider metaDataProvider,
                           Marshaller marshaller)

Method Detail

close

public void close()
           throws IOException

Releases any system resources associated with this object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

get

public <O> O get(String relativePath,
                 List<RequestHeader> requestHeaders,
                 ParamRequest requestParameters,
                 Class<O> responseType,
                 CallContext context)

Corresponds to the HTTP GET method.

Specified by:

get in interface Communicator

Parameters:

relativePath - The path to call, relative to the base URI.

requestHeaders - An optional list of request headers.

requestParameters - An optional set of request parameters.

responseType - The type of response to return.

context - The optional call context to use.

delete

public <O> O delete(String relativePath,
                    List<RequestHeader> requestHeaders,
                    ParamRequest requestParameters,
                    Class<O> responseType,
                    CallContext context)

Corresponds to the HTTP DELETE method.

Specified by:

delete in interface Communicator

Parameters:

relativePath - The path to call, relative to the base URI.

requestHeaders - An optional list of request headers.

requestParameters - An optional set of request parameters.

responseType - The type of response to return.

context - The optional call context to use.

post

public <O> O post(String relativePath,
                  List<RequestHeader> requestHeaders,
                  ParamRequest requestParameters,
                  Object requestBody,
                  Class<O> responseType,
                  CallContext context)

Corresponds to the HTTP POST method.

Specified by:

post in interface Communicator

Parameters:

relativePath - The path to call, relative to the base URI.

requestHeaders - An optional list of request headers.

requestParameters - An optional set of request parameters.

requestBody - The optional request body to send.

responseType - The type of response to return.

context - The optional call context to use.

put

public <O> O put(String relativePath,
                 List<RequestHeader> requestHeaders,
                 ParamRequest requestParameters,
                 Object requestBody,
                 Class<O> responseType,
                 CallContext context)

Corresponds to the HTTP PUT method.

Specified by:

put in interface Communicator

Parameters:

relativePath - The path to call, relative to the base URI.

requestHeaders - An optional list of request headers.

requestParameters - An optional set of request parameters.

requestBody - The optional request body to send.

responseType - The type of response to return.

context - The optional call context to use.

getApiEndpoint

public URI getApiEndpoint()

getConnection

public Connection getConnection()

Specified by:

getConnection in interface Communicator

getAuthenticator

public Authenticator getAuthenticator()

Specified by:

getAuthenticator in interface Communicator

getMetaDataProvider

public MetaDataProvider getMetaDataProvider()

Specified by:

getMetaDataProvider in interface Communicator

getMarshaller

public Marshaller getMarshaller()

Specified by:

getMarshaller in interface Communicator

toAbsoluteURI

protected URI toAbsoluteURI(String relativePath,
                            List<RequestParam> requestParameters)

addGenericHeaders

protected void addGenericHeaders(String httpMethod,
                                 URI uri,
                                 List<RequestHeader> requestHeaders,
                                 CallContext context)

Adds the necessary headers to the given list of headers. This includes the authorization header, which uses other headers, so when you need to override this method, make sure to call super.addGenericHeaders at the end of your overridden method.

getHeaderDateString

protected String getHeaderDateString()

Returns the date in the preferred format for the HTTP date header (RFC1123).

processResponse

protected <O> O processResponse(int statusCode,
                                InputStream bodyStream,
                                List<ResponseHeader> headers,
                                Class<O> responseType,
                                String requestPath,
                                CallContext context)

updateContext

protected void updateContext(List<ResponseHeader> headers,
                             CallContext context)

Updates the given call context based on the contents of the given response.

throwExceptionIfNecessary

protected void throwExceptionIfNecessary(int statusCode,
                                         InputStream bodyStream,
                                         List<ResponseHeader> headers,
                                         String requestPath)

Checks the status code and headers for errors and throws an exception if necessary.

closeIdleConnections

public void closeIdleConnections(long idleTime,
                                 TimeUnit timeUnit)

Utility method that delegates the call to this communicator's session's connection if that's an instance of PooledConnection. If not this method does nothing.

Specified by:

closeIdleConnections in interface Communicator

See Also:

PooledConnection.closeIdleConnections(long, TimeUnit)

closeExpiredConnections

public void closeExpiredConnections()

Utility method that delegates the call to this communicator's session's connection if that's an instance of PooledConnection. If not this method does nothing.

Specified by:

closeExpiredConnections in interface Communicator

See Also:

PooledConnection.closeExpiredConnections()

enableLogging

public void enableLogging(CommunicatorLogger communicatorLogger)

Description copied from interface: LoggingCapable

Turns on logging using the given communicator logger.

Specified by:

enableLogging in interface LoggingCapable

disableLogging

public void disableLogging()

Description copied from interface: LoggingCapable

Turns off logging.

Specified by:

disableLogging in interface LoggingCapable