com.qcloud.cos.exception

Class CosServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.qcloud.cos.exception.CosClientException

com.qcloud.cos.exception.CosServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MultiObjectDeleteException

public class CosServiceException
extends CosClientException

Extension of CosClientException that represents an error response returned by an Tencent Qcloud Cos. Receiving an exception of this type indicates that the caller's request was correctly transmitted to the service, but for some reason, the service was not able to process it, and returned an error response instead. CosServiceException provides callers several pieces of information that can be used to obtain more information about the error and why it occurred. In particular, the errorType field can be used to determine if the caller's request was invalid, or the service encountered an error on the server side while processing it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CosServiceException.ErrorType Indicates who is responsible (if known) for a failed request.

Constructor Summary

Constructors

Constructor and Description
CosServiceException(String errorMessage) Constructs a new CosServiceException with the specified message.
CosServiceException(String errorMessage, Exception cause) Constructs a new CosServiceException with the specified message and exception indicating the root cause.
CosServiceException(String message, String errorResponseXml) Constructs a new CosServiceException with the specified message and error response xml from Qcloud COS.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAdditionalDetails()
String	getErrorCode() Returns the COS error code represented by this exception.
String	getErrorMessage() return the human-readable error message provided by the service
String	getErrorResponseXml()
CosServiceException.ErrorType	getErrorType() Indicates who is responsible for this exception (caller, service, or unknown).
String	getMessage()
String	getRawResponseContent() Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP response from a service
String	getRequestId() Returns the COS request ID that uniquely identifies the service request the caller made.
int	getStatusCode() Returns the HTTP status code that was returned with this service exception.
String	getTraceId()
void	setAdditionalDetails(Map<String,String> additionalDetails)
void	setErrorCode(String errorCode) Sets the COS error code represented by this exception.
void	setErrorMessage(String value) Sets the human-readable error message provided by the service.
void	setErrorType(CosServiceException.ErrorType errorType) Sets the type of error represented by this exception (sender, receiver, or unknown), indicating if this exception was the caller's fault, or the service's fault.
void	setRawResponseContent(String rawResponseContent) Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP * response from a service
void	setRequestId(String requestId) Sets the COS requestId for this exception.
void	setStatusCode(int statusCode) Sets the HTTP status code that was returned with this service exception.
void	setTraceId(String tranceId)

Methods inherited from class com.qcloud.cos.exception.CosClientException

isRetryable

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

CosServiceException

public CosServiceException(String errorMessage)

Constructs a new CosServiceException with the specified message.

Parameters:

errorMessage - An error message describing what went wrong.

CosServiceException

public CosServiceException(String errorMessage,
                           Exception cause)

Constructs a new CosServiceException with the specified message and exception indicating the root cause.

Parameters:

errorMessage - An error message describing what went wrong.

cause - The root exception that caused this exception to be thrown.

CosServiceException

public CosServiceException(String message,
                           String errorResponseXml)

Constructs a new CosServiceException with the specified message and error response xml from Qcloud COS.

Parameters:

message - The error message describing why this exception was thrown.

errorResponseXml - The original error response XML received from Qcloud COS

See Also:

CosServiceException(String)

Method Detail

setRequestId

public void setRequestId(String requestId)

Sets the COS requestId for this exception.

Parameters:

requestId - The unique identifier for the service request the caller made.

getRequestId

public String getRequestId()

Returns the COS request ID that uniquely identifies the service request the caller made.

Returns:

The COS request ID that uniquely identifies the service request the caller made.

setErrorCode

public void setErrorCode(String errorCode)

Sets the COS error code represented by this exception.

Overrides:

setErrorCode in class CosClientException

Parameters:

errorCode - The COS error code represented by this exception.

getErrorCode

public String getErrorCode()

Returns the COS error code represented by this exception.

Overrides:

getErrorCode in class CosClientException

Returns:

The COS error code represented by this exception.

setErrorType

public void setErrorType(CosServiceException.ErrorType errorType)

Sets the type of error represented by this exception (sender, receiver, or unknown), indicating if this exception was the caller's fault, or the service's fault.

Parameters:

errorType - The type of error represented by this exception (sender or receiver), indicating if this exception was the caller's fault or the service's fault.

getErrorType

public CosServiceException.ErrorType getErrorType()

Indicates who is responsible for this exception (caller, service, or unknown).

Returns:

A value indicating who is responsible for this exception (caller, service, or unknown).

getErrorMessage

public String getErrorMessage()

return the human-readable error message provided by the service

Returns:

the human-readable error message provided by the service

setErrorMessage

public void setErrorMessage(String value)

Sets the human-readable error message provided by the service. NOTE: errorMessage by default is set to the same as the message value passed to the constructor of CosServiceException.

setStatusCode

public void setStatusCode(int statusCode)

Sets the HTTP status code that was returned with this service exception.

Parameters:

statusCode - The HTTP status code that was returned with this service exception.

getStatusCode

public int getStatusCode()

Returns the HTTP status code that was returned with this service exception.

Returns:

The HTTP status code that was returned with this service exception.

getTraceId

public String getTraceId()

setTraceId

public void setTraceId(String tranceId)

getAdditionalDetails

public Map<String,String> getAdditionalDetails()

setAdditionalDetails

public void setAdditionalDetails(Map<String,String> additionalDetails)

getErrorResponseXml

public String getErrorResponseXml()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getRawResponseContent

public String getRawResponseContent()

Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP response from a service

Returns:

The raw content of the HTTP response

setRawResponseContent

public void setRawResponseContent(String rawResponseContent)

Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP * response from a service

Parameters:

rawResponseContent - The raw content of the HTTP response