2 * Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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).
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.
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
26 package java.security;
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.
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."
46 * @see PrivilegedExceptionAction
47 * @see AccessController#doPrivileged(PrivilegedExceptionAction)
48 * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)
50 public class PrivilegedActionException extends Exception {
51 // use serialVersionUID from JDK 1.2.2 for interoperability
52 private static final long serialVersionUID = 4724086851538908602L;
57 private Exception exception;
60 * Constructs a new PrivilegedActionException "wrapping"
61 * the specific Exception.
63 * @param exception The exception thrown
65 public PrivilegedActionException(Exception exception) {
66 super((Throwable)null); // Disallow initCause
67 this.exception = exception;
71 * Returns the exception thrown by the privileged computation that
72 * resulted in this <code>PrivilegedActionException</code>.
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.
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)
85 public Exception getException() {
90 * Returns the cause of this exception (the exception thrown by
91 * the privileged computation that resulted in this
92 * <code>PrivilegedActionException</code>).
94 * @return the cause of this exception.
97 public Throwable getCause() {
101 public String toString() {
102 String s = getClass().getName();
103 return (exception != null) ? (s + ": " + exception.toString()) : s;