com.entrust.toolkit.xencrypt.exceptions

Class XMLEException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.entrust.toolkit.xencrypt.exceptions.XMLEException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CipherDataException, DataReferenceException, EncryptionAlgorithmException, EncryptionHandlerException, EncryptionMethodException, EncryptionPropertyException, KeyWrapAlgorithmException, ReferenceException, ReferenceResolverException, XMLEInitException

public class XMLEException
extends java.lang.Exception

Base class for exceptions thrown by XMLE.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLEException() Simple constructor with no arguments.
XMLEException(java.lang.String messageId) Simple constructor with a message identifier argument.
XMLEException(java.lang.String messageId, java.lang.Object[] messageParameters) Constructor with a message identifier argument.
XMLEException(java.lang.String message, java.lang.Object[] messageParameters, java.lang.Throwable wrapped) Constructor with a message identifier, message parameters and a wrapped Throwable as arguments.
XMLEException(java.lang.String messageId, java.lang.Throwable wrapped) Constructor with a message identifier and a wrapped Throwable as arguments.
XMLEException(java.lang.Throwable wrapped) Constructor with a wrapped Throwable as argument.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getExceptionMessage(java.lang.String key) Looks up the Exception message for a given key provided by a ResourceBundle.
java.lang.String	getMessageId() Gets the message identifier for this exception.
static void	init(java.lang.String languageCode, java.lang.String countryCode) Initializes exception handling.
void	printStackTrace() Prints the stack trace of the XMLEException to System.err.
void	printStackTrace(java.io.PrintStream ps) Prints the stack trace of the XMLEException to the specified PrintStream.
void	printStackTrace(java.io.PrintWriter pw) Prints the stack trace of the XMLEException to the specified PrintWriter.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLEException

public XMLEException()

Simple constructor with no arguments. Invokes the Exception() constructor.

XMLEException

public XMLEException(java.lang.Throwable wrapped)

Constructor with a wrapped Throwable as argument. The Throwable is used by the printStackTrace methods.

Parameters:

wrapped - The Throwable used by the printStackTrace methods.

XMLEException

public XMLEException(java.lang.String messageId)

Simple constructor with a message identifier argument. Resolves the message id into a text message and invokes the Exception(String) constructor.

Parameters:

messageId - the message identifier for the exception.

XMLEException

public XMLEException(java.lang.String messageId,
                     java.lang.Throwable wrapped)

Constructor with a message identifier and a wrapped Throwable as arguments.

Parameters:

messageId - The message identifier for the exception.

wrapped - The Throwable used by the printStackTrace methods.

XMLEException

public XMLEException(java.lang.String messageId,
                     java.lang.Object[] messageParameters)

Constructor with a message identifier argument. The Java java.text.MessageFormat mechanism is used to incorporate the values of the given Object array into the resolved message.

Parameters:

messageId - The message identifier for the exception.

messageParameters - Paramters to be incorporated into the resolved message.

XMLEException

public XMLEException(java.lang.String message,
                     java.lang.Object[] messageParameters,
                     java.lang.Throwable wrapped)

Constructor with a message identifier, message parameters and a wrapped Throwable as arguments.

Parameters:

message - The message identifier for the exception.

wrapped - The Throwable used by the printStackTrace methods.

messageParameters - Paramters to be incorporated into the message.

Method Detail

init

public static void init(java.lang.String languageCode,
                        java.lang.String countryCode)

Initializes exception handling. This method is used internally by the toolkit to load a resource bundle that contains exception messages for a particular locale. The ISO codes for language and country may be specified as initialization properties for XMLE (the properties parameter of the com.entrust.toolkit.xencrypt.init.XMLEInit constructor). If they are not specified there, this method loads a resource bundle for the default Locale, as determined at run time.

Parameters:

languageCode - The ISO language code for the exception message resource bundle.

countryCode - The ISO country code for the exception message resource bundle.

See Also:

XMLEExceptionMessages, XMLEInit

getExceptionMessage

protected static java.lang.String getExceptionMessage(java.lang.String key)

Looks up the Exception message for a given key provided by a ResourceBundle.

Parameters:

key - The key for the exception message value to be returned.

Returns:

the exception message corresponding with the provided key.

getMessageId

public java.lang.String getMessageId()

Gets the message identifier for this exception.

Returns:

the message identifier for this exception.

printStackTrace

public void printStackTrace()

Prints the stack trace of the XMLEException to System.err. If a wrapped Throwable has been specified by the constructor, also the stack trace of this wrapped Throwable will be printed.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream ps)

Prints the stack trace of the XMLEException to the specified PrintStream.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

ps - Specifies the destination for printing.

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)

Prints the stack trace of the XMLEException to the specified PrintWriter.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

pw - Specifies the destination for printing.