001/* PrivilegedActionException.java -- wrap an exception in a privileged action
002   Copyright (C) 1998, 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.security;
039
040/**
041 * This exception is thrown when an exception is thrown during a
042 * privileged action being performed with the
043 * <code>AccessController.doPrivileged()</code> method.  It wraps the
044 * actual exception thrown in the privileged code.
045 *
046 * @author Aaron M. Renn (arenn@urbanophile.com)
047 * @author Eric Blake (ebb9@email.byu.edu)
048 * @see PrivilegedExceptionAction
049 * @see AccessController#doPrivileged(PrivilegedExceptionAction)
050 * @see AccessController#doPrivileged(PrivilegedExceptionAction, AccessControlContext)
051 * @status updated to 1.4
052 */
053public class PrivilegedActionException extends Exception
054{
055  /**
056   * Compatible with JDK 1.1+.
057   */
058  private static final long serialVersionUID = 4724086851538908602L;
059
060  /**
061   * This is the actual exception that occurred.
062   *
063   * @serial the wrapped exception
064   */
065  private Exception exception;
066
067  /**
068   * Create a new instance that wraps the specified <code>Exception</code>.
069   *
070   * @param e the <code>Exception</code> to wrap
071   */
072  public PrivilegedActionException(Exception e)
073  {
074    super(e);
075    exception = e;
076  }
077
078  /**
079   * Get the underlying <code>Exception</code> that caused this one. This
080   * is a legacy method, the preferred way is {@link #getCause()}.
081   *
082   * @return the cause
083   */
084  public Exception getException()
085  {
086    return exception;
087  }
088
089  /**
090   * Gets the cause of this exception.
091   *
092   * @return the cause
093   * @since 1.4
094   */
095  public Throwable getCause()
096  {
097    return exception;
098  }
099
100  /**
101   * Convert this to a String.
102   *
103   * @return the string representation
104   */
105  public String toString()
106  {
107    return super.toString();
108  }
109}