com.ingenico.connect.gateway.sdk.java.Communicator Maven / Gradle / Ivy
Show all versions of connect-sdk-java Show documentation
package com.ingenico.connect.gateway.sdk.java;
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.Locale;
import java.util.TimeZone;
import java.util.concurrent.TimeUnit;
import org.apache.http.HttpStatus;
import org.apache.http.client.utils.URIBuilder;
import com.ingenico.connect.gateway.sdk.java.logging.CommunicatorLogger;
import com.ingenico.connect.gateway.sdk.java.logging.LoggingCapable;
/**
* Used to communicate with the Ingenico ePayments 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.
*/
public class Communicator implements Closeable, LoggingCapable {
private static final Charset CHARSET = Charset.forName("UTF-8");
private final Session session;
private final Marshaller marshaller;
public Communicator(Session session, Marshaller marshaller) {
if (session == null) {
throw new IllegalArgumentException("session is required");
}
if (marshaller == null) {
throw new IllegalArgumentException("marshaller is required");
}
this.session = session;
this.marshaller = marshaller;
}
/**
* Releases any system resources associated with this object.
*/
@Override
public void close() throws IOException {
session.getConnection().close();
}
/**
* Corresponds to the HTTP GET method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param responseType The type of response to return.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public O get(final String relativePath, List requestHeaders, ParamRequest requestParameters,
final Class responseType, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
addGenericHeaders("GET", uri, requestHeaders, context);
return connection.get(uri, requestHeaders, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
/**
* Corresponds to the HTTP GET method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param bodyHandler The handler for the response body.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public void get(final String relativePath, List requestHeaders, ParamRequest requestParameters,
final BodyHandler bodyHandler, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
addGenericHeaders("GET", uri, requestHeaders, context);
connection.get(uri, requestHeaders, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
/**
* Corresponds to the HTTP DELETE method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param responseType The type of response to return.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public O delete(final String relativePath, List requestHeaders, ParamRequest requestParameters,
final Class responseType, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
addGenericHeaders("DELETE", uri, requestHeaders, context);
return connection.delete(uri, requestHeaders, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
/**
* Corresponds to the HTTP DELETE method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param bodyHandler The handler for the response body.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public void delete(final String relativePath, List requestHeaders, ParamRequest requestParameters,
final BodyHandler bodyHandler, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
addGenericHeaders("DELETE", uri, requestHeaders, context);
connection.delete(uri, requestHeaders, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
/**
* Corresponds to the HTTP POST method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param requestBody The optional request body to send.
* @param responseType The type of response to return.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public O post(final String relativePath, List requestHeaders, ParamRequest requestParameters, Object requestBody,
final Class responseType, final CallContext context) {
if (requestBody instanceof MultipartFormDataObject) {
return post(relativePath, requestHeaders, requestParameters, (MultipartFormDataObject) requestBody, responseType, context);
}
if (requestBody instanceof MultipartFormDataRequest) {
MultipartFormDataObject multipart = ((MultipartFormDataRequest) requestBody).toMultipartFormDataObject();
return post(relativePath, requestHeaders, requestParameters, multipart, responseType, context);
}
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
String requestJson = null;
if (requestBody != null) {
requestHeaders.add(new RequestHeader("Content-Type", "application/json"));
requestJson = marshaller.marshal(requestBody);
}
addGenericHeaders("POST", uri, requestHeaders, context);
return connection.post(uri, requestHeaders, requestJson, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
@SuppressWarnings("resource")
private O post(final String relativePath, List requestHeaders, ParamRequest requestParameters, MultipartFormDataObject multipart,
final Class responseType, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
requestHeaders.add(new RequestHeader("Content-Type", multipart.getContentType()));
addGenericHeaders("POST", uri, requestHeaders, context);
return connection.post(uri, requestHeaders, multipart, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
/**
* Corresponds to the HTTP POST method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param requestBody The optional request body to send.
* @param bodyHandler The handler for the response body.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public void post(final String relativePath, List requestHeaders, ParamRequest requestParameters, Object requestBody,
final BodyHandler bodyHandler, final CallContext context) {
if (requestBody instanceof MultipartFormDataObject) {
post(relativePath, requestHeaders, requestParameters, (MultipartFormDataObject) requestBody, bodyHandler, context);
return;
}
if (requestBody instanceof MultipartFormDataRequest) {
MultipartFormDataObject multipart = ((MultipartFormDataRequest) requestBody).toMultipartFormDataObject();
post(relativePath, requestHeaders, requestParameters, multipart, bodyHandler, context);
return;
}
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
String requestJson = null;
if (requestBody != null) {
requestHeaders.add(new RequestHeader("Content-Type", "application/json"));
requestJson = marshaller.marshal(requestBody);
}
addGenericHeaders("POST", uri, requestHeaders, context);
connection.post(uri, requestHeaders, requestJson, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
@SuppressWarnings("resource")
private void post(final String relativePath, List requestHeaders, ParamRequest requestParameters, MultipartFormDataObject multipart,
final BodyHandler bodyHandler, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
requestHeaders.add(new RequestHeader("Content-Type", multipart.getContentType()));
addGenericHeaders("POST", uri, requestHeaders, context);
connection.post(uri, requestHeaders, multipart, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
/**
* Corresponds to the HTTP PUT method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param requestBody The optional request body to send.
* @param responseType The type of response to return.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public O put(final String relativePath, List requestHeaders, ParamRequest requestParameters, Object requestBody,
final Class responseType, final CallContext context) {
if (requestBody instanceof MultipartFormDataObject) {
return put(relativePath, requestHeaders, requestParameters, (MultipartFormDataObject) requestBody, responseType, context);
}
if (requestBody instanceof MultipartFormDataRequest) {
MultipartFormDataObject multipart = ((MultipartFormDataRequest) requestBody).toMultipartFormDataObject();
return put(relativePath, requestHeaders, requestParameters, multipart, responseType, context);
}
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
String requestJson = null;
if (requestBody != null) {
requestHeaders.add(new RequestHeader("Content-Type", "application/json"));
requestJson = marshaller.marshal(requestBody);
}
addGenericHeaders("PUT", uri, requestHeaders, context);
return connection.put(uri, requestHeaders, requestJson, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
@SuppressWarnings("resource")
private O put(final String relativePath, List requestHeaders, ParamRequest requestParameters, MultipartFormDataObject multipart,
final Class responseType, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
requestHeaders.add(new RequestHeader("Content-Type", multipart.getContentType()));
addGenericHeaders("PUT", uri, requestHeaders, context);
return connection.put(uri, requestHeaders, multipart, new ResponseHandler() {
@Override
public O handleResponse(int statusCode, InputStream bodyStream, List headers) {
return processResponse(statusCode, bodyStream, headers, responseType, relativePath, context);
}
});
}
/**
* Corresponds to the HTTP PUT method.
*
* @param relativePath The path to call, relative to the base URI.
* @param requestHeaders An optional list of request headers.
* @param requestParameters An optional set of request parameters.
* @param requestBody The optional request body to send.
* @param bodyHandler The handler for the response body.
* @param context The optional call context to use.
* @throws CommunicationException when an exception occurred communicating with the Ingenico ePayments platform
* @throws ResponseException when an error response was received from the Ingenico ePayments platform
* @throws ApiException when an error response was received from the Ingenico ePayments platform which contained a list of errors
*/
@SuppressWarnings("resource")
public void put(final String relativePath, List requestHeaders, ParamRequest requestParameters, Object requestBody,
final BodyHandler bodyHandler, final CallContext context) {
if (requestBody instanceof MultipartFormDataObject) {
put(relativePath, requestHeaders, requestParameters, (MultipartFormDataObject) requestBody, bodyHandler, context);
return;
}
if (requestBody instanceof MultipartFormDataRequest) {
MultipartFormDataObject multipart = ((MultipartFormDataRequest) requestBody).toMultipartFormDataObject();
put(relativePath, requestHeaders, requestParameters, multipart, bodyHandler, context);
return;
}
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
String requestJson = null;
if (requestBody != null) {
requestHeaders.add(new RequestHeader("Content-Type", "application/json"));
requestJson = marshaller.marshal(requestBody);
}
addGenericHeaders("PUT", uri, requestHeaders, context);
connection.put(uri, requestHeaders, requestJson, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
@SuppressWarnings("resource")
private void put(final String relativePath, List requestHeaders, ParamRequest requestParameters, MultipartFormDataObject multipart,
final BodyHandler bodyHandler, final CallContext context) {
Connection connection = session.getConnection();
List requestParameterList = requestParameters == null ? null : requestParameters.toRequestParameters();
URI uri = toAbsoluteURI(relativePath, requestParameterList);
if (requestHeaders == null) {
requestHeaders = new ArrayList();
}
requestHeaders.add(new RequestHeader("Content-Type", multipart.getContentType()));
addGenericHeaders("PUT", uri, requestHeaders, context);
connection.put(uri, requestHeaders, multipart, new ResponseHandler() {
@Override
public Void handleResponse(int statusCode, InputStream bodyStream, List headers) {
processResponse(statusCode, bodyStream, headers, bodyHandler, relativePath, context);
return null;
}
});
}
/**
* @return The {@link Marshaller} object associated with this communicator. Never {@code null}.
*/
public Marshaller getMarshaller() {
return marshaller;
}
protected URI toAbsoluteURI(String relativePath, List requestParameters) {
URI apiEndpoint = session.getApiEndpoint();
if (apiEndpoint.getPath() != null && !apiEndpoint.getPath().isEmpty()) {
throw new IllegalStateException("apiEndpoint should not contain a path");
}
if (apiEndpoint.getUserInfo() != null
|| apiEndpoint.getQuery() != null
|| apiEndpoint.getFragment() != null) {
throw new IllegalStateException("apiEndpoint should not contain user info, query or fragment");
}
String absolutePath;
if (relativePath.startsWith("/")) {
absolutePath = relativePath;
} else {
absolutePath = "/" + relativePath;
}
URIBuilder uriBuilder = new URIBuilder()
.setScheme(apiEndpoint.getScheme())
.setHost(apiEndpoint.getHost())
.setPort(apiEndpoint.getPort())
.setPath(absolutePath);
if (requestParameters != null) {
for (RequestParam nvp: requestParameters) {
uriBuilder.addParameter(nvp.getName(), nvp.getValue());
}
}
try {
return uriBuilder.build();
} catch (URISyntaxException e) {
throw new IllegalArgumentException("Unable to construct URI", e);
}
}
/**
* 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 {@code super.addGenericHeaders}
* at the end of your overridden method.
*/
protected void addGenericHeaders(String httpMethod, URI uri, List requestHeaders, CallContext context) {
// add server meta info headers
requestHeaders.addAll(session.getMetaDataProvider().getServerMetaDataHeaders());
// add date header
requestHeaders.add(new RequestHeader("Date", getHeaderDateString()));
// add context specific headers
if (context != null && context.getIdempotenceKey() != null) {
requestHeaders.add(new RequestHeader("X-GCS-Idempotence-Key", context.getIdempotenceKey()));
}
// add signature
Authenticator authenticator = session.getAuthenticator();
String authenticationSignature = authenticator.createSimpleAuthenticationSignature(httpMethod, uri, requestHeaders);
requestHeaders.add(new RequestHeader("Authorization", authenticationSignature));
}
/**
* Returns the date in the preferred format for the HTTP date header (RFC1123).
*/
protected String getHeaderDateString() {
Calendar calendar = Calendar.getInstance();
SimpleDateFormat dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);
dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
return dateFormat.format(calendar.getTime());
}
protected O processResponse(int statusCode, InputStream bodyStream, List headers, Class responseType,
String requestPath, CallContext context) {
if (context != null) {
updateContext(headers, context);
}
throwExceptionIfNecessary(statusCode, bodyStream, headers, requestPath);
return marshaller.unmarshal(bodyStream, responseType);
}
protected void processResponse(int statusCode, InputStream bodyStream, List headers, BodyHandler bodyHandler,
String requestPath, CallContext context) {
if (context != null) {
updateContext(headers, context);
}
throwExceptionIfNecessary(statusCode, bodyStream, headers, requestPath);
try {
bodyHandler.handleBody(bodyStream, headers);
} catch (IOException e) {
throw new BodyHandlerException(e);
}
}
/**
* Updates the given call context based on the contents of the given response.
*/
protected void updateContext(List headers, CallContext context) {
String idempotenceRequestTimestampValue = ResponseHeader.getHeaderValue(headers, "X-GCS-Idempotence-Request-Timestamp");
if (idempotenceRequestTimestampValue != null) {
Long idempotenceRequestTimestamp = Long.valueOf(idempotenceRequestTimestampValue);
context.setIdempotenceRequestTimestamp(idempotenceRequestTimestamp);
} else {
context.setIdempotenceRequestTimestamp(null);
}
}
/**
* Checks the status code and headers for errors and throws an exception if necessary.
*/
protected void throwExceptionIfNecessary(int statusCode, InputStream bodyStream, List headers, String requestPath) {
// status codes in the 100 or 300 range are not expected
if (statusCode < 200 || statusCode >= 300) {
String body = toString(bodyStream);
if (body != null && !body.isEmpty() && !isJson(headers)) {
ResponseException cause = new ResponseException(statusCode, body, headers);
if (statusCode == HttpStatus.SC_NOT_FOUND) {
throw new NotFoundException("The requested resource was not found; invalid path: " + requestPath, cause);
} else {
throw new CommunicationException(cause);
}
} else {
throw new ResponseException(statusCode, body, headers);
}
}
}
private String toString(InputStream bodyStream) {
try {
Reader reader = new InputStreamReader(bodyStream, CHARSET);
StringBuilder body = new StringBuilder();
char[] buffer = new char[4096];
int len;
while ((len = reader.read(buffer)) != -1) {
body.append(buffer, 0, len);
}
return body.toString();
} catch (IOException e) {
throw new CommunicationException(e);
}
}
private boolean isJson(List headers) {
String contentType = ResponseHeader.getHeaderValue(headers, "Content-Type");
return contentType == null || "application/json".equalsIgnoreCase(contentType) || contentType.toLowerCase().startsWith("application/json");
}
/**
* Utility method that delegates the call to this communicator's session's connection if that's an instance of
* {@link PooledConnection}. If not this method does nothing.
* @see PooledConnection#closeIdleConnections(long, TimeUnit)
*/
public void closeIdleConnections(long idleTime, TimeUnit timeUnit) {
@SuppressWarnings("resource")
Connection connection = session.getConnection();
if (connection instanceof PooledConnection) {
((PooledConnection) connection).closeIdleConnections(idleTime, timeUnit);
}
}
/**
* Utility method that delegates the call to this communicator's session's connection if that's an instance of
* {@link PooledConnection}. If not this method does nothing.
* @see PooledConnection#closeExpiredConnections()
*/
public void closeExpiredConnections() {
@SuppressWarnings("resource")
Connection connection = session.getConnection();
if (connection instanceof PooledConnection) {
((PooledConnection) connection).closeExpiredConnections();
}
}
@Override
public void enableLogging(CommunicatorLogger communicatorLogger) {
// delegate to the connection
session.getConnection().enableLogging(communicatorLogger);
}
@Override
public void disableLogging() {
// delegate to the connection
session.getConnection().disableLogging();
}
}