Package com.adobe.pdfservices.operation.exception

Class ServiceApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.adobe.pdfservices.operation.exception.ServiceApiException

All Implemented Interfaces:

Serializable

public class ServiceApiException
extends Exception

ServiceApiException is thrown when an underlying service API call results in an error.

See Also:

SDKException, ServiceUsageException, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	DEFAULT_ERROR_CODE	the default value of error code if there is no error code for this service failure.
int	DEFAULT_STATUS_CODE	the default value of status code if there is no status code for this service failure.

Constructor Summary

Constructors

Constructor	Description
ServiceApiException(String message)	Constructs a ServiceApiException with the specified detail message.
ServiceApiException(String message, String requestTrackingId, int statusCode)	Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.
ServiceApiException(String message, String requestTrackingId, int statusCode, String errorCode)	Constructs a ServiceApiException with the specified detail message, requestId, returned HTTP status code and error code.

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Returns the Error code or DEFAULT_ERROR_CODE if the error code doesn't adequately represent the error.
String	getMessage()	Returns the detail message of this exception.
String	getRequestTrackingId()	Returns the Request ID (the value of the X-Request-ID header).
int	getStatusCode()	Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_STATUS_CODE

public final int DEFAULT_STATUS_CODE

the default value of status code if there is no status code for this service failure.

See Also:

Constant Field Values

DEFAULT_ERROR_CODE

public final String DEFAULT_ERROR_CODE

the default value of error code if there is no error code for this service failure.

See Also:

Constant Field Values

Constructor Detail

ServiceApiException

public ServiceApiException(String message)

Constructs a ServiceApiException with the specified detail message.

Parameters:

message - exception detail message

ServiceApiException

public ServiceApiException(String message,
                           String requestTrackingId,
                           int statusCode)

Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.

Parameters:

message - exception detail message

requestTrackingId - X-Request-Id header value to track the request

statusCode - HTTP Status code returned in API response

ServiceApiException

public ServiceApiException(String message,
                           String requestTrackingId,
                           int statusCode,
                           String errorCode)

Constructs a ServiceApiException with the specified detail message, requestId, returned HTTP status code and error code.

Parameters:

message - exception detail message

requestTrackingId - X-Request-Id header value to track the request

statusCode - HTTP Status code returned in API response

errorCode - Error code returned in API response

Method Detail

getStatusCode

public int getStatusCode()

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.

Returns:

the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.

getErrorCode

public String getErrorCode()

Returns the Error code or DEFAULT_ERROR_CODE if the error code doesn't adequately represent the error.

Returns:

the Error code or DEFAULT_ERROR_CODE if the error code doesn't adequately represent the error.

getMessage

public String getMessage()

Returns the detail message of this exception.

Overrides:

getMessage in class Throwable

Returns:

the detail message

getRequestTrackingId

public String getRequestTrackingId()

Returns the Request ID (the value of the X-Request-ID header).

Returns:

Request ID