Websphere MQ Everyplace

com.ibm.mqe
Class MQeException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.mqe.MQeException
All Implemented Interfaces:
MQeExceptionCodes, java.io.Serializable
Direct Known Subclasses:
MQeCommunicationsException, MQeMessageStoreException

public class MQeException
extends java.lang.Exception
implements MQeExceptionCodes

Describes an exceptional circumstance which has occurred within MQe code.

This class is used to create an MQeException object.

This class is a descendant of MQe class.

There are five forms of Constructors.

Note : The value of the codeValue parameter should be one of the constants defined in MQe class.

For example : MQeExcept_NotFound.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
MQeException()
           Creates an object that has the codeValue of 0 and does not have an error message.
MQeException(int codeValue)
          Creates an object that has a codeValue and does not have an error message.
MQeException(int codeValue, java.lang.String msg)
          Creates an object that has a codeValue and an error message.
MQeException(int codeValue, java.lang.String msg, java.lang.String data)
          Creates an object that has a codeValue, an error message and keyword data.
MQeException(java.lang.String msg)
          Creates an object with an error message alone.
 
Method Summary
 int code()
          Extracts the code value of the MQeException, the value that was set when the exception was created.
 java.lang.String toString()
          Over-rides the superclass toString() to add (code=xxx) information at the end of the string.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MQeException

public MQeException()

Creates an object that has the codeValue of 0 and does not have an error message.


MQeException

public MQeException(int codeValue)

Creates an object that has a codeValue and does not have an error message.

Parameters:
codeValue - Integer value, normally one of the MQe.Except_... constants.
Throws:
None

MQeException

public MQeException(int codeValue,
                    java.lang.String msg)

Creates an object that has a codeValue and an error message.

Parameters:
codeValue - Integer value, normally one of the MQe.Except_... constants.
msg - String associated with the exception.
Throws:
None
Example:
 if (data == null)
     throw new MQeException(MQe.Except_Data, "Data missing");
 
 

MQeException

public MQeException(int codeValue,
                    java.lang.String msg,
                    java.lang.String data)

Creates an object that has a codeValue, an error message and keyword data. The Exception will be generated containing this keyword, which can be searched for, by calling keyword( String keywrd, String defalut) method.

Parameters:
codeValue - Integer value, normally one of the MQe.Except_... constants.
msg - String associated with the exception.
data - Keyword data to be included in exception.

MQeException

public MQeException(java.lang.String msg)

Creates an object with an error message alone.

Parameters:
msg - String associated with the exception.
Method Detail

toString

public java.lang.String toString()
Over-rides the superclass toString() to add (code=xxx) information at the end of the string.

Overrides:
toString in class java.lang.Throwable
Returns:
A string. The message data associated with the exception, with the "(code=xxx)" string appended to the end.

code

public int code()

Extracts the code value of the MQeException, the value that was set when the exception was created.

Returns:
integer
Example:
 try {// The Try Block code.
 } catch (Exception e) {
     if (e instanceof com.ibm.mqe.MQeException)
         switch (((MQeException) e).code()) {
         case MQe.Except_Data:
             System.err.println("Data format error");
             break;
 
         case MQe.Except_NotFound:
             System.err.println("Data not specified");
             break;
         }
     else
         System.err.println("Error:" + e.toString());
 
         }
 

Websphere MQ Everyplace