|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.ibm.datapower.wamt.DMgrException
public class DMgrException
This is the root class for exceptions that are thrown from the DataPower Management Interface. All other exception classes in the manager should be a subclass of this. It is recommended that you use the most specific class whenever possible, so instances of this specific class should be rare. Please instantiate subclasses instead.
To support getting an NLS message from the exception, this class has been modified to have NLS message attributes (msgId and msgParams). If these attributes are present, they will be used in returning localized messages (@see #getMessage(Locale) ). The normal constructors that pass messages have been preserved for compatibility uses, but they should be avoided if possible.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2010
|
Constructor Summary | |
---|---|
DMgrException()
Create an exception with no message and no cause. |
|
DMgrException(java.lang.String message)
Create an exception with a message but with no chained cause. |
|
DMgrException(java.lang.String message,
java.lang.String msgKey)
Create an exception with a message and NLS attributes, but with no chained cause. |
|
DMgrException(java.lang.String message,
java.lang.String msgKey,
java.lang.Object msgParm)
Create an exception with a message and NLS attributes, but with no chained cause. |
|
DMgrException(java.lang.String message,
java.lang.String msgKey,
java.lang.Object[] msgParms)
Create an exception with a message and NLS attributes, but with no chained cause. |
|
DMgrException(java.lang.String message,
java.lang.Throwable cause)
Create an exception with a message and a chained cause. |
|
DMgrException(java.lang.String message,
java.lang.Throwable cause,
java.lang.String msgKey)
Create an exception with a message, NLS attributes and a chained cause. |
|
DMgrException(java.lang.String message,
java.lang.Throwable cause,
java.lang.String msgKey,
java.lang.Object msgParm)
Create an exception with a message, NLS attributes and a chained cause. |
|
DMgrException(java.lang.String message,
java.lang.Throwable cause,
java.lang.String msgKey,
java.lang.Object[] msgParms)
Create an exception with a message, NLS attributes and a chained cause. |
|
DMgrException(java.lang.Throwable cause)
Create an exception with a chained cause and no message. |
Method Summary | |
---|---|
java.lang.String |
getMessage(java.util.Locale locale)
Return a message for this exception based on locale. |
java.lang.String |
getMessageExplanation()
Return the explanation text for this exception message |
java.lang.String |
getMessageExplanation(java.util.Locale locale)
Returns the explanation text for this exception message |
java.lang.String |
getMessageUseraction()
Return the uesraction text for this exception message |
java.lang.String |
getMessageUseraction(java.util.Locale locale)
Returns the useraction text for this exception message |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2010
Constructor Detail |
---|
public DMgrException()
public DMgrException(java.lang.String message)
message
- a string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.public DMgrException(java.lang.String message, java.lang.String msgKey, java.lang.Object[] msgParms)
message
- a string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.msgParms
- an Object[] that gives the attributes to be used with
msgKeygetMessage(Locale)
public DMgrException(java.lang.String message, java.lang.String msgKey, java.lang.Object msgParm)
message
- a string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.msgParm
- an Object that gives the attributes to be used with msgKeygetMessage(Locale)
public DMgrException(java.lang.String message, java.lang.String msgKey)
message
- a string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.getMessage(Locale)
public DMgrException(java.lang.String message, java.lang.Throwable cause)
message
- string that provides some explanation/description of the
exceptioncause
- a reference to another exception that occurred at a lower
level which is the cause for this higher-level exception.public DMgrException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object[] msgParms)
message
- string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.cause
- a reference to another exception that occurred at a lower
level which is the cause for this higher-level exception.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.msgParms
- an Object[] that gives the attributes to be used with
msgKeygetMessage(Locale)
public DMgrException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object msgParm)
message
- string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.cause
- a reference to another exception that occurred at a lower
level which is the cause for this higher-level exception.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.msgParm
- an Object that gives the attribute to be used with msgKeygetMessage(Locale)
public DMgrException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey)
message
- string that provides some explanation/description of the
exception. This message should have already been localized for the
jvm's locale, if possible.cause
- a reference to another exception that occurred at a lower
level which is the cause for this higher-level exception.msgKey
- a string giving the key of the NLS enabled message to be
used with the exception.getMessage(Locale)
public DMgrException(java.lang.Throwable cause)
cause
- a reference to another exception that occurred at a lower
level which is the cause for this higher-level exception.Method Detail |
---|
public java.lang.String getMessage(java.util.Locale locale)
locale
- The locale to be used for the localizedMessage
public java.lang.String getMessageExplanation()
public java.lang.String getMessageUseraction()
public java.lang.String getMessageExplanation(java.util.Locale locale)
locale
- the locale for the string to be returned.
public java.lang.String getMessageUseraction(java.util.Locale locale)
locale
- the locale for the string to be returned.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |