com.alibaba.sdk.android.oss

Class ServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.alibaba.sdk.android.oss.ServiceException

All Implemented Interfaces:

java.io.Serializable

public class ServiceException
extends java.lang.Exception

The OSS server side exception class definition.

ClientException means there're errors occurred when sending request to OSS or parsing the response from OSS. For example when the network is unavailable, this exception will be thrown.

ServiceException means there're errors occurred in OSS service side. For example, the Access Id does not exist for authentication, then ServiceException or its subclass is thrown. The ServiceException has the error code for the caller to have some specific handling.

Generally speaking, the caller only needs to handle ServiceException as it means the request has reached OSS, but there're some errors occurred. This error in most of cases are expected due to wrong parameters int the request or some wrong settings in user's account. The error code is very helpful for troubleshooting.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARSE_RESPONSE_FAIL

Constructor Summary

Constructors

Constructor and Description
ServiceException(int statusCode, java.lang.String message, java.lang.String errorCode, java.lang.String requestId, java.lang.String hostId, java.lang.String rawMessage) The constructor with status code, message, error code , request Id and host Id
ServiceException(int statusCode, java.lang.String message, java.lang.String errorCode, java.lang.String requestId, java.lang.String hostId, java.lang.String rawMessage, java.lang.String ec) The constructor with status code, message, error code , request Id and host Id

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEc()
java.lang.String	getErrorCode() Gets the error code
java.lang.String	getHostId() Gets the host Id
java.lang.String	getPartEtag()
java.lang.String	getPartNumber()
java.lang.String	getRawMessage()
java.lang.String	getRecommendDoc()
java.lang.String	getRequestId() Gets the request Id
int	getStatusCode() Gets the http status code
void	setPartEtag(java.lang.String partEtag)
void	setPartNumber(java.lang.String partNumber)
void	setRecommendDoc(java.lang.String recommendDoc)
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_RESPONSE_FAIL

public static final java.lang.String PARSE_RESPONSE_FAIL

See Also:

Constant Field Values

Constructor Detail

ServiceException

public ServiceException(int statusCode,
                        java.lang.String message,
                        java.lang.String errorCode,
                        java.lang.String requestId,
                        java.lang.String hostId,
                        java.lang.String rawMessage)

The constructor with status code, message, error code , request Id and host Id

Parameters:

statusCode - HTTP status code

message - error message

errorCode - error code

requestId - Request ID

hostId - Host ID

ServiceException

public ServiceException(int statusCode,
                        java.lang.String message,
                        java.lang.String errorCode,
                        java.lang.String requestId,
                        java.lang.String hostId,
                        java.lang.String rawMessage,
                        java.lang.String ec)

The constructor with status code, message, error code , request Id and host Id

Parameters:

statusCode - HTTP status code

message - error message

errorCode - error code

requestId - Request ID

hostId - Host ID

ec - ec code

Method Detail

getPartNumber

public java.lang.String getPartNumber()

setPartNumber

public void setPartNumber(java.lang.String partNumber)

getPartEtag

public java.lang.String getPartEtag()

setPartEtag

public void setPartEtag(java.lang.String partEtag)

getStatusCode

public int getStatusCode()

Gets the http status code

Returns:

getErrorCode

public java.lang.String getErrorCode()

Gets the error code

Returns:

error code in string

getRequestId

public java.lang.String getRequestId()

Gets the request Id

Returns:

Request Id

getHostId

public java.lang.String getHostId()

Gets the host Id

Returns:

Host Id

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

getRawMessage

public java.lang.String getRawMessage()

Returns:

The raw message

getEc

public java.lang.String getEc()

getRecommendDoc

public java.lang.String getRecommendDoc()

setRecommendDoc

public void setRecommendDoc(java.lang.String recommendDoc)