com.lexmark.saperion.exceptions.mappings

Enum SystemExceptionFactory.SystemErrors

java.lang.Object

java.lang.Enum<SystemExceptionFactory.SystemErrors>

com.lexmark.saperion.exceptions.mappings.SystemExceptionFactory.SystemErrors

All Implemented Interfaces:

ExceptionMapping<SystemException>, Serializable, Comparable<SystemExceptionFactory.SystemErrors>

Enclosing class:

SystemExceptionFactory

public static enum SystemExceptionFactory.SystemErrors
extends Enum<SystemExceptionFactory.SystemErrors>
implements ExceptionMapping<SystemException>

System error defintions.

Author:

owaeldrich

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATION_ERROR
AUTHENTICATION_INVALID_HEADER
AUTHENTICATION_INVALID_PASSWORD
AUTHENTICATION_INVALID_TENANT
AUTHENTICATION_PASSWORD_EXPIRED
AUTHENTICATION_UNKNOWN_SCHEME
BACKEND_CONFIGURATION_ERROR
BACKEND_SYSTEM_ERROR
PROTOCOL_INCOMPATIBLE_VERSION
PROTOCOL_MISSING_VERSION
SECURITY_ACCESS_DENIED
SECURITY_ERROR
SECURITY_TOKEN_EXPIRED
SECURITY_TOKEN_INCOSTENT
SECURITY_TOKEN_INVALID
SECURITY_TOKEN_UNKNOWN
SYSTEM_CONNECTION_INVALID
SYSTEM_CONNECTION_POOL_ERROR
SYSTEM_DESERIALIZATION_ERROR
SYSTEM_GENERAL_ERROR
SYSTEM_SERIALIZATION_ERROR

Method Summary

Modifier and Type	Method and Description
SystemException	createException(ErrorType fault, Throwable cause) Creates a new exception for the given server fault.
SystemException	createException(String message) Creates a new exception for the given server fault.
SystemException	createException(String message, Throwable cause) Creates a new exception for the given server fault.
SystemException	createException(Throwable cause) Creates a new exception for the given server fault.
ErrorCodeType	getErrorCode() Returns the error code this exception mapping applies to.
boolean	validate() Validates the integrity of the exception mapping.
static SystemExceptionFactory.SystemErrors	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemExceptionFactory.SystemErrors[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYSTEM_CONNECTION_INVALID

public static final SystemExceptionFactory.SystemErrors SYSTEM_CONNECTION_INVALID

SYSTEM_CONNECTION_POOL_ERROR

public static final SystemExceptionFactory.SystemErrors SYSTEM_CONNECTION_POOL_ERROR

SYSTEM_SERIALIZATION_ERROR

public static final SystemExceptionFactory.SystemErrors SYSTEM_SERIALIZATION_ERROR

SYSTEM_DESERIALIZATION_ERROR

public static final SystemExceptionFactory.SystemErrors SYSTEM_DESERIALIZATION_ERROR

PROTOCOL_MISSING_VERSION

public static final SystemExceptionFactory.SystemErrors PROTOCOL_MISSING_VERSION

PROTOCOL_INCOMPATIBLE_VERSION

public static final SystemExceptionFactory.SystemErrors PROTOCOL_INCOMPATIBLE_VERSION

BACKEND_SYSTEM_ERROR

public static final SystemExceptionFactory.SystemErrors BACKEND_SYSTEM_ERROR

BACKEND_CONFIGURATION_ERROR

public static final SystemExceptionFactory.SystemErrors BACKEND_CONFIGURATION_ERROR

SECURITY_ERROR

public static final SystemExceptionFactory.SystemErrors SECURITY_ERROR

SECURITY_ACCESS_DENIED

public static final SystemExceptionFactory.SystemErrors SECURITY_ACCESS_DENIED

AUTHENTICATION_ERROR

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_ERROR

AUTHENTICATION_UNKNOWN_SCHEME

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_UNKNOWN_SCHEME

AUTHENTICATION_INVALID_HEADER

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_INVALID_HEADER

AUTHENTICATION_INVALID_TENANT

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_INVALID_TENANT

AUTHENTICATION_INVALID_PASSWORD

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_INVALID_PASSWORD

AUTHENTICATION_PASSWORD_EXPIRED

public static final SystemExceptionFactory.SystemErrors AUTHENTICATION_PASSWORD_EXPIRED

SECURITY_TOKEN_UNKNOWN

public static final SystemExceptionFactory.SystemErrors SECURITY_TOKEN_UNKNOWN

SECURITY_TOKEN_EXPIRED

public static final SystemExceptionFactory.SystemErrors SECURITY_TOKEN_EXPIRED

SECURITY_TOKEN_INCOSTENT

public static final SystemExceptionFactory.SystemErrors SECURITY_TOKEN_INCOSTENT

SECURITY_TOKEN_INVALID

public static final SystemExceptionFactory.SystemErrors SECURITY_TOKEN_INVALID

SYSTEM_GENERAL_ERROR

public static final SystemExceptionFactory.SystemErrors SYSTEM_GENERAL_ERROR

Method Detail

values

public static SystemExceptionFactory.SystemErrors[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SystemExceptionFactory.SystemErrors c : SystemExceptionFactory.SystemErrors.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SystemExceptionFactory.SystemErrors valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createException

public SystemException createException(ErrorType fault,
                                       Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<SystemException>

Parameters:

fault - the server error

cause - the exception cause

Returns:

the new exception

createException

public SystemException createException(String message)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<SystemException>

Parameters:

message - the error message

Returns:

the new exception

createException

public SystemException createException(String message,
                                       Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<SystemException>

Parameters:

message - the error message

cause - the exception cause

Returns:

the new exception

createException

public SystemException createException(Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<SystemException>

Parameters:

cause - the exception cause

Returns:

the new exception

getErrorCode

public ErrorCodeType getErrorCode()

Description copied from interface: ExceptionMapping

Returns the error code this exception mapping applies to.

Specified by:

getErrorCode in interface ExceptionMapping<SystemException>

Returns:

the exception mapping's error code

validate

public boolean validate()

Description copied from interface: ExceptionMapping

Validates the integrity of the exception mapping. An exception mapping is valid if the mapped exception class can be instantiated and an appropriate factory constructor exists. Appropriate exception implementations must provide a factory constructors that consume an ErrorType and a Throwable.

Specified by:

validate in interface ExceptionMapping<SystemException>

Returns:

true if the mapping is valid and the mapped exception fits the design rules, otherwise false