com.onlinepayments

Interface Communicator

All Superinterfaces:

AutoCloseable, Closeable, LoggingCapable

All Known Implementing Classes:

DefaultCommunicator

public interface Communicator
extends Closeable, LoggingCapable

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.

Method Summary

Modifier and Type	Method and Description
void	closeExpiredConnections()
void	closeIdleConnections(long idleTime, TimeUnit timeUnit)
<O> O	delete(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Class<O> responseType, CallContext context) Corresponds to the HTTP DELETE method.
<O> O	get(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Class<O> responseType, CallContext context) Corresponds to the HTTP GET method.
Authenticator	getAuthenticator()
Connection	getConnection()
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.
<O> O	put(String relativePath, List<RequestHeader> requestHeaders, ParamRequest requestParameters, Object requestBody, Class<O> responseType, CallContext context) Corresponds to the HTTP PUT method.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.onlinepayments.logging.LoggingCapable

disableLogging, enableLogging

Method Detail

get

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

Corresponds to the HTTP GET method.

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.

Throws:

CommunicationException - when an exception occurred communicating with the Online Payments platform

ResponseException - when an error response was received from the Online Payments platform

ApiException - when an error response was received from the Online Payments platform which contained a list of errors

delete

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

Corresponds to the HTTP DELETE method.

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.

Throws:

CommunicationException - when an exception occurred communicating with the Online Payments platform

ResponseException - when an error response was received from the Online Payments platform

ApiException - when an error response was received from the Online Payments platform which contained a list of errors

post

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

Corresponds to the HTTP POST method.

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.

Throws:

CommunicationException - when an exception occurred communicating with the Online Payments platform

ResponseException - when an error response was received from the Online Payments platform

ApiException - when an error response was received from the Online Payments platform which contained a list of errors

put

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

Corresponds to the HTTP PUT method.

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.

Throws:

CommunicationException - when an exception occurred communicating with the Online Payments platform

ResponseException - when an error response was received from the Online Payments platform

ApiException - when an error response was received from the Online Payments platform which contained a list of errors

getConnection

Connection getConnection()

getAuthenticator

Authenticator getAuthenticator()

getMetaDataProvider

MetaDataProvider getMetaDataProvider()

getMarshaller

Marshaller getMarshaller()

closeIdleConnections

void closeIdleConnections(long idleTime,
                          TimeUnit timeUnit)

closeExpiredConnections

void closeExpiredConnections()