com.aliyun.oss

Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.aliyun.oss.ServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OSSException

public class ServiceException
extends RuntimeException

This is the base exception class to represent any expected or unexpected OSS server side errors.

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.

On the other side, 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.

So generally speaking, the caller only needs to handle ServiceException properly as it means the request is processed, but not completely finished due to different errors. The error code in the exception is a good diagnostics information. Sometimes these exceptions are completely expected.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceException() Creates a default instance.
ServiceException(String errorMessage) Creates an instance with the error message.
ServiceException(String errorMessage, String errorCode, String requestId, String hostId) Creates an instance with error message, error code, request id, host id.
ServiceException(String errorMessage, String errorCode, String requestId, String hostId, String rawResponseError, Throwable cause) Creates an instance with error message, error code, request id, host id, OSS response error, and a Throwable instance.
ServiceException(String errorMessage, String errorCode, String requestId, String hostId, Throwable cause) Creates an instance with error message, error code, request id, host id.
ServiceException(String errorMessage, Throwable cause) Creates an instance with a Throwable instance and error message.
ServiceException(Throwable cause) Creates an instance with a Throwable instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getErrorCode() Gets the error code.
String	getErrorMessage() Gets error message.
String	getHostId() Gets the host id.
String	getMessage()
String	getRawResponseError() Gets the error message in OSS response.
String	getRequestId() Gets the request id.
void	setRawResponseError(String rawResponseError) Sets the error response from OSS.

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

ServiceException

public ServiceException()

Creates a default instance.

ServiceException

public ServiceException(String errorMessage)

Creates an instance with the error message.

Parameters:

errorMessage - Error message.

ServiceException

public ServiceException(Throwable cause)

Creates an instance with a Throwable instance.

Parameters:

cause - A Throwable instance.

ServiceException

public ServiceException(String errorMessage,
                Throwable cause)

Creates an instance with a Throwable instance and error message.

Parameters:

errorMessage - Error message.

cause - A Throwable instance.

ServiceException

public ServiceException(String errorMessage,
                String errorCode,
                String requestId,
                String hostId)

Creates an instance with error message, error code, request id, host id.

Parameters:

errorMessage - Error message.

errorCode - Error code.

requestId - Request Id.

hostId - Host Id.

ServiceException

public ServiceException(String errorMessage,
                String errorCode,
                String requestId,
                String hostId,
                Throwable cause)

Creates an instance with error message, error code, request id, host id.

Parameters:

errorMessage - Error message.

errorCode - Error code.

requestId - Request Id.

hostId - Host Id.

cause - A Throwable instance indicates a specific exception.

ServiceException

public ServiceException(String errorMessage,
                String errorCode,
                String requestId,
                String hostId,
                String rawResponseError,
                Throwable cause)

Creates an instance with error message, error code, request id, host id, OSS response error, and a Throwable instance.

Parameters:

errorMessage - Error message.

errorCode - Error code.

requestId - Request Id.

hostId - Host Id.

rawResponseError - OSS error message in response.

cause - A Throwable instance indicates a specific exception.

Method Detail

getErrorMessage

public String getErrorMessage()

Gets error message.

Returns:

Error message.

getErrorCode

public String getErrorCode()

Gets the error code.

Returns:

The error code in string.

getRequestId

public String getRequestId()

Gets the request id.

Returns:

The request Id in string.

getHostId

public String getHostId()

Gets the host id.

Returns:

The host Id in string.

getRawResponseError

public String getRawResponseError()

Gets the error message in OSS response.

Returns:

Error response in string.

setRawResponseError

public void setRawResponseError(String rawResponseError)

Sets the error response from OSS.

Parameters:

rawResponseError - The error response from OSS.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable