com.oracle.bmc.model

Class BmcException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.oracle.bmc.model.BmcException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthClientException, AuthServerException

public class BmcException
extends RuntimeException

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPC_REQUEST_ID_HEADER Name of the header that contains the request id.

Constructor Summary

Constructors

Constructor and Description
BmcException(boolean timeout, String message, Throwable cause, String opcRequestId)
BmcException(int statusCode, String serviceCode, String message, String opcRequestId)
BmcException(int statusCode, String serviceCode, String message, String opcRequestId, Throwable cause)

Method Summary

Modifier and Type	Method and Description
String	getMessage()
String	getOpcRequestId() The opc-request-id header returned by the service that should be provided for support requests.
String	getServiceCode() Service specific code returned.
int	getStatusCode() The HTTP status code.
boolean	isClientSide() Flag to indicate that the exception originated from the client and not from the service.
boolean	isTimeout() Flag to indicate that the request timed out.

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

Field Detail

OPC_REQUEST_ID_HEADER

public static final String OPC_REQUEST_ID_HEADER

Name of the header that contains the request id.

See Also:

Constant Field Values

Constructor Detail

BmcException

public BmcException(int statusCode,
                    String serviceCode,
                    String message,
                    String opcRequestId,
                    Throwable cause)

BmcException

public BmcException(int statusCode,
                    String serviceCode,
                    String message,
                    String opcRequestId)

BmcException

public BmcException(boolean timeout,
                    String message,
                    Throwable cause,
                    String opcRequestId)

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getStatusCode

public int getStatusCode()

The HTTP status code.

getServiceCode

public String getServiceCode()

Service specific code returned. Null if the client timed out or failed to get a response from the service.

isTimeout

public boolean isTimeout()

Flag to indicate that the request timed out. Status code and service code should not be used if this is true.

getOpcRequestId

public String getOpcRequestId()

The opc-request-id header returned by the service that should be provided for support requests.

If the client timed out or failed to get a response from the service, then this is the outbound request id, i.e. either the value for the OPC_REQUEST_ID_HEADER header set by the caller in an invocation callback, or otherwise a value automatically generated by the SDK.

isClientSide

public boolean isClientSide()

Flag to indicate that the exception originated from the client and not from the service. Status code and service code should not be used if this is true.