Save This Page
Home » openejb-3.1.2-src » javax » ejb » [javadoc | source]
    1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   package javax.ejb;
   23   
   24   /**
   25    * The EJBException exception is thrown by an enterprise Bean instance to its
   26    * container to report that the invoked business method or callback method
   27    * could not be completed because of an unexpected error (e.g. the instance
   28    * failed to open a database connection).
   29    */
   30   public class EJBException extends RuntimeException
   31   {
   32      /** @since 4.0.2 */
   33      private static final long serialVersionUID = 796770993296843510L;
   34      private Exception causeException;
   35      
   36      /**
   37       * Constructs an EJBException with no detail message.
   38       */
   39      public EJBException()
   40      {
   41         super();
   42         causeException = null;
   43      }
   44      
   45      /**
   46       * Constructs an EJBException with the specified detailed message.
   47       *
   48       * @param message - The detailed message.
   49       */
   50      public EJBException(String message)
   51      {
   52         super(message);
   53         causeException = null;
   54      }
   55   
   56      /**
   57       * Constructs an EJBException that embeds the originally thrown exception.
   58       *
   59       * @param ex - The originally thrown exception.
   60       */
   61      public EJBException(Exception ex)
   62      {
   63         super(ex);
   64         causeException = ex;
   65      }
   66   
   67      /**
   68       * Constructs an EJBException with the specified message and the
   69       * originally throw exception.
   70       *
   71       * @param message - The detailed message.
   72       * @param ex - The originally thrown exception.
   73       */
   74      public EJBException(String message, Exception ex)
   75      {
   76         super(message, ex);
   77         causeException = ex;
   78      }
   79   
   80      /**
   81       * Obtain the exception that caused the EJBException being thrown.
   82       *
   83       * @return The originally thrown exception.
   84       */
   85      public Exception getCausedByException()
   86      {
   87         return causeException;
   88      }
   89   
   90   }
   91   

Save This Page
Home » openejb-3.1.2-src » javax » ejb » [javadoc | source]