org.qas.api

Class AuthServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.qas.api.AuthClientException

org.qas.api.AuthServiceException

All Implemented Interfaces:

java.io.Serializable

public class AuthServiceException
extends AuthClientException

AuthServiceException

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthServiceException.ErrorType Indicates who is responsible for a failed request.

Field Summary

Fields inherited from class org.qas.api.AuthClientException

NL

Constructor Summary

Constructors

Constructor and Description
AuthServiceException(java.lang.String message) Constructs a new AuthServiceException with the specified message.
AuthServiceException(java.lang.String message, java.lang.Throwable cause) Constructs a new AuthServiceException with the specified message and exception indicating the root cause.

Method Summary

Modifier and Type	Method and Description
protected void	appendExceptionTo(java.lang.Appendable out, java.lang.Throwable e) Appends the exception information to appendable object.
java.lang.String	getErrorCode()
AuthServiceException.ErrorType	getErrorType()
java.lang.String	getRequestId()
java.lang.String	getServiceName()
int	getStatusCode()
void	setErrorCode(java.lang.String errorCode) Sets the error code represented by this exception.
void	setErrorType(AuthServiceException.ErrorType errorType) Sets the type of error represented by this exception, indicating if this exception was the caller's fault, or the service's fault.
void	setRequestId(java.lang.String requestId) Sets the request identifier for this exception.
void	setServiceName(java.lang.String serviceName) Sets the name of service that sent this error response.
void	setStatusCode(int statusCode) Sets the HTTP status code that was returned with this service exception.
AuthServiceException	withErrorCode(java.lang.String errorCode) Sets the error code represented by this exception and returns the updated AuthServiceException object.
AuthServiceException	withErrorType(AuthServiceException.ErrorType errorType) Sets the type of error represented by this exception, indicating if this exception was the caller's fault, or the service's fault and returns the updated AuthServiceException object.
AuthServiceException	withRequestId(java.lang.String requestId) Sets the request identifier for this exception.
AuthServiceException	withServiceName(java.lang.String serviceName) Sets the name of service that sent this error response and returns the updated AuthServiceException object.
AuthServiceException	withStatusCode(int statusCode) Sets the HTTP status code that was returned with this service exception and returns the updated AuthServiceException object.

Methods inherited from class org.qas.api.AuthClientException

printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthServiceException

public AuthServiceException(java.lang.String message)

Constructs a new AuthServiceException with the specified message.

Parameters:

message - An error message describing what went wrong.

AuthServiceException

public AuthServiceException(java.lang.String message,
                            java.lang.Throwable cause)

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

Parameters:

message - An error message describing what went wrong.

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

Method Detail

getServiceName

public java.lang.String getServiceName()

Returns:

the name of service that sent this error response.

setServiceName

public void setServiceName(java.lang.String serviceName)

Sets the name of service that sent this error response.

Parameters:

serviceName - the name of service that sent this error response.

withServiceName

public AuthServiceException withServiceName(java.lang.String serviceName)

Sets the name of service that sent this error response and returns the updated AuthServiceException object.

Parameters:

serviceName - the name of service that sent this error response.

Returns:

the updated AuthServiceException object with the new service name.

getErrorCode

public java.lang.String getErrorCode()

Returns:

the error code represented by this exception.

setErrorCode

public void setErrorCode(java.lang.String errorCode)

Sets the error code represented by this exception.

Parameters:

errorCode - the error code represented by this exception.

withErrorCode

public AuthServiceException withErrorCode(java.lang.String errorCode)

Sets the error code represented by this exception and returns the updated AuthServiceException object.

Parameters:

errorCode - the error code represented by this exception.

Returns:

the updated AuthServiceException object with the new error code.

getStatusCode

public int getStatusCode()

Returns:

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

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.

withStatusCode

public AuthServiceException withStatusCode(int statusCode)

Sets the HTTP status code that was returned with this service exception and returns the updated AuthServiceException object.

Parameters:

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

Returns:

the updated AuthServiceException object with the new status code.

getErrorType

public AuthServiceException.ErrorType getErrorType()

Returns:

A value indicating who is responsible for this exception.

setErrorType

public void setErrorType(AuthServiceException.ErrorType errorType)

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

Parameters:

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

withErrorType

public AuthServiceException withErrorType(AuthServiceException.ErrorType errorType)

Sets the type of error represented by this exception, indicating if this exception was the caller's fault, or the service's fault and returns the updated AuthServiceException object.

Parameters:

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

Returns:

the updated AuthServiceException object with the new error type.

getRequestId

public java.lang.String getRequestId()

Returns:

the request identifier that uniquely identifies the service request the caller made.

setRequestId

public void setRequestId(java.lang.String requestId)

Sets the request identifier for this exception.

Parameters:

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

withRequestId

public AuthServiceException withRequestId(java.lang.String requestId)

Sets the request identifier for this exception.

Parameters:

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

Returns:

the updated AuthServiceException object with the new request identifier.

appendExceptionTo

protected void appendExceptionTo(java.lang.Appendable out,
                                 java.lang.Throwable e)
                          throws java.io.IOException

Description copied from class: AuthClientException

Appends the exception information to appendable object.

Overrides:

appendExceptionTo in class AuthClientException

Parameters:

out - the specified appenable to append exception information to.

e - Throwable

Throws:

java.io.IOException - if