com.ingenico.connect.gateway.sdk.java.ApiException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation

SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API

There is a newer version: 6.47.0

package com.ingenico.connect.gateway.sdk.java;

import java.util.Collections;
import java.util.List;

import com.ingenico.connect.gateway.sdk.java.domain.errors.definitions.APIError;

/**
 * Represents an error response from the Ingenico ePayments platform which contains an ID and a list of errors.
 */
@SuppressWarnings("serial")
public class ApiException extends RuntimeException {

	private final int statusCode;
	private final String responseBody;
	private final String errorId;
	private final List errors;

	public ApiException(int statusCode, String responseBody, String errorId, List errors) {
		this("the Ingenico ePayments platform returned an error response", statusCode, responseBody, errorId, errors);
	}

	public ApiException(String message, int statusCode, String responseBody, String errorId, List errors) {
		super(message);
		this.statusCode = statusCode;
		this.responseBody = responseBody;
		this.errorId = errorId;
		this.errors = errors == null ? Collections.emptyList() : errors;
	}

	/**
	 * @return The HTTP status code that was returned by the Ingenico ePayments platform.
	 */
	public int getStatusCode() {
		return statusCode;
	}

	/**
	 * @return The raw response body that was returned by the Ingenico ePayments platform.
	 */
	public String getResponseBody() {
		return responseBody;
	}

	/**
	 * @return The error ID received from the Ingenico ePayments platform if available.
	 */
	public String getErrorId() {
		return errorId;
	}

	/**
	 * @return The error list received from the Ingenico ePayments platform if available. Never {@code null}.
	 */
	public List getErrors() {
		return errors;
	}

	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder(super.toString());
		if (statusCode > 0) {
			sb.append("; statusCode=").append(statusCode);
		}
		if (responseBody != null && responseBody.length() > 0) {
			sb.append("; responseBody='").append(responseBody).append("'");
		}
		return sb.toString();
	}
}