com.aliyun.oss

Class ClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.aliyun.oss.ClientException

All Implemented Interfaces:

Serializable

public class ClientException
extends RuntimeException

This exception is the one thrown by the client side when accessing OSS.

ClientException is the class to represent any exception in OSS client side. Generally ClientException occurs either before sending the request or after receving the response from OSS server side. For example, if the network is broken when it tries to send a request, then the SDK will throw a ClientException instance.

ServiceException is converted from error code from OSS response. For example, when OSS tries to authenticate a request, if Access ID does not exist, the SDK will throw a ServiceException or its subclass instance with the specific error code, which the caller could handle that with specific logic.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientException() Creates a default instance.
ClientException(String errorMessage) Creates an instance with error message.
ClientException(String errorMessage, String errorCode, String requestId) Creates an instance with error message, error code, request Id
ClientException(String errorMessage, String errorCode, String requestId, Throwable cause) Creates an instance with error message, error code, request Id and an exception.
ClientException(String errorMessage, Throwable cause) Creates an instance with error message and an exception.
ClientException(Throwable cause) Creates an instance with an exception

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorCode() Get error code.
String	getErrorMessage() Get error message.
String	getMessage()
String	getRequestId() Gets request id.

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 Detail

ClientException

public ClientException()

Creates a default instance.

ClientException

public ClientException(String errorMessage)

Creates an instance with error message.

Parameters:

errorMessage - Error message.

ClientException

public ClientException(Throwable cause)

Creates an instance with an exception

Parameters:

cause - An exception.

ClientException

public ClientException(String errorMessage,
               Throwable cause)

Creates an instance with error message and an exception.

Parameters:

errorMessage - Error message.

cause - An exception.

ClientException

public ClientException(String errorMessage,
               String errorCode,
               String requestId)

Creates an instance with error message, error code, request Id

Parameters:

errorMessage - Error message.

errorCode - Error code, which typically is from a set of predefined errors. The handler code could do action based on this.

requestId - Request Id.

ClientException

public ClientException(String errorMessage,
               String errorCode,
               String requestId,
               Throwable cause)

Creates an instance with error message, error code, request Id and an exception.

Parameters:

errorMessage - Error message.

errorCode - Error code.

requestId - Request Id.

cause - An exception.

Method Detail

getErrorMessage

public String getErrorMessage()

Get error message.

Returns:

Error message in string.

getErrorCode

public String getErrorCode()

Get error code.

Returns:

Error code.

getRequestId

public String getRequestId()

Gets request id.

Returns:

The request Id.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable