Source for java.security.PrivilegedActionException

   1: /* PrivilegedActionException.java -- wrap an exception in a privileged action
   2:    Copyright (C) 1998, 2002, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.security;
  39: 
  40: /**
  41:  * This exception is thrown when an exception is thrown during a
  42:  * privileged action being performed with the
  43:  * <code>AccessController.doPrivileged()</code> method.  It wraps the
  44:  * actual exception thrown in the privileged code.
  45:  *
  46:  * @author Aaron M. Renn (arenn@urbanophile.com)
  47:  * @author Eric Blake (ebb9@email.byu.edu)
  48:  * @see PrivilegedExceptionAction
  49:  * @see AccessController#doPrivileged(PrivilegedExceptionAction)
  50:  * @see AccessController#doPrivileged(PrivilegedExceptionAction, AccessControlContext)
  51:  * @status updated to 1.4
  52:  */
  53: public class PrivilegedActionException extends Exception
  54: {
  55:   /**
  56:    * Compatible with JDK 1.1+.
  57:    */
  58:   private static final long serialVersionUID = 4724086851538908602L;
  59: 
  60:   /**
  61:    * This is the actual exception that occurred.
  62:    *
  63:    * @serial the wrapped exception
  64:    */
  65:   private Exception exception;
  66: 
  67:   /**
  68:    * Create a new instance that wraps the specified <code>Exception</code>.
  69:    *
  70:    * @param e the <code>Exception</code> to wrap
  71:    */
  72:   public PrivilegedActionException(Exception e)
  73:   {
  74:     super(e);
  75:     exception = e;
  76:   }
  77: 
  78:   /**
  79:    * Get the underlying <code>Exception</code> that caused this one. This
  80:    * is a legacy method, the preferred way is {@link #getCause()}.
  81:    *
  82:    * @return the cause
  83:    */
  84:   public Exception getException()
  85:   {
  86:     return exception;
  87:   }
  88: 
  89:   /**
  90:    * Gets the cause of this exception.
  91:    *
  92:    * @return the cause
  93:    * @since 1.4
  94:    */
  95:   public Throwable getCause()
  96:   {
  97:     return exception;
  98:   }
  99: 
 100:   /**
 101:    * Convert this to a String.
 102:    *
 103:    * @return the string representation
 104:    */
 105:   public String toString()
 106:   {
 107:     return super.toString();
 108:   }
 109: }