1 /*
2  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. 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.  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.
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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package java.security;
27 
28 /**
29  * Legacy security code; do not use.
30  *
31  * This exception is thrown by
32  * {@code doPrivileged(PrivilegedExceptionAction)} and
33  * {@code doPrivileged(PrivilegedExceptionAction,
34  * AccessControlContext context)} to indicate
35  * that the action being performed threw a checked exception.  The exception
36  * thrown by the action can be obtained by calling the
37  * {@code getException} method.  In effect, an
38  * {@code PrivilegedActionException} is a "wrapper"
39  * for an exception thrown by a privileged action.
40  *
41  * <p>As of release 1.4, this exception has been retrofitted to conform to
42  * the general purpose exception-chaining mechanism.  The "exception thrown
43  * by the privileged computation" that is provided at construction time and
44  * accessed via the {@link #getException()} method is now known as the
45  * <i>cause</i>, and may be accessed via the {@link Throwable#getCause()}
46  * method, as well as the aforementioned "legacy method."
47  *
48  * @see PrivilegedExceptionAction
49  * @see AccessController#doPrivileged(PrivilegedExceptionAction)
50  * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)
51  */
52 public class PrivilegedActionException extends Exception {
53     // use serialVersionUID from JDK 1.2.2 for interoperability
54     private static final long serialVersionUID = 4724086851538908602L;
55 
56     /**
57      * @serial
58      */
59     private Exception exception;
60 
61     /**
62      * Constructs a new PrivilegedActionException &quot;wrapping&quot;
63      * the specific Exception.
64      *
65      * @param exception The exception thrown
66      */
PrivilegedActionException(Exception exception)67     public PrivilegedActionException(Exception exception) {
68         super((Throwable)null);  // Disallow initCause
69         this.exception = exception;
70     }
71 
72     /**
73      * Returns the exception thrown by the privileged computation that
74      * resulted in this {@code PrivilegedActionException}.
75      *
76      * <p>This method predates the general-purpose exception chaining facility.
77      * The {@link Throwable#getCause()} method is now the preferred means of
78      * obtaining this information.
79      *
80      * @return the exception thrown by the privileged computation that
81      *         resulted in this {@code PrivilegedActionException}.
82      * @see PrivilegedExceptionAction
83      * @see AccessController#doPrivileged(PrivilegedExceptionAction)
84      * @see AccessController#doPrivileged(PrivilegedExceptionAction,
85      *                                            AccessControlContext)
86      */
getException()87     public Exception getException() {
88         return exception;
89     }
90 
91     /**
92      * Returns the cause of this exception (the exception thrown by
93      * the privileged computation that resulted in this
94      * {@code PrivilegedActionException}).
95      *
96      * @return  the cause of this exception.
97      * @since   1.4
98      */
getCause()99     public Throwable getCause() {
100         return exception;
101     }
102 
toString()103     public String toString() {
104         String s = getClass().getName();
105         return (exception != null) ? (s + ": " + exception.toString()) : s;
106     }
107 }
108