com.beasys.commerce.foundation.exception
Class ProcessingException

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

Direct Known Subclasses:

BadInputException, ConfigurationException, InvalidSessionStateException, PipelineFatalException, PipelineNonFatalException

public class ProcessingException

extends java.lang.Exception

This class is the base class for all ProcessingExceptions.

ProcessingExceptions or sub-classes of ProcessingException with the exception of PipelineFatalException and PipelineNonFatalException 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:

MessageCatalog, com.beasys.commerce.webflow.InputProcessor, Serialized Form

Field Summary

protected java.lang.Exception	embeddedException The Embedded exception
static java.lang.String	MESSAGE_NAMESPACE The name of the resource bundle that will be used to fetch the exception messages.
java.lang.String	userMessage The name of the resource bundle that will be used to fetch the exception messages.

Constructor Summary

ProcessingException(java.lang.String message)
Constructs a ProcessingException.

ProcessingException(java.lang.String message, java.lang.Exception embeddedException)
Constructs a ProcessingException.

ProcessingException(java.lang.String messageKey, java.lang.Object argument)
Constructs a ProcessingException.

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

ProcessingException(java.lang.String messageKey, java.lang.Object[] argument, java.lang.Exception embeddedException)
Constructs a ProcessingException.

ProcessingException(java.lang.String namespace, java.lang.String messageKey)
Constructs a ProcessingException.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Exception embeddedException)
Constructs a ProcessingException.

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

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

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object[] arguments, java.lang.Exception embeddedException)
Constructs a ProcessingException.

ProcessingException(java.lang.String namespace, java.lang.String messageKey, java.lang.Object argument, java.lang.Exception embeddedException)
Constructs a ProcessingException.

Method Summary

java.lang.Exception	getEmbeddedException() Returns the embedded exception.
java.lang.String	getUserMessage() Returns the user message.
void	setEmbeddedException(java.lang.Exception embeddedException) Sets the embedded exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

embeddedException

protected java.lang.Exception embeddedException

The Embedded exception

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. This constant refers to the resource bundle "webflow-targetprocessor.properties"

userMessage

public java.lang.String userMessage

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

Constructor Detail

ProcessingException

public ProcessingException(java.lang.String message)

Constructs a ProcessingException. Sets the message as the user message.

Parameters:

String - the message.

ProcessingException

public ProcessingException(java.lang.String message,
                           java.lang.Exception embeddedException)

Constructs a ProcessingException. Sets the message as the user message. Sets the exception as the embedded exception.

Parameters:

String - the message.

Exception - the Embedded Exception.

ProcessingException

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

Constructs a ProcessingException.

This uses the WLCS default resource bundle ("webflow-targetprocessor") to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the message key that will be used to do a lookup in the default resource bundle namely "webflow-targetprocessor".

Object - the argument that replaces the place holder(s) in the message.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey.

Parameters:

String - the namespace that contains the given messageKey.

String - the messageKey to look for.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey.

Parameters:

String - the namespace that contains the given messageKey.

String - the messageKey to look for.

Object - the argument that replaces the place holder(s) in the message.

ProcessingException

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

Constructs a ProcessingException.

This uses the WLCS default resource bundle ("webflow-targetprocessor") to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the message key to look for in the default resource bundle namely "webflow-targetprocessor".

Object[] - the arguments that replaces the place holders in the message.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the name of the resource bundle that contains the given messageKey.

String - the message key to look for in the given resource bundle.

Object[] - the arguments that replaces the place holders in the message.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the name of the resource bundle that contains the given messageKey.

String - the message key to look for in the given resource bundle.

Exception - the Embedded Exception.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey

Parameters:

String - the name of the resource bundle that contains the given messageKey.

String - the messageKey to look for in the given resource bundle.

Object - the argument that replaces the place holder in the message.

Exception - the Embedded Exception.

ProcessingException

public ProcessingException(java.lang.String messageKey,
                           java.lang.Object[] argument,
                           java.lang.Exception embeddedException)

Constructs a ProcessingException.

This uses the WLCS default resource bundle ("webflow-targetprocessor") to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the message key to look for in the default resource bundle.

Object[] - the arguments that replaces the place holders in the message.

Exception - the Embedded Exception.

ProcessingException

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

Constructs a ProcessingException.

This uses the given namespace to do a lookup for the given messageKey. Once the message is found the argument is used to replace the place holders in the message.

Parameters:

String - the name of the resource bundle which contains the given messageKey

String - the message key to look for in the given resource bundle

Object[] - the arguments that replaces the place holders in the message.

Exception - the Embedded Exception.

Method Detail

getEmbeddedException

public java.lang.Exception getEmbeddedException()

Returns the embedded exception.

Returns:

Exception the embedded exception.

setEmbeddedException

public void setEmbeddedException(java.lang.Exception embeddedException)

Sets the embedded exception.

Parameters:

Exception - the embedded exception.

getUserMessage

public java.lang.String getUserMessage()

Returns the user message.

Returns:

String the user message.