001 /*
002 * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.security;
027
028 /**
029 * This exception is thrown by
030 * <code>doPrivileged(PrivilegedExceptionAction)</code> and
031 * <code>doPrivileged(PrivilegedExceptionAction,
032 * AccessControlContext context)</code> to indicate
033 * that the action being performed threw a checked exception. The exception
034 * thrown by the action can be obtained by calling the
035 * <code>getException</code> method. In effect, an
036 * <code>PrivilegedActionException</code> is a "wrapper"
037 * for an exception thrown by a privileged action.
038 *
039 * <p>As of release 1.4, this exception has been retrofitted to conform to
040 * the general purpose exception-chaining mechanism. The "exception thrown
041 * by the privileged computation" that is provided at construction time and
042 * accessed via the {@link #getException()} method is now known as the
043 * <i>cause</i>, and may be accessed via the {@link Throwable#getCause()}
044 * method, as well as the aforementioned "legacy method."
045 *
046 * @see PrivilegedExceptionAction
047 * @see AccessController#doPrivileged(PrivilegedExceptionAction)
048 * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)
049 */
050 public class PrivilegedActionException extends Exception {
051 // use serialVersionUID from JDK 1.2.2 for interoperability
052 private static final long serialVersionUID = 4724086851538908602L;
053
054 /**
055 * @serial
056 */
057 private Exception exception;
058
059 /**
060 * Constructs a new PrivilegedActionException "wrapping"
061 * the specific Exception.
062 *
063 * @param exception The exception thrown
064 */
065 public PrivilegedActionException(Exception exception) {
066 super ((Throwable) null); // Disallow initCause
067 this .exception = exception;
068 }
069
070 /**
071 * Returns the exception thrown by the privileged computation that
072 * resulted in this <code>PrivilegedActionException</code>.
073 *
074 * <p>This method predates the general-purpose exception chaining facility.
075 * The {@link Throwable#getCause()} method is now the preferred means of
076 * obtaining this information.
077 *
078 * @return the exception thrown by the privileged computation that
079 * resulted in this <code>PrivilegedActionException</code>.
080 * @see PrivilegedExceptionAction
081 * @see AccessController#doPrivileged(PrivilegedExceptionAction)
082 * @see AccessController#doPrivileged(PrivilegedExceptionAction,
083 * AccessControlContext)
084 */
085 public Exception getException() {
086 return exception;
087 }
088
089 /**
090 * Returns the the cause of this exception (the exception thrown by
091 * the privileged computation that resulted in this
092 * <code>PrivilegedActionException</code>).
093 *
094 * @return the cause of this exception.
095 * @since 1.4
096 */
097 public Throwable getCause() {
098 return exception;
099 }
100
101 public String toString() {
102 String s = getClass().getName();
103 return (exception != null) ? (s + ": " + exception.toString())
104 : s;
105 }
106 }
|