FatalApplicationException Class

com.beasys.commerce.foundation.exception
FatalApplicationException Class

public class FatalApplicationException

    extends RuntimeException
    implements MessageCatalogException

The FatalApplicationException class is used to signal runtime business logic exceptions to a caller.

The FatalApplicationException class is closely tied to the MessageCatalog. An FatalApplicationException contains a log and user message that is constructed using the MessageCatalog. In fact, each FatalApplicationException derivative should have at least one user and log catalog message.

In the case of an EJB, the following guidelines should be followed:

Like the ApplicationException class, the FatalApplicationException class is used to signal business logic exceptions. However, unlike the ApplicationException class, if a bean method throws a FatalApplicationException, any existing transaction will be rolled back by the Container and the bean's state will be set to "does not exists". The net effect is the same as if the bean method threw a SystemException.

Related Topics

MessageCatalog
ApplicationException
MessageCatalogException

Hierarchy
Object
  Throwable
    Exception
      RuntimeException
        FatalApplicationException
All Implemented Interfaces

MessageCatalogException, Serializable
Direct Known Subclasses

OrderPackingException, QuoteException

Field Summary
protected Exception
embeddedException
The embedded exception.
protected Stack
logMessages
The log messages.
protected Stack
userMessages
The user messages.
 

Constructor Summary
FatalApplicationException()

Constructs an FatalApplicationException with no associated message.
FatalApplicationException(FatalApplicationException topException, FatalApplicationException bottomException)

Constructs an FatalApplicationException from two source FatalApplicationExceptions by concatinating the screen and log messages of the two source FatalApplicationExceptions.
FatalApplicationException(String namespace, String messageKey, Exception exception)

Class constructor taking the namespace and key of the associated catalog message and an embedded exception.
FatalApplicationException(String namespace, String messageKey, Object argument, Exception exception)

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

Class constructor taking the namespace and key of the associated catalog message and a message parameter substitution argument.
FatalApplicationException(String namespace, String messageKey, Object arguments, Exception exception)

Class constructor taking the namespace and key of the associated catalog message, message parameter substitution arguments, and an embedded exception.
FatalApplicationException(String namespace, String messageKey, Object arguments)

Class constructor taking the namespace and key of the associated catalog message and message parameter substitution arguments.
FatalApplicationException(String namespace, String messageKey)

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

Method Summary
public void
addLogMessage(String namespace, String messageKey)
Adds a new log catalog message to the stack of associated messages.
public void
addLogMessage(String namespace, String messageKey, Object argument)
Adds a new log catalog message to the stack of associated messages.
public void
addLogMessage(String namespace, String messageKey, Object[] arguments)
Adds a new log catalog message to the stack of associated messages.
public void
addMessage(String namespace, String messageKey)
Adds a new user and log catalog message to the stack of associated messages.
public void
addMessage(String namespace, String messageKey, Object argument)
Adds a new user catalog message to the stack of associated messages.
public void
addMessage(String namespace, String messageKey, Object[] arguments)
Adds a new user catalog message to the stack of associated messages.
public void
addUserMessage(String namespace, String messageKey)
Adds a new user catalog message to the stack of associated messages.
public void
addUserMessage(String namespace, String messageKey, Object argument)
Adds a new user catalog message to the stack of associated messages.
public void
addUserMessage(String namespace, String messageKey, Object[] arguments)
Adds a new user catalog message to the stack of associated messages.
public Exception
getEmbeddedException()
Gets the embedded exception associated with this exception.
public String
getLocalizedMessage()
Returns the user message associated with this exception.
public String
getLogMessage()
Returns the first log catalog message associated with this exception.
public Iterator
getLogMessages()
Returns an iterator over all the log catalog messages associated with this exception.
public String
getMessage()
Returns the user message associated with this exception.
public String
getUserMessage()
Returns the first user catalog message associated with this exception.
public Iterator
getUserMessages()
Returns an iterator over all the user catalog messages associated with this exception.
public String
toString()
Returns a string representation of this exception.
 
Methods from  java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace,
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface com.beasys.commerce.foundation.exception.MessageCatalogException
addLogMessage, addLogMessage, addLogMessage, addMessage, addMessage, addMessage, addUserMessage, addUserMessage, addUserMessage, getEmbeddedException, getLogMessage, getLogMessages, getUserMessage, getUserMessages
 

Field Detail

embeddedException

protected Exception embeddedException
The embedded exception.

logMessages

protected Stack logMessages
The log messages.

userMessages

protected Stack userMessages
The user messages.

 

Constructor Detail

FatalApplicationException

public FatalApplicationException()
Constructs an FatalApplicationException with no associated message.

FatalApplicationException

public FatalApplicationException(FatalApplicationException topException, 
                                 FatalApplicationException bottomException)
Constructs an FatalApplicationException from two source FatalApplicationExceptions by concatinating the screen and log messages of the two source FatalApplicationExceptions. The messages of the first FatalApplicationException will preceed those of the second in the constructed FatalApplicationException. Furthermore, the new FatalApplicationException will have the embedded exception of the first FatalApplicationException associated with it.

FatalApplicationException

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

FatalApplicationException

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

FatalApplicationException

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

FatalApplicationException

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

FatalApplicationException

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

FatalApplicationException

public FatalApplicationException(String namespace, 
                                 String messageKey)
Class constructor taking the namespace and key of the associated catalog message.
 

Method Detail

addLogMessage(String, String) Method

public void addLogMessage(String namespace, 
                          String messageKey)
Description copied from MessageCatalogException.addLogMessage(String, String)
Adds a new log catalog message to the stack of associated messages.

Parameters

namespace
Log catalog message namespace.
messageKey
Log catalog message key.

addLogMessage(String, String, Object) Method

public void addLogMessage(String namespace, 
                          String messageKey, 
                          Object argument)
Description copied from MessageCatalogException.addLogMessage(String, String, Object)
Adds a new log catalog message to the stack of associated messages.

Parameters

namespace
Log catalog message namespace.
messageKey
Log catalog message key.
argument
Message parameter substitution argument.

addLogMessage(String, String, Object[]) Method

public void addLogMessage(String namespace, 
                          String messageKey, 
                          Object[] arguments)
Description copied from MessageCatalogException.addLogMessage(String, String, Object[])
Adds a new log catalog message to the stack of associated messages.

Parameters

namespace
Log catalog message namespace.
messageKey
Log catalog message key.
arguments
Message parameter substitution arguments.

addMessage(String, String) Method

public void addMessage(String namespace, 
                       String messageKey)
Description copied from MessageCatalogException.addMessage(String, String)
Adds a new user and log catalog message to the stack of associated messages.

Parameters

namespace
User and log catalog message namespace.
messageKey
User and log catalog message key.

addMessage(String, String, Object) Method

public void addMessage(String namespace, 
                       String messageKey, 
                       Object argument)
Description copied from MessageCatalogException.addMessage(String, String, Object)
Adds a new user catalog message to the stack of associated messages.

Parameters

namespace
User and log catalog message namespace.
messageKey
User and log catalog message key.
argument
Message parameter substitution argument.

addMessage(String, String, Object[]) Method

public void addMessage(String namespace, 
                       String messageKey, 
                       Object[] arguments)
Description copied from MessageCatalogException.addMessage(String, String, Object[])
Adds a new user catalog message to the stack of associated messages.

Parameters

namespace
User and log catalog message namespace.
messageKey
User and log catalog message key.
arguments
Message parameter substitution arguments.

addUserMessage(String, String) Method

public void addUserMessage(String namespace, 
                           String messageKey)
Description copied from MessageCatalogException.addUserMessage(String, String)
Adds a new user catalog message to the stack of associated messages.

Parameters

namespace
User catalog message namespace.
messageKey
User catalog message key.

addUserMessage(String, String, Object) Method

public void addUserMessage(String namespace, 
                           String messageKey, 
                           Object argument)
Description copied from MessageCatalogException.addUserMessage(String, String, Object)
Adds a new user catalog message to the stack of associated messages.

Parameters

namespace
User catalog message namespace.
messageKey
User catalog message key.
argument
Message parameter substitution argument.

addUserMessage(String, String, Object[]) Method

public void addUserMessage(String namespace, 
                           String messageKey, 
                           Object[] arguments)
Description copied from MessageCatalogException.addUserMessage(String, String, Object[])
Adds a new user catalog message to the stack of associated messages.

Parameters

namespace
User catalog message namespace.
messageKey
User catalog message key.
arguments
Message parameter substitution arguments.

getEmbeddedException() Method

public Exception getEmbeddedException()
Description copied from MessageCatalogException.getEmbeddedException()
Gets the embedded exception associated with this exception.

Returns

The embedded exception.

getLocalizedMessage() Method

public String getLocalizedMessage()
Returns the user message associated with this exception.

Overrides
Throwable.getLocalizedMessage()

Returns

The user message associated with this exception.

getLogMessage() Method

public String getLogMessage()
Description copied from MessageCatalogException.getLogMessage()
Returns the first log catalog message associated with this exception.

Returns

The first log catalog message associated with this exception.

getLogMessages() Method

public Iterator getLogMessages()
Description copied from MessageCatalogException.getLogMessages()
Returns an iterator over all the log catalog messages associated with this exception.

Returns

An iterator over all log catalog messages.

getMessage() Method

public String getMessage()
Returns the user message associated with this exception.

Overrides
Throwable.getMessage()

Returns

The user message associated with this exception.

getUserMessage() Method

public String getUserMessage()
Description copied from MessageCatalogException.getUserMessage()
Returns the first user catalog message associated with this exception.

Returns

The user catalog message associated with this exception.

getUserMessages() Method

public Iterator getUserMessages()
Description copied from MessageCatalogException.getUserMessages()
Returns an iterator over all the user catalog messages associated with this exception.

Returns

An iterator over all user catalog messages.

toString() Method

public String toString()
Returns a string representation of this exception.

Overrides
Throwable.toString()

Returns

A string representation of this exception.