org.xmlBlaster.util.def
Class ErrorCode

java.lang.Object
  org.xmlBlaster.util.def.ErrorCode

All Implemented Interfaces:

java.io.Serializable

public final class ErrorCode
extends java.lang.Object
implements java.io.Serializable

This class holds an enumeration error codes.

If you need new error code add it here following the same schema.

The documentation is created by examining this class with it links.

Author:

xmlBlaster@marcelruff.info

See Also:

The admin.errorcodes requirement, Serialized Form

Nested Class Summary

private static class

ErrorCode.SerializedForm A helper class for singleton serialization.

Field Summary

static ErrorCode	COMMUNICATION
static ErrorCode	COMMUNICATION_FORCEASYNC
static ErrorCode	COMMUNICATION_NOCONNECTION
static ErrorCode	COMMUNICATION_NOCONNECTION_CALLBACKSERVER_NOTAVAILABLE
static ErrorCode	COMMUNICATION_NOCONNECTION_DEAD
static ErrorCode	COMMUNICATION_NOCONNECTION_POLLING
static ErrorCode	COMMUNICATION_NOCONNECTION_SERVERDENY
static ErrorCode	COMMUNICATION_RESOURCE_TEMPORARY_UNAVAILABLE
static ErrorCode	COMMUNICATION_RESPONSETIMEOUT
static ErrorCode	COMMUNICATION_TIMEOUT
static ErrorCode	COMMUNICATION_USER_HOLDBACK
private java.lang.String	description
private java.lang.String	errorCode
private static java.util.TreeMap	errorCodeMap
static ErrorCode	INTERNAL
static ErrorCode	INTERNAL_CONNECTIONFAILURE
static ErrorCode	INTERNAL_DISCONNECT
static ErrorCode	INTERNAL_ERASE
static ErrorCode	INTERNAL_GET
static ErrorCode	INTERNAL_ILLEGALARGUMENT
static ErrorCode	INTERNAL_ILLEGALSTATE
static ErrorCode	INTERNAL_INTERRUPTED
static ErrorCode	INTERNAL_NOTIMPLEMENTED
static ErrorCode	INTERNAL_NULLPOINTER
static ErrorCode	INTERNAL_PUBLISH
static ErrorCode	INTERNAL_PUBLISH_ARR
static ErrorCode	INTERNAL_STOP
static ErrorCode	INTERNAL_SUBSCRIBE
static ErrorCode	INTERNAL_UNKNOWN
static ErrorCode	INTERNAL_UNSUBSCRIBE
static ErrorCode	LEGACY
static ErrorCode	RESOURCE
static ErrorCode	RESOURCE_ADMIN_UNAVAILABLE
static ErrorCode	RESOURCE_CALLBACKSERVER_CREATION
static ErrorCode	RESOURCE_CLUSTER_CIRCULARLOOP
static ErrorCode	RESOURCE_CLUSTER_NOTAVAILABLE
static ErrorCode	RESOURCE_CONFIGURATION
static ErrorCode	RESOURCE_CONFIGURATION_ADDRESS
static ErrorCode	RESOURCE_CONFIGURATION_CONNECT
static ErrorCode	RESOURCE_CONFIGURATION_PLUGINFAILED
static ErrorCode	RESOURCE_CONFIGURATION_SSLSOCKET
static ErrorCode	RESOURCE_CONFIGURATION_XML
static ErrorCode	RESOURCE_DB_BLOCK
static ErrorCode	RESOURCE_DB_UNAVAILABLE
static ErrorCode	RESOURCE_DB_UNKNOWN
static ErrorCode	RESOURCE_EXHAUST
static ErrorCode	RESOURCE_FILEIO
static ErrorCode	RESOURCE_FILEIO_FILELOST
static ErrorCode	RESOURCE_MAINTENANCE
static ErrorCode	RESOURCE_OUTOFMEMORY
static ErrorCode	RESOURCE_OVERFLOW_QUEUE_BYTES
static ErrorCode	RESOURCE_OVERFLOW_QUEUE_ENTRIES
static ErrorCode	RESOURCE_TEMPORARY_UNAVAILABLE
static ErrorCode	RESOURCE_TOO_MANY_THREADS
static ErrorCode	RESOURCE_UNAVAILABLE
private ResourceInfo[]	resourceInfos
private static long	serialVersionUID
static ErrorCode	USER
static ErrorCode	USER_ADMIN_INVALID
static ErrorCode	USER_CLIENTCODE
static ErrorCode	USER_CONFIGURATION
static ErrorCode	USER_CONFIGURATION_IDENTICALCLIENT
static ErrorCode	USER_CONFIGURATION_MAXSESSION
static ErrorCode	USER_CONNECT
static ErrorCode	USER_CONNECT_MULTIPLE
static ErrorCode	USER_ILLEGALARGUMENT
static ErrorCode	USER_JDBC_INVALID
static ErrorCode	USER_MESSAGE_INVALID
static ErrorCode	USER_NOT_CONNECTED
static ErrorCode	USER_OID_UNKNOWN
static ErrorCode	USER_PTP_DENIED
static ErrorCode	USER_PTP_UNKNOWNDESTINATION
static ErrorCode	USER_PTP_UNKNOWNDESTINATION_SESSION
static ErrorCode	USER_PTP_UNKNOWNSESSION
static ErrorCode	USER_PUBLISH
static ErrorCode	USER_PUBLISH_READONLY
static ErrorCode	USER_QUERY_INVALID
static ErrorCode	USER_QUERY_TYPE_INVALID
static ErrorCode	USER_SECURITY
static ErrorCode	USER_SECURITY_AUTHENTICATION
static ErrorCode	USER_SECURITY_AUTHENTICATION_ACCESSDENIED
static ErrorCode	USER_SECURITY_AUTHENTICATION_ACCESSDENIED_UNKNOWNLOGINNAME
static ErrorCode	USER_SECURITY_AUTHENTICATION_ACCESSDENIED_WRONGPASSWORD
static ErrorCode	USER_SECURITY_AUTHENTICATION_EXPIRED
static ErrorCode	USER_SECURITY_AUTHENTICATION_ILLEGALARGUMENT
static ErrorCode	USER_SECURITY_AUTHENTICATION_ILLEGALDEVICEID
static ErrorCode	USER_SECURITY_AUTHENTICATION_ILLEGALDEVICETYPE
static ErrorCode	USER_SECURITY_AUTHENTICATION_INACTIVE
static ErrorCode	USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED
static ErrorCode	USER_SUBSCRIBE_ID
static ErrorCode	USER_SUBSCRIBE_NOCALLBACK
static ErrorCode	USER_UPDATE_DEADMESSAGE
static ErrorCode	USER_UPDATE_ERROR
static ErrorCode	USER_UPDATE_HOLDBACK
static ErrorCode	USER_UPDATE_ILLEGALARGUMENT
static ErrorCode	USER_UPDATE_INTERNALERROR
static ErrorCode	USER_UPDATE_SECURITY_AUTHENTICATION_ACCESSDENIED
static ErrorCode	USER_VERSION
static ErrorCode	USER_WRONG_API_USAGE

Constructor Summary

private

ErrorCode(java.lang.String errorCode, java.lang.String description, ResourceInfo[] resourceInfos)

Method Summary

boolean	equals(ErrorCode other)
static ErrorCode	getCategory(ErrorCode errorCode)
static ErrorCode	getCategory(java.lang.String errorCode)
java.lang.String	getDescription() Returns the description of the errorCode.
java.lang.String	getErrorCode() Returns the errorCode string.
java.lang.String	getLongDescription() Returns the description of the errorCode including the online link with further explanations.
ResourceInfo[]	getResourceInfos() Return resource info object telling us where to find more information on this errorCode
java.lang.String	getUrl() The link to find more information about this problem
boolean	isOfType(ErrorCode baseCode) Returns 'true' if this error code is a 'child' of the error code specified in baseCode.
static void	main(java.lang.String[] args) Generate a requirement file for all error codes.
static ErrorCode	toErrorCode(java.lang.String errorCode) Returns the ErrorCode object for the given String error code.
static ErrorCode	toErrorCode(java.lang.String errorCode, ErrorCode fallback) Returns the ErrorCode object for the given String error code.
static java.lang.String	toHtmlTable() Generate a HTML table listing of all error codes.
static java.lang.String	toPlainList() Dump a plain list of all errorCodes.
static java.lang.String	toRequirement()
java.lang.String	toString() Return a human readable string of the errorCode and description
java.lang.String	toXml(java.lang.String extraOffset)
static java.lang.String	toXmlAll(java.lang.String extraOffset)
private static void	verifySerialization()
java.lang.Object	writeReplace() This code is a helper for serialization so that after deserial the check

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

