Package org.forgerock.openig.fapi.apiclient.service

Class ApiClientServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.forgerock.openig.fapi.apiclient.service.ApiClientServiceException

All Implemented Interfaces:

Serializable

public class ApiClientServiceException
extends Exception

Exception raised when failures occur using an ApiClientService.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiClientServiceException.ErrorCode	Enumeration of possible error codes for the ApiClientServiceException.

Constructor Summary

Constructors

Constructor	Description
ApiClientServiceException(ApiClientServiceException.ErrorCode errorCode, String message)	Constructs a new ApiClientServiceException with the specified error code and message.
ApiClientServiceException(ApiClientServiceException.ErrorCode errorCode, String message, Throwable cause)	Constructs a new ApiClientServiceException with the specified error code, message, and cause.

Method Summary

Modifier and Type	Method	Description
Promise<Response,NeverThrowsException>	asPromise()	Build a Promise of a Response from the current exception.
Response	asResponse()	Build a Response from the current exception.
ApiClientServiceException.ErrorCode	getErrorCode()	Returns the error code associated with this exception.
String	getMessage()	Returns the detail message string of this exception, including the error code.

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

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

Constructor Details

ApiClientServiceException

public ApiClientServiceException(ApiClientServiceException.ErrorCode errorCode,
 String message)

Constructs a new ApiClientServiceException with the specified error code and message.

Parameters:

errorCode - the error code representing the type of error

message - the detail message

ApiClientServiceException

public ApiClientServiceException(ApiClientServiceException.ErrorCode errorCode,
 String message,
 Throwable cause)

Constructs a new ApiClientServiceException with the specified error code, message, and cause.

Parameters:

errorCode - the error code representing the type of error

message - the detail message

cause - the cause of the exception (a null value is permitted)

Method Details

getErrorCode

public ApiClientServiceException.ErrorCode getErrorCode()

Returns the error code associated with this exception.

Returns:

the error code

getMessage

public String getMessage()

Returns the detail message string of this exception, including the error code.

Overrides:

getMessage in class Throwable

Returns:

the detail message string of this exception

asPromise

public Promise<Response,NeverThrowsException> asPromise()

Build a Promise of a Response from the current exception.

Returns:

the Promise with the Response

asResponse

public Response asResponse()

Build a Response from the current exception.

Returns:

the Response built