com.ibm.msg.client.jms
Class DetailedJMSSecurityException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- javax.jms.JMSException
-
- javax.jms.JMSSecurityException
-
- com.ibm.msg.client.jms.DetailedJMSSecurityException
-
- All Implemented Interfaces:
- JmsConvertableException, JmsExceptionDetail, java.io.Serializable
public class DetailedJMSSecurityException extends javax.jms.JMSSecurityException implements JmsExceptionDetail, JmsConvertableException
DetailedJMSSecurityException is a subclass of JMSSecurityException that provides methods to get the message id, explanation, user action and inserts of the translatable message inside the JMSSecurityException. When the WebSphere MQ classes for JMS client throws a JMSSecurityException, applications can cast it to a DetailedJMSSecurityException to get this extra information.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description DetailedJMSSecurityException()
-
Method Summary
Methods Modifier and Type Method and Description java.lang.String
getExplanation()
Gets an explanation of the message in this exception.java.util.Iterator<java.lang.String>
getKeys()
Gets an iterator for all the message insert keys for the message in this exception.javax.jms.JMSRuntimeException
getUnchecked()
java.lang.String
getUserAction()
Gets a user response to the message in this exception.java.lang.String
getValue(java.lang.String insertKey)
Gets the message insert corresponding to a particular key for the translatable message in this exception.void
setLinkedException(java.lang.Exception ex)
Adds a linked exception.java.lang.String
toString()
Returns a short description of this exception
-
-
-
Method Detail
-
getExplanation
public java.lang.String getExplanation()
Gets an explanation of the message in this exception. This may be null.- Specified by:
getExplanation
in interfaceJmsExceptionDetail
- Returns:
- the explanation
- See Also:
JmsExceptionDetail.getExplanation()
-
getUserAction
public java.lang.String getUserAction()
Gets a user response to the message in this exception. This may be null.- Specified by:
getUserAction
in interfaceJmsExceptionDetail
- Returns:
- the user action
- See Also:
JmsExceptionDetail.getUserAction()
-
getValue
public java.lang.String getValue(java.lang.String insertKey)
Gets the message insert corresponding to a particular key for the translatable message in this exception. The key is a message insert constant or a property constant that is valid for this message. The valid keys for this message can be obtained using getKeys(). This method will return null if the key is not valid for this message.- Specified by:
getValue
in interfaceJmsExceptionDetail
- Parameters:
insertKey
- a message insert constant or property constant valid for this message- Returns:
- the insert
- See Also:
JmsExceptionDetail.getValue(java.lang.String)
-
getKeys
public java.util.Iterator<java.lang.String> getKeys()
Gets an iterator for all the message insert keys for the message in this exception. The keys are the property constants or message insert constants that are valid for this message. This enables applications to discover which keys are valid for this message.- Specified by:
getKeys
in interfaceJmsExceptionDetail
- Returns:
- the iterator for the message insert keys
- See Also:
JmsExceptionDetail.getKeys()
-
setLinkedException
public void setLinkedException(java.lang.Exception ex)
Adds a linked exception.- Overrides:
setLinkedException
in classjavax.jms.JMSException
- Parameters:
ex
- the linked Exception- See Also:
JMSException.setLinkedException(java.lang.Exception)
-
toString
public java.lang.String toString()
Returns a short description of this exception- Overrides:
toString
in classjava.lang.Throwable
- Returns:
- a String representation of the exception
-
getUnchecked
public javax.jms.JMSRuntimeException getUnchecked()
- Specified by:
getUnchecked
in interfaceJmsConvertableException
- Returns:
- the unchecked version of this Exception
- See Also:
JmsConvertableException.getUnchecked()
-
-