com.netease.cloud.ServiceException Maven / Gradle / Ivy
Show all versions of nos-sdk-java-publiccloud Show documentation
package com.netease.cloud;
/**
* Extension of ClientException that represents an error response returned by an
* web service. 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.
*
* ServiceException 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.
*/
public class ServiceException extends ClientException {
private static final long serialVersionUID = 1L;
/**
* Indicates who is responsible (if known) for a failed request.
*
*
* For example, if a client is using an invalid access key, the returned
* exception will indicate that there is an error in the request the caller
* is sending. Retrying that same request will *not* result in a successful
* response. The Client ErrorType indicates that there is a problem in the
* request the user is sending (ex: incorrect access keys, invalid parameter
* value, missing parameter, etc.), and that the caller must take some
* action to correct the request before it should be resent. Client errors
* are typically associated an HTTP error code in the 4xx range.
*
*
* The Service ErrorType indicates that although the request the caller sent
* was valid, the service was unable to fulfill the request because of
* problems on the service's side. These types of errors can be retried by
* the caller since the caller's request was valid and the problem occurred
* while processing the request on the service side. Service errors will be
* accompanied by an HTTP error code in the 5xx range.
*
*
* Finally, if there isn't enough information to determine who's fault the
* error response is, an Unknown ErrorType will be set.
*/
public enum ErrorType {
Client, Service, Unknown
}
/**
* The unique identifier for the service request the caller made.
*/
private String requestId;
/**
* The error code represented by this exception (ex: InvalidParameterValue).
*/
private String errorCode;
private String resource;
/**
* Indicates (if known) whether this exception was the fault of the caller
* or the service.
*
* @see ErrorType
*/
private ErrorType errorType = ErrorType.Unknown;
/** The HTTP status code that was returned with this error */
private int statusCode;
/**
* The name of the service that sent this error response.
*/
private String serviceName;
/**
* Constructs a new ServiceException with the specified message.
*
* @param message
* An error message describing what went wrong.
*/
public ServiceException(String message) {
super(message);
}
/**
* Constructs a new ServiceException with the specified message and
* exception indicating the root cause.
*
* @param message
* An error message describing what went wrong.
* @param cause
* The root exception that caused this exception to be thrown.
*/
public ServiceException(String message, Exception cause) {
super(message, cause);
}
/**
* Sets the requestId for this exception.
*
* @param requestId
* The unique identifier for the service request the caller made.
*/
public void setRequestId(String requestId) {
this.requestId = requestId;
}
/**
* Returns the request ID that uniquely identifies the service request the
* caller made.
*
* @return The request ID that uniquely identifies the service request the
* caller made.
*/
public String getRequestId() {
return requestId;
}
/**
* Sets the name of the service that sent this error response.
*
* @param serviceName
* The name of the service that sent this error response.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
* Returns the name of the service that sent this error response.
*
* @return The name of the service that sent this error response.
*/
public String getServiceName() {
return serviceName;
}
/**
* Sets the error code represented by this exception.
*
* @param errorCode
* The error code represented by this exception.
*/
public void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
/**
* Returns the error code represented by this exception.
*
* @return The error code represented by this exception.
*/
public String getErrorCode() {
return errorCode;
}
/**
* 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.
*
* @param 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.
*/
public void setErrorType(ErrorType errorType) {
this.errorType = errorType;
}
/**
* Indicates who is responsible for this exception (caller, service, or
* unknown).
*
* @return A value indicating who is responsible for this exception (caller,
* service, or unknown).
*/
public ErrorType getErrorType() {
return errorType;
}
/**
* Sets the HTTP status code that was returned with this service exception.
*
* @param statusCode
* The HTTP status code that was returned with this service
* exception.
*/
public void setStatusCode(int statusCode) {
this.statusCode = statusCode;
}
/**
* Returns the HTTP status code that was returned with this service
* exception.
*
* @return The HTTP status code that was returned with this service
* exception.
*/
public int getStatusCode() {
return statusCode;
}
public String getResource() {
return resource;
}
public void setResource(String resource) {
this.resource = resource;
}
/**
* Returns a string summary of the details of this exception including the
* HTTP status code, request ID, error code and error message.
*
* @see java.lang.Throwable#toString()
*/
@Override
public String toString() {
return "Status Code: " + getStatusCode() + ", " + "Service: " + getServiceName() + ", " + "Request ID: "
+ getRequestId() + ", " + "Error Code: " + getErrorCode() + ", " + "Error Message: " + getMessage()
+ ", " + "Error Resource: " + getResource();
}
}