|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
javax.ejb.EJBException
com.beasys.commerce.foundation.exception.SystemException
The SystemException
class is used to signal system-level exceptions
to a caller. It is the base system exception class. A system-level exception
is a severe exception that prevents a thread of execution from proceeding in a
normal manner.
The SystemException
class is closely tied to the
MessageCatalog
. An SystemException
contains a log and user message that is constructed using the MessageCatalog
.
In fact, each SystemException
derivative should have at
least one user and log catalog message.
In the case of an EJB, the following guidelines should be followed:
If an enterprise bean method encounters a system-level exception or error that does not allow the method to successfully complete, the method should throw a suitable system exception compatible with the method's throw clause:
RuntimeException
or
error, it should simply propagate the error from the bean method to the Container.
SystemException
or
derivative that wraps the original exception.
SystemException
or EJBException
.
A bean provider is responsible for using the standard EJB system exceptions
(EJBException
and NoSuchEntityException
) where
appropriate.
Since the practice of throwing a RemoteException
has been deprecated
in the EJB 1.1 specification, all such occurrences must be replaced with an
instance of SystemException
. In the case of a bean method that calls
another bean method, all RemoteException
s should simply be propagated
from the bean method.
If an EJB method throws a SystemException
, any existing
transaction will be rolled back by the Container and the bean's state will
be set to "does not exists".
EJBException
,
MessageCatalog
,
MessageCatalogException
,
Serialized FormField Summary | |
protected Stack |
logMessages
The log messages. |
protected Stack |
userMessages
The user messages. |
Constructor Summary | |
SystemException()
Constructs an SystemException with no associated message. |
|
SystemException(String namespace,
String messageKey)
Class constructor taking the namespace and key of the associated catalog message. |
|
SystemException(String namespace,
String messageKey,
Exception exception)
Class constructor taking the namespace and key of the associated catalog message and an embedded exception. |
|
SystemException(String namespace,
String messageKey,
Object argument)
Class constructor taking the namespace and key of the associated catalog message and a message parameter substitution argument. |
|
SystemException(String namespace,
String messageKey,
Object[] arguments)
Class constructor taking the namespace and key of the associated catalog message and message parameter substitution arguments. |
|
SystemException(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. |
|
SystemException(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. |
|
SystemException(SystemException topException,
SystemException bottomException)
Constructs an SystemException from two source SystemException s
by concatinating the screen and log messages of the two source SystemException s.
|
Method Summary | |
void |
addLogMessage(String namespace,
String messageKey)
Adds a new log catalog message to the stack of associated messages. |
void |
addLogMessage(String namespace,
String messageKey,
Object argument)
Adds a new log catalog message to the stack of associated messages. |
void |
addLogMessage(String namespace,
String messageKey,
Object[] arguments)
Adds a new log catalog message to the stack of associated messages. |
void |
addMessage(String namespace,
String messageKey)
Adds a new user and log catalog message to the stack of associated messages. |
void |
addMessage(String namespace,
String messageKey,
Object argument)
Adds a new user catalog message to the stack of associated messages. |
void |
addMessage(String namespace,
String messageKey,
Object[] arguments)
Adds a new user catalog message to the stack of associated messages. |
void |
addUserMessage(String namespace,
String messageKey)
Adds a new user catalog message to the stack of associated messages. |
void |
addUserMessage(String namespace,
String messageKey,
Object argument)
Adds a new user catalog message to the stack of associated messages. |
void |
addUserMessage(String namespace,
String messageKey,
Object[] arguments)
Adds a new user catalog message to the stack of associated messages. |
Exception |
getEmbeddedException()
Gets the embedded exception associated with this exception. |
String |
getLocalizedMessage()
Returns the user message associated with this exception. |
String |
getLogMessage()
Returns the first log catalog message associated with this exception. |
Iterator |
getLogMessages()
Returns an iterator over all the log catalog messages associated with this exception. |
String |
getMessage()
Returns the user message associated with this exception. |
String |
getUserMessage()
Returns the first user catalog message associated with this exception. |
Iterator |
getUserMessages()
Returns an iterator over all the user catalog messages associated with this exception. |
String |
toString()
Returns a string representation of this exception. |
Methods inherited from class javax.ejb.EJBException |
getCausedByException, printStackTrace, printStackTrace, printStackTrace |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getStackTrace, initCause, setStackTrace |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected Stack logMessages
protected Stack userMessages
Constructor Detail |
public SystemException()
SystemException
with no associated message.
public SystemException(String namespace, String messageKey)
public SystemException(String namespace, String messageKey, Exception exception)
public SystemException(String namespace, String messageKey, Object argument)
public SystemException(String namespace, String messageKey, Object[] arguments)
public SystemException(String namespace, String messageKey, Object[] arguments, Exception exception)
public SystemException(String namespace, String messageKey, Object argument, Exception exception)
public SystemException(SystemException topException, SystemException bottomException)
SystemException
from two source SystemException
s
by concatinating the screen and log messages of the two source SystemException
s.
The messages of the first SystemException
will preceed those of the second in the
constructed SystemException
. Furthermore, the new SystemException
will have the embedded exception of the first SystemException
associated with it.
Method Detail |
public void addLogMessage(String namespace, String messageKey)
MessageCatalogException
addLogMessage
in interface MessageCatalogException
namespace
- Log catalog message namespace.messageKey
- Log catalog message key.public void addLogMessage(String namespace, String messageKey, Object argument)
MessageCatalogException
addLogMessage
in interface MessageCatalogException
namespace
- Log catalog message namespace.messageKey
- Log catalog message key.argument
- Message parameter substitution argument.public void addLogMessage(String namespace, String messageKey, Object[] arguments)
MessageCatalogException
addLogMessage
in interface MessageCatalogException
namespace
- Log catalog message namespace.messageKey
- Log catalog message key.public void addMessage(String namespace, String messageKey)
MessageCatalogException
addMessage
in interface MessageCatalogException
namespace
- User and log catalog message namespace.messageKey
- User and log catalog message key.public void addMessage(String namespace, String messageKey, Object argument)
MessageCatalogException
addMessage
in interface MessageCatalogException
namespace
- User and log catalog message namespace.messageKey
- User and log catalog message key.argument
- Message parameter substitution argument.public void addMessage(String namespace, String messageKey, Object[] arguments)
MessageCatalogException
addMessage
in interface MessageCatalogException
namespace
- User and log catalog message namespace.messageKey
- User and log catalog message key.public void addUserMessage(String namespace, String messageKey)
MessageCatalogException
addUserMessage
in interface MessageCatalogException
namespace
- User catalog message namespace.messageKey
- User catalog message key.public void addUserMessage(String namespace, String messageKey, Object argument)
MessageCatalogException
addUserMessage
in interface MessageCatalogException
namespace
- User catalog message namespace.messageKey
- User catalog message key.argument
- Message parameter substitution argument.public void addUserMessage(String namespace, String messageKey, Object[] arguments)
MessageCatalogException
addUserMessage
in interface MessageCatalogException
namespace
- User catalog message namespace.messageKey
- User catalog message key.public Exception getEmbeddedException()
MessageCatalogException
getEmbeddedException
in interface MessageCatalogException
public String getLocalizedMessage()
public String getLogMessage()
MessageCatalogException
getLogMessage
in interface MessageCatalogException
public Iterator getLogMessages()
MessageCatalogException
getLogMessages
in interface MessageCatalogException
public String getMessage()
public String getUserMessage()
MessageCatalogException
getUserMessage
in interface MessageCatalogException
public Iterator getUserMessages()
MessageCatalogException
getUserMessages
in interface MessageCatalogException
public String toString()
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |