SonicMQ API

progress.message.jclient
Class ErrorCodes

java.lang.Object
  extended by progress.message.jclient.ErrorCodes

public final class ErrorCodes
extends java.lang.Object


Field Summary
static int BROWSER_CLOSED_DURING_RECONNECT
          QueueBrowser closed by fault-tolerant connection failure
static int ERR_AUTH_SPI
          Indicates the Authenticaion SPI has thrown an Exception
static int ERR_CAN_NOT_INSTANTIATE_CLASS
          Thrown when an application tries to use the new construct to instantiate an abstract class or an interface.
static int ERR_CHANNEL_ACTIVE
          The channel is currently active.
static int ERR_CHANNEL_ALREADY_ESTABLISHED
          An attempt was made to establish a channel with a sender that already has a channel established.
static int ERR_CHANNEL_DUPLICATE
          The channel has been duplicated.
static int ERR_CHANNEL_FATAL_DUP_DETECT_EXCEPTION
          There was a fatal error while accessing duplicate detection.
static int ERR_CHANNEL_IMPLICITLY_CANCELLED
          There is no channel listener and the channel was canceled.
static int ERR_CHANNEL_INTERNAL_ERROR
          There has been an internal JMS Exception.
static int ERR_CHANNEL_INVALID_DECRYPTION_KEY
          Thrown if java.security.KeyManagementException occurs.
static int ERR_CHANNEL_INVALID_KEY_TYPE
          Thrown if java.security.InvalidKeyException occurs.
static int ERR_CHANNEL_IO_ERROR
          There has been an internal IO Exception.
static int ERR_CHANNEL_JCE_UNAVAILABLE
          The Java Cryptography Extensions were required by setDES or setDESede and were not available.
static int ERR_CHANNEL_RECOVER_FILE_UNREADABLE
          The file to transfer is unreadable.
static int ERR_CHANNEL_RETRY_TIMEOUT
          There has been a time out while attempting to transfer the file.
static int ERR_CHANNEL_TIMEOUT
          The transfer was closed.
static int ERR_CHANNEL_TRANSFER_CLOSED
          The connection between the peers has been closed.
static int ERR_CHANNEL_UUID_IN_USE
          Another channel successfully established a channel using the UUID specified for this channel.
static int ERR_CLASS_ACCESS_ERROR
          An IllegalAccessException is thrown when an application tries to reflectively create an instance (other than an array), set or get a field, or invoke a method, but the currently executing method does not have access to the definition of the specified class, field, method or constructor.
static int ERR_CLASS_CAST_ERROR
          Thrown to indicate that the code has attempted to cast an object to a subclass of which it is not an instance.
static int ERR_CLASS_NOT_FOUND
          Thrown when an application tries to load in a class through its string name using: The forName method in class Class.
static int ERR_CLASSPATH_NOT_FOUND
          If the class path required for an application is empty of null, this error is thrown
static int ERR_CONNECTION_DROPPED
          This error occurs if the connection between the peers has been dropped.
static int ERR_CONNECTION_LIMIT_EXCEEDED
          If the connection limit for JMS messaging has exceeded.
static int ERR_EXCEPTION_IN_INIT
          Signals that an unexpected exception has occurred in a static initializer.
static int ERR_EXTERNAL_AUTHENTICATION_FAILED
          External authentication using Login SPI or Authentication SPI has failed
static int ERR_FLOW_CONTROL_EXCEPTION
          Indicates that there was an exception in performing the flow-control operation
static int ERR_INTEGRITY_FAILED
          This error occurs if the message has been tampered with and has been modified, therefore the message has lost its integrity.
static int ERR_JMS_DELIVERY_TIMEOUT_ON_CLOSE
          Thrown when delivery of a message times out during a Connection or Session close.
static int ERR_JMS_OBJECT_CLOSED
          An attempts to use a previously closed JMS object such as JMS Connection has occurred.
static int ERR_LINKAGE_ERROR
          LinkageError indicate that a class has some dependency on another class.
static int ERR_MESSAGELISTENER_RUNTIME_EXCEPTION
          Indicates that there was an runtime error in the message listener
static int ERR_NO_ROOM_IN_DB
          Thrown when the broker does not accept a message because the database size limit has been reached.