errorCodeMap

private static final java.util.TreeMap errorCodeMap

errorCode

private final java.lang.String errorCode

description

private final java.lang.String description

resourceInfos

private final ResourceInfo[] resourceInfos

LEGACY

public static final ErrorCode LEGACY

INTERNAL

public static final ErrorCode INTERNAL

INTERNAL_UNKNOWN

public static final ErrorCode INTERNAL_UNKNOWN

INTERNAL_NULLPOINTER

public static final ErrorCode INTERNAL_NULLPOINTER

INTERNAL_ILLEGALARGUMENT

public static final ErrorCode INTERNAL_ILLEGALARGUMENT

INTERNAL_INTERRUPTED

public static final ErrorCode INTERNAL_INTERRUPTED

INTERNAL_NOTIMPLEMENTED

public static final ErrorCode INTERNAL_NOTIMPLEMENTED

INTERNAL_CONNECTIONFAILURE

public static final ErrorCode INTERNAL_CONNECTIONFAILURE

INTERNAL_ILLEGALSTATE

public static final ErrorCode INTERNAL_ILLEGALSTATE

INTERNAL_DISCONNECT

public static final ErrorCode INTERNAL_DISCONNECT

INTERNAL_SUBSCRIBE

public static final ErrorCode INTERNAL_SUBSCRIBE

INTERNAL_UNSUBSCRIBE

public static final ErrorCode INTERNAL_UNSUBSCRIBE

INTERNAL_PUBLISH

public static final ErrorCode INTERNAL_PUBLISH

INTERNAL_PUBLISH_ARR

public static final ErrorCode INTERNAL_PUBLISH_ARR

INTERNAL_ERASE

public static final ErrorCode INTERNAL_ERASE

INTERNAL_GET

public static final ErrorCode INTERNAL_GET

INTERNAL_STOP

public static final ErrorCode INTERNAL_STOP

RESOURCE

public static final ErrorCode RESOURCE

RESOURCE_MAINTENANCE

public static final ErrorCode RESOURCE_MAINTENANCE

RESOURCE_OUTOFMEMORY

public static final ErrorCode RESOURCE_OUTOFMEMORY

RESOURCE_TOO_MANY_THREADS

public static final ErrorCode RESOURCE_TOO_MANY_THREADS

RESOURCE_EXHAUST

public static final ErrorCode RESOURCE_EXHAUST

RESOURCE_CALLBACKSERVER_CREATION

public static final ErrorCode RESOURCE_CALLBACKSERVER_CREATION

RESOURCE_OVERFLOW_QUEUE_BYTES

public static final ErrorCode RESOURCE_OVERFLOW_QUEUE_BYTES

RESOURCE_OVERFLOW_QUEUE_ENTRIES

public static final ErrorCode RESOURCE_OVERFLOW_QUEUE_ENTRIES

RESOURCE_UNAVAILABLE

public static final ErrorCode RESOURCE_UNAVAILABLE

RESOURCE_TEMPORARY_UNAVAILABLE

public static final ErrorCode RESOURCE_TEMPORARY_UNAVAILABLE

RESOURCE_DB_UNAVAILABLE

public static final ErrorCode RESOURCE_DB_UNAVAILABLE

RESOURCE_DB_BLOCK

public static final ErrorCode RESOURCE_DB_BLOCK

RESOURCE_DB_UNKNOWN

public static final ErrorCode RESOURCE_DB_UNKNOWN

RESOURCE_ADMIN_UNAVAILABLE

public static final ErrorCode RESOURCE_ADMIN_UNAVAILABLE

RESOURCE_CONFIGURATION

public static final ErrorCode RESOURCE_CONFIGURATION

RESOURCE_CONFIGURATION_CONNECT

public static final ErrorCode RESOURCE_CONFIGURATION_CONNECT

RESOURCE_CONFIGURATION_PLUGINFAILED

public static final ErrorCode RESOURCE_CONFIGURATION_PLUGINFAILED

RESOURCE_CONFIGURATION_XML

public static final ErrorCode RESOURCE_CONFIGURATION_XML

RESOURCE_CONFIGURATION_SSLSOCKET

public static final ErrorCode RESOURCE_CONFIGURATION_SSLSOCKET

RESOURCE_CONFIGURATION_ADDRESS

public static final ErrorCode RESOURCE_CONFIGURATION_ADDRESS

RESOURCE_FILEIO

public static final ErrorCode RESOURCE_FILEIO

RESOURCE_FILEIO_FILELOST

public static final ErrorCode RESOURCE_FILEIO_FILELOST

RESOURCE_CLUSTER_NOTAVAILABLE

public static final ErrorCode RESOURCE_CLUSTER_NOTAVAILABLE

RESOURCE_CLUSTER_CIRCULARLOOP

public static final ErrorCode RESOURCE_CLUSTER_CIRCULARLOOP

COMMUNICATION

public static final ErrorCode COMMUNICATION

COMMUNICATION_RESOURCE_TEMPORARY_UNAVAILABLE

public static final ErrorCode COMMUNICATION_RESOURCE_TEMPORARY_UNAVAILABLE

COMMUNICATION_NOCONNECTION

public static final ErrorCode COMMUNICATION_NOCONNECTION

COMMUNICATION_TIMEOUT

public static final ErrorCode COMMUNICATION_TIMEOUT

COMMUNICATION_RESPONSETIMEOUT

public static final ErrorCode COMMUNICATION_RESPONSETIMEOUT

COMMUNICATION_FORCEASYNC

public static final ErrorCode COMMUNICATION_FORCEASYNC

COMMUNICATION_NOCONNECTION_SERVERDENY

public static final ErrorCode COMMUNICATION_NOCONNECTION_SERVERDENY

COMMUNICATION_NOCONNECTION_CALLBACKSERVER_NOTAVAILABLE

public static final ErrorCode COMMUNICATION_NOCONNECTION_CALLBACKSERVER_NOTAVAILABLE

COMMUNICATION_NOCONNECTION_POLLING

public static final ErrorCode COMMUNICATION_NOCONNECTION_POLLING

COMMUNICATION_NOCONNECTION_DEAD

public static final ErrorCode COMMUNICATION_NOCONNECTION_DEAD

COMMUNICATION_USER_HOLDBACK

public static final ErrorCode COMMUNICATION_USER_HOLDBACK

USER

public static final ErrorCode USER

USER_UPDATE_HOLDBACK

public static final ErrorCode USER_UPDATE_HOLDBACK

USER_UPDATE_DEADMESSAGE

public static final ErrorCode USER_UPDATE_DEADMESSAGE

USER_WRONG_API_USAGE

public static final ErrorCode USER_WRONG_API_USAGE

USER_CONFIGURATION

public static final ErrorCode USER_CONFIGURATION

USER_VERSION

public static final ErrorCode USER_VERSION

USER_CONFIGURATION_MAXSESSION

public static final ErrorCode USER_CONFIGURATION_MAXSESSION

USER_CONFIGURATION_IDENTICALCLIENT

public static final ErrorCode USER_CONFIGURATION_IDENTICALCLIENT

USER_SECURITY

public static final ErrorCode USER_SECURITY

USER_SECURITY_AUTHENTICATION

public static final ErrorCode USER_SECURITY_AUTHENTICATION

USER_SECURITY_AUTHENTICATION_ACCESSDENIED

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ACCESSDENIED

USER_SECURITY_AUTHENTICATION_ILLEGALDEVICEID

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ILLEGALDEVICEID

USER_SECURITY_AUTHENTICATION_ILLEGALDEVICETYPE

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ILLEGALDEVICETYPE

USER_SECURITY_AUTHENTICATION_ACCESSDENIED_UNKNOWNLOGINNAME

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ACCESSDENIED_UNKNOWNLOGINNAME

USER_SECURITY_AUTHENTICATION_ACCESSDENIED_WRONGPASSWORD

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ACCESSDENIED_WRONGPASSWORD

USER_SECURITY_AUTHENTICATION_INACTIVE

public static final ErrorCode USER_SECURITY_AUTHENTICATION_INACTIVE

USER_SECURITY_AUTHENTICATION_EXPIRED

public static final ErrorCode USER_SECURITY_AUTHENTICATION_EXPIRED

USER_SECURITY_AUTHENTICATION_ILLEGALARGUMENT

public static final ErrorCode USER_SECURITY_AUTHENTICATION_ILLEGALARGUMENT

USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED

public static final ErrorCode USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED

USER_UPDATE_ERROR

public static final ErrorCode USER_UPDATE_ERROR

USER_UPDATE_INTERNALERROR

public static final ErrorCode USER_UPDATE_INTERNALERROR

USER_UPDATE_ILLEGALARGUMENT

public static final ErrorCode USER_UPDATE_ILLEGALARGUMENT

USER_ILLEGALARGUMENT

public static final ErrorCode USER_ILLEGALARGUMENT

USER_UPDATE_SECURITY_AUTHENTICATION_ACCESSDENIED

public static final ErrorCode USER_UPDATE_SECURITY_AUTHENTICATION_ACCESSDENIED

USER_PUBLISH_READONLY

public static final ErrorCode USER_PUBLISH_READONLY

USER_SUBSCRIBE_ID

public static final ErrorCode USER_SUBSCRIBE_ID

USER_SUBSCRIBE_NOCALLBACK

public static final ErrorCode USER_SUBSCRIBE_NOCALLBACK

USER_OID_UNKNOWN

public static final ErrorCode USER_OID_UNKNOWN

USER_JDBC_INVALID

public static final ErrorCode USER_JDBC_INVALID

USER_CONNECT

public static final ErrorCode USER_CONNECT

USER_CONNECT_MULTIPLE

public static final ErrorCode USER_CONNECT_MULTIPLE

USER_NOT_CONNECTED

public static final ErrorCode USER_NOT_CONNECTED

USER_PUBLISH

public static final ErrorCode USER_PUBLISH

USER_PTP_UNKNOWNSESSION

public static final ErrorCode USER_PTP_UNKNOWNSESSION

USER_PTP_UNKNOWNDESTINATION

public static final ErrorCode USER_PTP_UNKNOWNDESTINATION

USER_PTP_UNKNOWNDESTINATION_SESSION

public static final ErrorCode USER_PTP_UNKNOWNDESTINATION_SESSION

USER_PTP_DENIED

public static final ErrorCode USER_PTP_DENIED

USER_MESSAGE_INVALID

