com.beasys.commerce.foundation.exception
Class ProcessingException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.beasys.commerce.foundation.exception.ApplicationException
                    |
                    +--com.beasys.commerce.foundation.exception.ProcessingException

Direct Known Subclasses:

BadInputException, ConfigurationException, PipelineFatalException, PipelineNonFatalException

public class ProcessingException

extends ApplicationException

This class is the base class for all processing exceptions.

ProcessingExceptions or sub-classes of ProcessingException with the exception of ProcessingException and ProcessingException are meant to be thrown by classes that implement the InputProcessor interface. PipelineFatalException and its sub-clasess are meant to be thrown by classes that implement the PipelineComponent interface. PipelineNonFatalException and its sub-classes are meant to be thrown by classes that implement the PipelineComponent interface

Note: Throughout this API documentation namespace refers to the resource bundle that contains the catalog of exception messages. Refer to the MessageCatalog API documentation for further details.

See Also:

MessageCatalogException, Serialized Form

Field Summary

static java.lang.String

MESSAGE_NAMESPACE The name of the resource bundle that will be used to fetch the exception messages.

Fields inherited from class com.beasys.commerce.foundation.exception.ApplicationException

embeddedException, logMessages, userMessages

Constructor Summary

ProcessingException(java.lang.String messageKey)
Class constructor taking the key of the associated catalog message.

ProcessingException(java.lang.String messageKey, java.lang.Exception exception)
Class constructor taking the key of the associated catalog message and an embedded exception.

ProcessingException(java.lang.String messageKey, java.lang.Object argument)
Class constructor taking the key of the associated catalog message and a message parameter substitution argument.

ProcessingException(java.lang.String messageKey, java.lang.Object[] arguments)
Class constructor taking the key of the associated catalog message and message parameter substitution arguments.

ProcessingException(java.lang.String messageKey, java.lang.Object[] arguments, java.lang.Exception exception)
Class constructor taking the key of the associated catalog message, message parameter substitution arguments, and an embedded exception.

ProcessingException(java.lang.String namespace, java.lang.String messageKey)
Class constructor taking the namespace and key of the associated catalog message.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Exception exception)
Class constructor taking the namespace and key of the associated catalog message and an embedded exception.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object argument)
Class constructor taking the namespace and key of the associated catalog message and a message parameter substitution argument.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object[] arguments)
Class constructor taking the namespace and key of the associated catalog message and message parameter substitution arguments.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object[] arguments, java.lang.Exception exception)
Class constructor taking the namespace and key of the associated catalog message, message parameter substitution arguments, and an embedded exception.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object argument, java.lang.Exception exception)
Class constructor taking the namespace and key of the associated catalog message, message parameter substitution argument, and an embedded exception.

Method Summary

void	setEmbeddedException(java.lang.Exception exception) Associates a given exception with this exception.

Methods inherited from class com.beasys.commerce.foundation.exception.ApplicationException

addLogMessage, addLogMessage, addLogMessage, addMessage, addMessage, addMessage, addUserMessage, addUserMessage, addUserMessage, getEmbeddedException, getLocalizedMessage, getLogMessage, getLogMessages, getMessage, getUserMessage, getUserMessages, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_NAMESPACE

public static final java.lang.String MESSAGE_NAMESPACE

The name of the resource bundle that will be used to fetch the exception messages.

Constructor Detail

ProcessingException

public ProcessingException(java.lang.String messageKey)

Class constructor taking the key of the associated catalog message.

Parameters:

messageKey - The associated catalog message key.

ProcessingException

public ProcessingException(java.lang.String messageKey,
                           java.lang.Exception exception)

Class constructor taking the key of the associated catalog message and an embedded exception.

Parameters:

messageKey - The associated catalog message key.

exception - The embedded exception.

ProcessingException

public ProcessingException(java.lang.String messageKey,
                           java.lang.Object argument)

Class constructor taking the key of the associated catalog message and a message parameter substitution argument.

Parameters:

messageKey - The associated catalog message key.

argument - The message parameter substitution argument.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey)

Class constructor taking the namespace and key of the associated catalog message.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey,
                           java.lang.Object argument)

Class constructor taking the namespace and key of the associated catalog message and a message parameter substitution argument.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

argument - The message parameter substitution argument.

ProcessingException

public ProcessingException(java.lang.String messageKey,
                           java.lang.Object[] arguments)

Class constructor taking the key of the associated catalog message and message parameter substitution arguments.

Parameters:

messageKey - The associated catalog message key.

arguments - The message parameter substitution arguments.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey,
                           java.lang.Object[] arguments)

Class constructor taking the namespace and key of the associated catalog message and message parameter substitution arguments.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

arguments - The message parameter substitution arguments.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey,
                           java.lang.Exception exception)

Class constructor taking the namespace and key of the associated catalog message and an embedded exception.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

exception - The embedded exception.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey,
                           java.lang.Object argument,
                           java.lang.Exception exception)

Class constructor taking the namespace and key of the associated catalog message, message parameter substitution argument, and an embedded exception.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

argument - The message parameter substitution argument.

exception - The embedded exception.

ProcessingException

public ProcessingException(java.lang.String messageKey,
                           java.lang.Object[] arguments,
                           java.lang.Exception exception)

Class constructor taking the key of the associated catalog message, message parameter substitution arguments, and an embedded exception.

Parameters:

messageKey - The associated catalog message key.

arguments - The message parameter substitution arguments.

exception - The embedded exception.

ProcessingException

public ProcessingException(java.lang.String namespace,
                           java.lang.String messageKey,
                           java.lang.Object[] arguments,
                           java.lang.Exception exception)

Class constructor taking the namespace and key of the associated catalog message, message parameter substitution arguments, and an embedded exception.

Parameters:

namespace - The associated catalog message namespace.

messageKey - The associated catalog message key.

arguments - The message parameter substitution arguments.

exception - The embedded exception.

Method Detail

setEmbeddedException

public void setEmbeddedException(java.lang.Exception exception)

Associates a given exception with this exception.

Parameters:

exception - The new embedded exception.