static int ERR_PRIVACY_FAILED
          This error occurs if the message has been tampered with and therefore the message has lost its privacy.
static int ERR_SECURITY_ERROR
          Generic security error indicates occurrence of security violation.
static int ERR_SOCKET_CONNECT_TIMEOUT
          Thrown when a scket connect timeout is specified and the socket is not opened within the specified time
static int ERR_STORE
          Generic error while persisting message.
static int ERR_STORE_INIT
          Thrown when there is an error initializing the persistent store.
static int ERR_STORE_SIZE_EXCEEDED
          Thrown when the size of stored messages exceeds the defined store size.
static int ERR_STRING_PROPERTY_TOO_LARGE
          A String property value is too large
static int ERR_THREAD_INTERRUPTED
          Occurs if the thread has been interrupted
static int ERR_TOO_LARGE_FOR_QUEUE
          The message to added into the queue is too large or the queue cannot accommodate the message as it has reached its capacity.
static int ERR_TXN_IDLE_TIMEOUT
          This error occurs when transaction is close internally.
static int ERROR
          A general error has occurred.
static int TXN_DATABASE_EXCEPTION
          The transaction has failed due to some error in persisting the transaction into the database.
static int TXN_INDEX_ALREADY_EXISTS
          The transaction index created the current transaction to be executed already exists.
static int TXN_INDICES_NOT_SUPPORTED
          Transaction failed as transaction indices were not supported in the transaction.
static int TXN_INVALID_DATA
          A illegal argument exception or related data inconsistency error occurred while processing the transaction.
 
Constructor Summary
ErrorCodes()
           
 
Method Summary
static boolean testException(JMSException anException, int aCode)
          Tests the error code associated with a JMSException against an integer value associated with a Progress SonicMQ ErrorCode.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ERROR

public static final int ERROR
A general error has occurred.

See Also:
Constant Field Values

ERR_PRIVACY_FAILED

public static final int ERR_PRIVACY_FAILED
This error occurs if the message has been tampered with and therefore the message has lost its privacy. It may have been modified or its encryption compromised.

See Also:
Constant Field Values

ERR_INTEGRITY_FAILED

public static final int ERR_INTEGRITY_FAILED
This error occurs if the message has been tampered with and has been modified, therefore the message has lost its integrity.

See Also:
Constant Field Values

ERR_CONNECTION_DROPPED

public static final int ERR_CONNECTION_DROPPED
This error occurs if the connection between the peers has been dropped. For example, a network error.

See Also:
Constant Field Values

ERR_MESSAGELISTENER_RUNTIME_EXCEPTION

public static final int ERR_MESSAGELISTENER_RUNTIME_EXCEPTION
Indicates that there was an runtime error in the message listener

See Also:
Constant Field Values

ERR_FLOW_CONTROL_EXCEPTION

public static final int ERR_FLOW_CONTROL_EXCEPTION
Indicates that there was an exception in performing the flow-control operation

See Also:
Constant Field Values

ERR_TOO_LARGE_FOR_QUEUE

public static final int ERR_TOO_LARGE_FOR_QUEUE
The message to added into the queue is too large or the queue cannot accommodate the message as it has reached its capacity.

See Also:
Constant Field Values

TXN_INDEX_ALREADY_EXISTS

public static final int TXN_INDEX_ALREADY_EXISTS
The transaction index created the current transaction to be executed already exists.

See Also:
Constant Field Values

TXN_DATABASE_EXCEPTION

public static final int TXN_DATABASE_EXCEPTION
The transaction has failed due to some error in persisting the transaction into the database.

See Also:
Constant Field Values

TXN_INVALID_DATA

public static final int TXN_INVALID_DATA
A illegal argument exception or related data inconsistency error occurred while processing the transaction.

See Also:
Constant Field Values

TXN_INDICES_NOT_SUPPORTED

public static final int TXN_INDICES_NOT_SUPPORTED
Transaction failed as transaction indices were not supported in the transaction.

See Also:
Constant Field Values

ERR_JMS_OBJECT_CLOSED

public static final int ERR_JMS_OBJECT_CLOSED
An attempts to use a previously closed JMS object such as JMS Connection has occurred.

See Also:
Constant Field Values

ERR_TXN_IDLE_TIMEOUT

public static final int ERR_TXN_IDLE_TIMEOUT
This error occurs when transaction is close internally. An example is timing out of transaction.

See Also:
Constant Field Values

ERR_THREAD_INTERRUPTED

public static final int ERR_THREAD_INTERRUPTED
Occurs if the thread has been interrupted

See Also:
Constant Field Values

ERR_EXTERNAL_AUTHENTICATION_FAILED

public static final int ERR_EXTERNAL_AUTHENTICATION_FAILED
External authentication using Login SPI or Authentication SPI has failed

See Also:
Constant Field Values

ERR_CONNECTION_LIMIT_EXCEEDED

public static final int ERR_CONNECTION_LIMIT_EXCEEDED
If the connection limit for JMS messaging has exceeded.

See Also:
Constant Field Values

ERR_STRING_PROPERTY_TOO_LARGE

public static final int ERR_STRING_PROPERTY_TOO_LARGE
A String property value is too large

See Also:
Constant Field Values

ERR_JMS_DELIVERY_TIMEOUT_ON_CLOSE

public static final int ERR_JMS_DELIVERY_TIMEOUT_ON_CLOSE
Thrown when delivery of a message times out during a Connection or Session close. Delivery of the message to the broker is in doubt when this error occurs.

Since:
7.6
See Also:
Constant Field Values

ERR_NO_ROOM_IN_DB

public static final int ERR_NO_ROOM_IN_DB
Thrown when the broker does not accept a message because the database size limit has been reached.

See Also:
Constant Field Values

ERR_CLASS_NOT_FOUND

public static final int ERR_CLASS_NOT_FOUND
Thrown when an application tries to load in a class through its string name using: The forName method in class Class. The findSystemClass method in class ClassLoader . The loadClass method in class ClassLoader. but no definition for the class with the specified name could be found.

See Also:
Constant Field Values

ERR_CLASS_CAST_ERROR

public static final int ERR_CLASS_CAST_ERROR
Thrown to indicate that the code has attempted to cast an object to a subclass of which it is not an instance. For example, the following code generates a ClassCastException: Object x = new Integer(0); System.out.println((String)x);

See Also:
Constant Field Values

ERR_CAN_NOT_INSTANTIATE_CLASS

public static final int ERR_CAN_NOT_INSTANTIATE_CLASS
Thrown when an application tries to use the new construct to instantiate an abstract class or an interface.

See Also:
Constant Field Values

ERR_CLASS_ACCESS_ERROR

public static final int ERR_CLASS_ACCESS_ERROR
An IllegalAccessException is thrown when an application tries to reflectively create an instance (other than an array), set or get a field, or invoke a method, but the currently executing method does not have access to the definition of the specified class, field, method or constructor.

See Also:
Constant Field Values

ERR_EXCEPTION_IN_INIT

public static final int ERR_EXCEPTION_IN_INIT
Signals that an unexpected exception has occurred in a static initializer. An ExceptionInInitializerError was thrown to indicate that an exception occurred during evaluation of a static initializer or the initializer for a static variable.

See Also:
Constant Field Values

ERR_CLASSPATH_NOT_FOUND

public static final int ERR_CLASSPATH_NOT_FOUND
If the class path required for an application is empty of null, this error is thrown

See Also:
Constant Field Values

ERR_SECURITY_ERROR

public static final int ERR_SECURITY_ERROR
Generic security error indicates occurrence of security violation.

See Also:
Constant Field Values

ERR_LINKAGE_ERROR

public static final int ERR_LINKAGE_ERROR
LinkageError indicate that a class has some dependency on another class. However, the latter class has incompatibly changed after the compilation of the former class.

See Also:
Constant Field Values

ERR_AUTH_SPI

public static final int ERR_AUTH_SPI
Indicates the Authenticaion SPI has thrown an Exception

See Also:
Constant Field Values

ERR_CHANNEL_RETRY_TIMEOUT

public static final int ERR_CHANNEL_RETRY_TIMEOUT
There has been a time out while attempting to transfer the file. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_TRANSFER_CLOSED

public static final int ERR_CHANNEL_TRANSFER_CLOSED
The connection between the peers has been closed. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_TIMEOUT

public static final int ERR_CHANNEL_TIMEOUT
The transfer was closed. Existing recovery information is preserved. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_RECOVER_FILE_UNREADABLE

public static final int ERR_CHANNEL_RECOVER_FILE_UNREADABLE
The file to transfer is unreadable. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_IMPLICITLY_CANCELLED

public static final int ERR_CHANNEL_IMPLICITLY_CANCELLED
There is no channel listener and the channel was canceled. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_INTERNAL_ERROR

public static final int ERR_CHANNEL_INTERNAL_ERROR
There has been an internal JMS Exception. Call getLinkedException() to determine the problem. Examples while this error can occur are while sending acknowledgement, sending message, receiving message. This is used for Recoverable File Channels.

See Also:
Constant Field Values

ERR_CHANNEL_IO_ERROR

public static final int ERR_CHANNEL_IO_ERROR
There has been an internal IO Exception. Call getLinkedException() to determine the problem. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_ALREADY_ESTABLISHED

public static final int ERR_CHANNEL_ALREADY_ESTABLISHED
An attempt was made to establish a channel with a sender that already has a channel established. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_ACTIVE

public static final int ERR_CHANNEL_ACTIVE
The channel is currently active. This is the error code used with the ChannelActiveException. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_DUPLICATE

public static final int ERR_CHANNEL_DUPLICATE
The channel has been duplicated. This is the error code used with the Channel Duplicate Detect Exception. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_UUID_IN_USE

public static final int ERR_CHANNEL_UUID_IN_USE
Another channel successfully established a channel using the UUID specified for this channel. This might occur when applications are under heavy load and the channel was seen as inactive. The timeToLive value, ttl, in the setUUID(String uuid, int ttl) method might be too small. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_FATAL_DUP_DETECT_EXCEPTION

public static final int ERR_CHANNEL_FATAL_DUP_DETECT_EXCEPTION
There was a fatal error while accessing duplicate detection. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_INVALID_KEY_TYPE

public static final int ERR_CHANNEL_INVALID_KEY_TYPE
Thrown if java.security.InvalidKeyException occurs. The type of key presented for encryption/decryption was not the type expected. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_INVALID_DECRYPTION_KEY

public static final int ERR_CHANNEL_INVALID_DECRYPTION_KEY
Thrown if java.security.KeyManagementException occurs. The key presented for encryption/decryption was not valid. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_CHANNEL_JCE_UNAVAILABLE

public static final int ERR_CHANNEL_JCE_UNAVAILABLE
The Java Cryptography Extensions were required by setDES or setDESede and were not available. This is used for Recoverable File Channels. See Programming Guide for more information.

See Also:
Constant Field Values

ERR_STORE_SIZE_EXCEEDED

public static final int ERR_STORE_SIZE_EXCEEDED
Thrown when the size of stored messages exceeds the defined store size. The store size is specified in the Connection factory. The default is 10,000 KB.

See Also:
Constant Field Values

ERR_STORE_INIT

public static final int ERR_STORE_INIT
Thrown when there is an error initializing the persistent store. Possible causes of initialization errors are incorrect classpath, nonexistent store directory, or clientId not defined.

See Also:
Constant Field Values

ERR_STORE

public static final int ERR_STORE
Generic error while persisting message.

See Also:
Constant Field Values

BROWSER_CLOSED_DURING_RECONNECT

public static final int BROWSER_CLOSED_DURING_RECONNECT
QueueBrowser closed by fault-tolerant connection failure

See Also:
Constant Field Values

ERR_SOCKET_CONNECT_TIMEOUT

public static final int ERR_SOCKET_CONNECT_TIMEOUT
Thrown when a scket connect timeout is specified and the socket is not opened within the specified time

See Also:
Constant Field Values
Constructor Detail

ErrorCodes

public ErrorCodes()
Method Detail

testException

public static final boolean testException(JMSException anException,
                                          int aCode)
Tests the error code associated with a JMSException against an integer value associated with a Progress SonicMQ ErrorCode.

Parameters:
anException - A JMSException that needs to be tested.
aCode - An error code specified as an integer.
Returns:
True, if the error code of the exception is the one specified.

SonicMQ API

Copyright © 1999-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 5-August-2011.