rev 51958 : 8211122: Reduce the number of internal classes made accessible to jdk.unsupported
Reviewed-by: alanb, dfuchs, kvn

   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  * This exception is thrown by
  30  * {@code doPrivileged(PrivilegedExceptionAction)} and
  31  * {@code doPrivileged(PrivilegedExceptionAction,
  32  * AccessControlContext context)} 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} method.  In effect, an
  36  * {@code PrivilegedActionException} 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  * @since 1.2
  47  * @see PrivilegedExceptionAction
  48  * @see AccessController#doPrivileged(PrivilegedExceptionAction)
  49  * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)
  50  */
  51 public class PrivilegedActionException extends Exception {
  52     // use serialVersionUID from JDK 1.2.2 for interoperability
  53     private static final long serialVersionUID = 4724086851538908602L;
  54 
  55     /**
  56      * @serial
  57      */
  58     private Exception exception;
  59 
  60     /**
  61      * Constructs a new PrivilegedActionException &quot;wrapping&quot;
  62      * the specific Exception.
  63      *
  64      * @param exception The exception thrown
  65      */
  66     public PrivilegedActionException(Exception exception) {
  67         super((Throwable)null);  // Disallow initCause
  68         this.exception = exception;
  69     }
  70 
  71     /**
  72      * Returns the exception thrown by the privileged computation that
  73      * resulted in this {@code PrivilegedActionException}.
  74      *
  75      * <p>This method predates the general-purpose exception chaining facility.
  76      * The {@link Throwable#getCause()} method is now the preferred means of
  77      * obtaining this information.
  78      *
  79      * @return the exception thrown by the privileged computation that
  80      *         resulted in this {@code PrivilegedActionException}.
  81      * @see PrivilegedExceptionAction
  82      * @see AccessController#doPrivileged(PrivilegedExceptionAction)
  83      * @see AccessController#doPrivileged(PrivilegedExceptionAction,
  84      *                                            AccessControlContext)
  85      */
  86     public Exception getException() {
  87         return exception;
  88     }
  89 
  90     /**
  91      * Returns the cause of this exception (the exception thrown by
  92      * the privileged computation that resulted in this
  93      * {@code PrivilegedActionException}).
  94      *
  95      * @return  the cause of this exception.
  96      * @since   1.4
  97      */
  98     public Throwable getCause() {
  99         return exception;
 100     }
 101 
 102     public String toString() {
 103         String s = getClass().getName();
 104         return (exception != null) ? (s + ": " + exception.toString()) : s;
 105     }
 106 }
--- EOF ---