public static final ErrorCode USER_MESSAGE_INVALID

USER_QUERY_INVALID

public static final ErrorCode USER_QUERY_INVALID

USER_ADMIN_INVALID

public static final ErrorCode USER_ADMIN_INVALID

USER_QUERY_TYPE_INVALID

public static final ErrorCode USER_QUERY_TYPE_INVALID

USER_CLIENTCODE

public static final ErrorCode USER_CLIENTCODE

Constructor Detail

ErrorCode

private ErrorCode(java.lang.String errorCode,
                  java.lang.String description,
                  ResourceInfo[] resourceInfos)

Throws:

java.lang.IllegalArgumentException - if the given errorCode is null

Method Detail

toString

public java.lang.String toString()

Return a human readable string of the errorCode and description

Overrides:

toString in class java.lang.Object

Returns:

never null

isOfType

public final boolean isOfType(ErrorCode baseCode)

Returns 'true' if this error code is a 'child' of the error code specified in baseCode. It follows the name convention of the error code. For example USER_SECURITY_AUTHENTICATION_DENIED would be of type (as it is a subtype) of USER_SECURITY_AUTHENTICATION If one of the error codes code name is null, false is returned.

Parameters:

baseCode - the base ErrorCode to check against. If null, false is returned.

Returns:

getErrorCode

public java.lang.String getErrorCode()

Returns the errorCode string.

Returns:

never null

getDescription

public java.lang.String getDescription()

Returns the description of the errorCode.

Returns:

never null

getLongDescription

public java.lang.String getLongDescription()

Returns the description of the errorCode including the online link with further explanations.

Returns:

never null

getUrl

public java.lang.String getUrl()

The link to find more information about this problem

getResourceInfos

public ResourceInfo[] getResourceInfos()

Return resource info object telling us where to find more information on this errorCode

getCategory

public static ErrorCode getCategory(ErrorCode errorCode)

Returns:

The top level category like 'internal'

getCategory

public static ErrorCode getCategory(java.lang.String errorCode)

Returns:

The top level category like 'internal'

toErrorCode

public static final ErrorCode toErrorCode(java.lang.String errorCode)
                                   throws java.lang.IllegalArgumentException

Returns the ErrorCode object for the given String error code.

Parameters:

errorCode - The String code to lookup

Returns:

The enumeration object for this errorCode

Throws:

java.lang.IllegalArgumentException - if the given errorCode is invalid

toErrorCode

public static final ErrorCode toErrorCode(java.lang.String errorCode,
                                          ErrorCode fallback)

Returns the ErrorCode object for the given String error code.

Parameters:

errorCode - The String code to lookup

the - code to use if errorCode is not known

Returns:

The enumeration object for this errorCode

equals

public final boolean equals(ErrorCode other)

toPlainList

public static java.lang.String toPlainList()

Dump a plain list of all errorCodes.

Returns:

The list with each errorCode in a new line

toHtmlTable

public static java.lang.String toHtmlTable()

Generate a HTML table listing of all error codes.

Returns:

The HTML markup

toRequirement

public static java.lang.String toRequirement()

toXmlAll

public static java.lang.String toXmlAll(java.lang.String extraOffset)

toXml

public java.lang.String toXml(java.lang.String extraOffset)

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException

This code is a helper for serialization so that after deserial the check

ErrorCode.INTERNAL_UNKNOWN == internalUnknownInstance

is still usable (the singleton is assured when deserializing)
See inner class SerializedForm

Throws:

java.io.ObjectStreamException

main

public static void main(java.lang.String[] args)

Generate a requirement file for all error codes. Used by build.xml, change with care!

  java org.xmlBlaster.util.def.ErrorCode 
  java org.xmlBlaster.util.def.ErrorCode verifySerialization
  java org.xmlBlaster.util.def.ErrorCode toPlainList  
 

verifySerialization

private static void verifySerialization()