Skip navigation links

oracle.security.idaas.rest.jaxrs.client.sdk
Class OICClientException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.security.idaas.common.util.OICBaseException
oracle.security.idaas.rest.jaxrs.client.sdk.OICClientException

All Implemented Interfaces:

java.io.Serializable, oracle.security.idaas.common.util.OICException

public class OICClientException

extends oracle.security.idaas.common.util.OICBaseException

This class encapsulates exceptions that occur when using the clientsdk APIs. This class is common to all the methods of the clientsdk.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.security.idaas.common.util.OICBaseException

errorCode

Constructor Summary

OICClientException()

OICClientException(java.lang.String message)
Constructs a new OICClientException with the specified detail message.

OICClientException(java.lang.String message, java.lang.String errorCode)
Constructor to create an OICClientException using a message and error code.

OICClientException(java.lang.String message, java.lang.String code, java.lang.String oicErrorCode)
Constructor to create an OICClientException using a message and status code and oic-specific error code.

OICClientException(java.lang.String message, java.lang.String code, java.lang.String oicErrorCode, java.lang.String body)
Constructor to create an OICClientException using a message and status code and oic-specific error code and response body.

OICClientException(java.lang.String message, java.lang.String errorCode, java.lang.Throwable cause)
Constructor to create an OICClientException using a message and error code.

OICClientException(java.lang.String message, java.lang.Throwable cause)
Constructs a new OICClientException with the specified detail message and cause.

OICClientException(java.lang.Throwable cause)
Constructs a new OICClientException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

java.lang.String	getBody() For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set on the response and could be retrieved using this method.
java.lang.String	getCode() For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set on the response and could be retrieved using this method.
void	setBody(java.lang.String body) For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set.
void	setCode(java.lang.String code) For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set.
java.lang.String	toString()

Methods inherited from class oracle.security.idaas.common.util.OICBaseException

getErrorCode

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.security.idaas.common.util.OICException

getCause, getMessage

Constructor Detail

OICClientException

public OICClientException()

OICClientException

public OICClientException(java.lang.String message)

Constructs a new OICClientException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

OICClientException

public OICClientException(java.lang.String message,
                          java.lang.Throwable cause)

Constructs a new OICClientException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this OICClientException's detail message.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

OICClientException

public OICClientException(java.lang.Throwable cause)

Constructs a new OICClientException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables (for example, PrivilegedActionException).

Parameters:

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

OICClientException

public OICClientException(java.lang.String message,
                          java.lang.String errorCode)

Constructor to create an OICClientException using a message and error code.

Parameters:

message - is a message offering description of the exception.

errorCode - is the error code.

OICClientException

public OICClientException(java.lang.String message,
                          java.lang.String errorCode,
                          java.lang.Throwable cause)

Constructor to create an OICClientException using a message and error code.

Parameters:

message - is a message offering description of the exception.

errorCode - is the error code.

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

OICClientException

public OICClientException(java.lang.String message,
                          java.lang.String code,
                          java.lang.String oicErrorCode)

Constructor to create an OICClientException using a message and status code and oic-specific error code.

Parameters:

message - is a message offering description of the exception.

code - is the error code.

oicErrorCode - is the oic-specific error code usually returned by the REST server in a response json message in addition to status code and other typiocal response info.

OICClientException

public OICClientException(java.lang.String message,
                          java.lang.String code,
                          java.lang.String oicErrorCode,
                          java.lang.String body)

Constructor to create an OICClientException using a message and status code and oic-specific error code and response body.

Parameters:

message - is a message offering description of the exception.

code - is the error code.

oicErrorCode - is the oic-specific error code usually returned by the REST server in a response json message in addition to status code and other typiocal response info.

body - is the http response body

Method Detail

getCode

public java.lang.String getCode()

For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set on the response and could be retrieved using this method.

Returns:

error code of the exception.

setCode

public void setCode(java.lang.String code)

For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set. This would be set by the underlying client code, and this would likely not be used by clients of the sdk.

Parameters:

code - error code from the http response.

getBody

public java.lang.String getBody()

For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set on the response and could be retrieved using this method.

Returns:

http response body.

setBody

public void setBody(java.lang.String body)

For exceptions that resulted in a HTTP status code from the access to the server REST APIs, a string status code and description would be set. This would be set by the underlying client code, and this would likely not be used by clients of the sdk.

Parameters:

body - the http response body.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

Returns:

a string of the class name and fields' values.

Skip navigation links