J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.security; |
| 27 | |
| 28 | /** |
| 29 | * This exception is thrown by |
| 30 | * <code>doPrivileged(PrivilegedExceptionAction)</code> and |
| 31 | * <code>doPrivileged(PrivilegedExceptionAction, |
| 32 | * AccessControlContext context)</code> to indicate |
| 33 | * that the action being performed threw a checked exception. The exception |
| 34 | * thrown by the action can be obtained by calling the |
| 35 | * <code>getException</code> method. In effect, an |
| 36 | * <code>PrivilegedActionException</code> is a "wrapper" |
| 37 | * for an exception thrown by a privileged action. |
| 38 | * |
| 39 | * <p>As of release 1.4, this exception has been retrofitted to conform to |
| 40 | * the general purpose exception-chaining mechanism. The "exception thrown |
| 41 | * by the privileged computation" that is provided at construction time and |
| 42 | * accessed via the {@link #getException()} method is now known as the |
| 43 | * <i>cause</i>, and may be accessed via the {@link Throwable#getCause()} |
| 44 | * method, as well as the aforementioned "legacy method." |
| 45 | * |
| 46 | * @see PrivilegedExceptionAction |
| 47 | * @see AccessController#doPrivileged(PrivilegedExceptionAction) |
| 48 | * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext) |
| 49 | */ |
| 50 | public class PrivilegedActionException extends Exception { |
| 51 | // use serialVersionUID from JDK 1.2.2 for interoperability |
| 52 | private static final long serialVersionUID = 4724086851538908602L; |
| 53 | |
| 54 | /** |
| 55 | * @serial |
| 56 | */ |
| 57 | private Exception exception; |
| 58 | |
| 59 | /** |
| 60 | * Constructs a new PrivilegedActionException "wrapping" |
| 61 | * the specific Exception. |
| 62 | * |
| 63 | * @param exception The exception thrown |
| 64 | */ |
| 65 | public PrivilegedActionException(Exception exception) { |
| 66 | super((Throwable)null); // Disallow initCause |
| 67 | this.exception = exception; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns the exception thrown by the privileged computation that |
| 72 | * resulted in this <code>PrivilegedActionException</code>. |
| 73 | * |
| 74 | * <p>This method predates the general-purpose exception chaining facility. |
| 75 | * The {@link Throwable#getCause()} method is now the preferred means of |
| 76 | * obtaining this information. |
| 77 | * |
| 78 | * @return the exception thrown by the privileged computation that |
| 79 | * resulted in this <code>PrivilegedActionException</code>. |
| 80 | * @see PrivilegedExceptionAction |
| 81 | * @see AccessController#doPrivileged(PrivilegedExceptionAction) |
| 82 | * @see AccessController#doPrivileged(PrivilegedExceptionAction, |
| 83 | * AccessControlContext) |
| 84 | */ |
| 85 | public Exception getException() { |
| 86 | return exception; |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Returns the the cause of this exception (the exception thrown by |
| 91 | * the privileged computation that resulted in this |
| 92 | * <code>PrivilegedActionException</code>). |
| 93 | * |
| 94 | * @return the cause of this exception. |
| 95 | * @since 1.4 |
| 96 | */ |
| 97 | public Throwable getCause() { |
| 98 | return exception; |
| 99 | } |
| 100 | |
| 101 | public String toString() { |
| 102 | String s = getClass().getName(); |
| 103 | return (exception != null) ? (s + ": " + exception.toString()) : s; |
| 104 | } |
| 105 | } |