com.ibm.websphere.exception

Class DistributedEJBCreateException

  • java.lang.Object
    • java.lang.Throwable
      • java.lang.Exception
        • javax.ejb.CreateException
          • com.ibm.websphere.exception.DistributedEJBCreateException
  • All Implemented Interfaces:
    DistributedExceptionEnabled, java.io.Serializable


    public class DistributedEJBCreateException
    extends javax.ejb.CreateException
    implements DistributedExceptionEnabled
    A subclass of javax.ejb.CreateException that provides exception functions desirable in a distributed environment. This includes the following:
    • Support to allow exceptions to be chained, in the situation where multiple exceptions are thrown during a series of method calls.
    • Saving stack trace information so that printStackTrace() will provide the stack trace of all chained exceptions.
    • Methods to retrieve specific exceptions in the chain.
    • Support for localized messages.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      DistributedEJBCreateException()
      Default constructor.
      DistributedEJBCreateException(java.lang.String message)
      Constructor with a message.
      DistributedEJBCreateException(java.lang.String resourceBundleName, java.lang.String resourceKey, java.lang.Object[] formatArguments, java.lang.String defaultText)
      Constructor with localization message information.
      DistributedEJBCreateException(java.lang.String resourceBundleName, java.lang.String resourceKey, java.lang.Object[] formatArguments, java.lang.String defaultText, java.lang.Throwable exception)
      Constructor with localization message information and an exception to be chained.
      DistributedEJBCreateException(java.lang.String message, java.lang.Throwable exception)
      Constructor with a message and an exception to be chained.
      DistributedEJBCreateException(java.lang.Throwable exception)
      Constructor with an exception to be chained.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Throwable getException(java.lang.String exceptionClassName)
      Get a specific exception in a possible chain of exceptions.
      DistributedExceptionInfo getExceptionInfo()
      Retrieve the DistributedExceptionInfo object.
      java.lang.String getMessage()
      Retrieve the text message for this exception.
      java.lang.Throwable getOriginalException()
      Get the original exception in a possible chain of exceptions.
      java.lang.Throwable getPreviousException()
      Get the previous exception.
      void printStackTrace()
      Print the exception execution stack.
      void printStackTrace(java.io.PrintWriter pw)
      Print the exception execution stack to a print writer.
      void printSuperStackTrace(java.io.PrintWriter pw)
      This method is used to get the stack trace of the current exception.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DistributedEJBCreateException

        public DistributedEJBCreateException()
        Default constructor.
      • DistributedEJBCreateException

        public DistributedEJBCreateException(java.lang.String message)
        Constructor with a message.
        Parameters:
        message - java.lang.String Message text
      • DistributedEJBCreateException

        public DistributedEJBCreateException(java.lang.String resourceBundleName,
                                     java.lang.String resourceKey,
                                     java.lang.Object[] formatArguments,
                                     java.lang.String defaultText)
        Constructor with localization message information.
        Parameters:
        resourceBundleName - java.lang.String The name of resource bundle that will be used to retrieve the message for getMessage().
        resourceKey - java.lang.String The key in the resource bundle that will be used to select the specific message that is retrieved for getMessage().
        formatArguments - java.lang.Object[] The arguments to be passed to the MessageFormat class to act as replacement variables in the message that is retrieved from the resource bundle. Valid types are those supported by MessageFormat.
        defaultText - java.lang.String The default message that will be used in getMessage() if the resource bundle or the key cannot be found.
        See Also:
        getMessage(), MessageFormat
      • DistributedEJBCreateException

        public DistributedEJBCreateException(java.lang.String resourceBundleName,
                                     java.lang.String resourceKey,
                                     java.lang.Object[] formatArguments,
                                     java.lang.String defaultText,
                                     java.lang.Throwable exception)
        Constructor with localization message information and an exception to be chained.
        Parameters:
        resourceBundleName - java.lang.String The name of resource bundle that will be used to retrieve the message for getMessage().
        resourceKey - java.lang.String The key in the resource bundle that will be used to select the specific message that is retrieved for getMessage().
        formatArguments - java.lang.Object[] The arguments to be passed to the MessageFormat class to act as replacement variables in the message that is retrieved from the resource bundle. Valid types are those supported by MessageFormat.
        defaultText - java.lang.String The default message that will be used in getMessage() if the resource bundle or the key cannot be found.
        exception - java.lang.Throwable The exception that is to be chained.
        See Also:
        getMessage(), MessageFormat
      • DistributedEJBCreateException

        public DistributedEJBCreateException(java.lang.String message,
                                     java.lang.Throwable exception)
        Constructor with a message and an exception to be chained.
        Parameters:
        message - The message for this exception
        exception - java.lang.Throwable The exception to be chained
      • DistributedEJBCreateException

        public DistributedEJBCreateException(java.lang.Throwable exception)
        Constructor with an exception to be chained.
        Parameters:
        exception - java.lang.Throwable The exception to be chained
    • Method Detail

      • getException

        public java.lang.Throwable getException(java.lang.String exceptionClassName)
                                         throws ExceptionInstantiationException
        Get a specific exception in a possible chain of exceptions. If there are multiple exceptions in the chain, the most recent one thrown will be returned. If the exceptions does not exist or no exceptions have been chained, null will be returned.
        Specified by:
        getException in interface DistributedExceptionEnabled
        Parameters:
        String - exceptionClassName the class name of the specific exception.
        Returns:
        java.lang.Throwable The specific exception in a chain of exceptions. If no exceptions have been chained, null will be returned.
        Throws:
        ExceptionInstantiationException - An exception occurred while trying to instantiate the exception object. If this exception is thrown, the relevant information can be retrieved by using the getExceptionInfo() method followed by recursively using the getPreviousExceptionInfo() method on the DistributedExceptionInfo object.
      • getExceptionInfo

        public DistributedExceptionInfo getExceptionInfo()
        Retrieve the DistributedExceptionInfo object. This object is primarily used by a CORBA, non-Java client. It also may be used by a Java client to retrieve information about a previous exception when the getPreveiousException() method throws an exception.
        Specified by:
        getExceptionInfo in interface DistributedExceptionEnabled
        Returns:
        com.ibm.websphere.exception.DistributedExceptionInfo
      • getMessage

        public java.lang.String getMessage()
        Retrieve the text message for this exception. If a resource bundle and resource key have been previously specified when the exception was created, an attempt will be made to retrieve the message from the resource bundle for the language associated with the current locale. The default message (which may be null) will be returned in any of the following situations:
        • No resource bundle name exists
        • No resource key exists
        • The resource bundle could not be found
        • The key was not found in the resource bundle
        Specified by:
        getMessage in interface DistributedExceptionEnabled
        Overrides:
        getMessage in class java.lang.Throwable
        Returns:
        java.lang.String message for this exception
      • getOriginalException

        public java.lang.Throwable getOriginalException()
                                                 throws ExceptionInstantiationException
        Get the original exception in a possible chain of exceptions. If no previous exceptions have been chained, null will be returned.
        Specified by:
        getOriginalException in interface DistributedExceptionEnabled
        Returns:
        java.lang.Throwable The first exception in a chain of exceptions. If no exceptions have been chained, null will be returned.
        Throws:
        ExceptionInstantiationException - An exception occurred while trying to instantiate the exception object. If this exception is thrown, the relevant information can be retrieved by using the getExceptionInfo() method followed by recursively using the getPreviousExceptionInfo() method on the DistributedExceptionInfo object.
      • getPreviousException

        public java.lang.Throwable getPreviousException()
                                                 throws ExceptionInstantiationException
        Get the previous exception.
        Specified by:
        getPreviousException in interface DistributedExceptionEnabled
        Returns:
        java.lang.Throwable The previous exception. If there was no previous exception, null will be returned. .
        Throws:
        ExceptionInstantiationException - An exception occurred while trying to instantiate the exception object. If this exception is thrown, the relevant information can be retrieved by using the getExceptionInfo() method.
      • printStackTrace

        public void printStackTrace()
        Print the exception execution stack. This will include the stack trace of where the exception was created, as well as the stack traces of previous exceptions in the exception chain.
        Specified by:
        printStackTrace in interface DistributedExceptionEnabled
        Overrides:
        printStackTrace in class java.lang.Throwable
      • printStackTrace

        public void printStackTrace(java.io.PrintWriter pw)
        Print the exception execution stack to a print writer. This will include the stack trace of where the exception was created, as well as the stack traces of previous exceptions in the exception chain.
        Specified by:
        printStackTrace in interface DistributedExceptionEnabled
        Overrides:
        printStackTrace in class java.lang.Throwable
        Parameters:
        pw - java.io.PrintWriter
      • printSuperStackTrace

        public void printSuperStackTrace(java.io.PrintWriter pw)
        This method is used to get the stack trace of the current exception. This method is called by DistributedExceptionInfo to retrieve and save the current stack trace. The information is saved and can be retrieved by printStackTrace();
        Specified by:
        printSuperStackTrace in interface DistributedExceptionEnabled
        Parameters:
        param - java.io.PrintWriter
IBM WebSphere Application ServerTM
Release 9.0