org.openejb
Class OpenEJBException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.openejb.OpenEJBException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationException, ServiceException, SystemException

public class OpenEJBException

extends Exception

The OpenEJBException is the standard exception thrown by all methods in all type in the Container Provider Interface (CPI). The OpenEJBException has 3 subtypes each serving a different purpose. The CPI will always thrown one of these subtype and never the OpenEJBException itself.

• org.openejb.ApplicationException
  This type is thrown when a normal EnterpriseBean exception is thrown. The ApplicationException's nested Exception will be either an EJB ApplicationException ( a custom exception defined by the bean developer) or a RemoteException. The org.openejb.ApplicationException must be caught and its nested exception rethrown by the bean proxy to the client. The org.openejb.ApplicationException is non-system exception; it does NOT indicate a problem with the contaienr itself.
• org.openejb.InvalidateReferenceException
  This type is thrown when the EnterpriseBean throws a RuntimeException or system exception that results in the eviction of the bean instance. The InvalidateReferenceException's nested exception will be a RuntimeException, which must be converted to a RemoteException or the nested exception will be a RemoteException. The Application Server must catch the InvalidateReferenceException and its nested exception rethrown by the bean proxy (if the nested exception is a RuntimeException it must first be converted to a RemoteException). After the exception is re-thrown by the bean proxy, the bean proxy must be invalidated so that all subsequent invocations by the client on that bean proxy throw a RemoteException. The proxy is made invalid. InvalidateReferenceException is non-system exception; it does NOT indicate a problem with the container itself.
• org.openejb.SystemException
  This type is thrown when the container has encountered an unresolvable system exception that make this Container unable to process requests. A breakdown in communication with one of the primary services or a RuntimeException thrown within the container (not by a bean) is are good examples. The org.openejb.SystemException represents a serious problem with the Container. The Container should be shut down and not used for any more processing.

Version:

$Revision: 1096 $ $Date: 2004-03-26 13:41:16 -0800 (Fri, 26 Mar 2004) $

Author:

Assaf Arkin, Brett McLaughlin, Richard Monson-Haefel

See Also:

ApplicationException, InvalidateReferenceException, OpenEJBException, SystemException, Serialized Form

Constructor Summary

OpenEJBException()
Default constructor, which simply delegates exception handling up the inheritance chain to Exception.

OpenEJBException(String message)
This constructor allows a message to be supplied indicating the source of the problem that occurred.

OpenEJBException(String message, Throwable rootCause)
This constructor allows both a message identifying the problem that occurred as well as a "root cause" exception to be supplied, which may later be used by the wrapping application.

OpenEJBException(Throwable rootCause)
This constructor allows a "root cause" exception to be supplied, which may later be used by the wrapping application.

Method Summary

String	getMessage() This returns the message for the Exception.
Throwable	getRootCause() This will return the root cause Throwable, or null if one does not exist.
void	printStackTrace() This prints the stack trace of the Exception.
void	printStackTrace(PrintStream stream) This prints the stack trace of the Exception.
void	printStackTrace(PrintWriter writer) This prints the stack trace of the Exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenEJBException

public OpenEJBException()

Default constructor, which simply delegates exception handling up the inheritance chain to Exception.

OpenEJBException

public OpenEJBException(String message)

This constructor allows a message to be supplied indicating the source of the problem that occurred.

Parameters:

message - String identifying the cause of the problem.

OpenEJBException

public OpenEJBException(Throwable rootCause)

This constructor allows a "root cause" exception to be supplied, which may later be used by the wrapping application.

Parameters:

rootCause - Throwable that triggered the problem.

OpenEJBException

public OpenEJBException(String message,
                        Throwable rootCause)

This constructor allows both a message identifying the problem that occurred as well as a "root cause" exception to be supplied, which may later be used by the wrapping application.

Parameters:

message - String identifying the cause of the problem.

rootCause - Throwable that triggered this problem.

Method Detail

getMessage

public String getMessage()

This returns the message for the Exception. If there is a root cause, the message associated with the root cause is appended.

Returns:

String - message for this Exception.

printStackTrace

public void printStackTrace()

This prints the stack trace of the Exception. If there is a root cause, the stack trace of the root Exception is printed right after.

printStackTrace

public void printStackTrace(PrintStream stream)

This prints the stack trace of the Exception. If there is a root cause, the stack trace of the root Exception is printed right after.

Parameters:

stream - PrintStream to print stack trace to.

printStackTrace

public void printStackTrace(PrintWriter writer)

This prints the stack trace of the Exception. If there is a root cause, the stack trace of the root Exception is printed right after.

Parameters:

writer - PrintWriter to print stack trace to.

getRootCause

public Throwable getRootCause()

This will return the root cause Throwable, or null if one does not exist.

Returns:

Throwable - the wrapped Throwable.