PrivilegedActionException

AI-generated Key Takeaways

• PrivilegedActionException is a legacy security exception and should not be used in new code.

• It wraps a checked exception thrown by a privileged action executed using doPrivileged.

• The wrapped exception can be accessed using getException() (legacy) or getCause().

• PrivilegedActionException conforms to the general-purpose exception-chaining mechanism introduced in Java 1.4.

public class PrivilegedActionException extends Exception

Legacy security code; do not use. This exception is thrown by doPrivileged(PrivilegedExceptionAction) and doPrivileged(PrivilegedExceptionAction, AccessControlContext context) to indicate that the action being performed threw a checked exception. The exception thrown by the action can be obtained by calling the getException method. In effect, an PrivilegedActionException is a "wrapper" for an exception thrown by a privileged action.

As of release 1.4, this exception has been retrofitted to conform to the general purpose exception-chaining mechanism. The "exception thrown by the privileged computation" that is provided at construction time and accessed via the getException() method is now known as the cause, and may be accessed via the Throwable.getCause() method, as well as the aforementioned "legacy method."

See Also

• PrivilegedExceptionAction
• AccessController.doPrivileged(PrivilegedExceptionAction)
• AccessController.doPrivileged(PrivilegedExceptionAction, AccessControlContext)

Public Constructor Summary

PrivilegedActionException(Exception exception) Constructs a new PrivilegedActionException "wrapping" the specific Exception.

Public Method Summary

Throwable	getCause() Returns the cause of this exception (the exception thrown by the privileged computation that resulted in this PrivilegedActionException).
Exception	getException() Returns the exception thrown by the privileged computation that resulted in this PrivilegedActionException.
String	toString() Returns a short description of this throwable.

Inherited Method Summary

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public PrivilegedActionException (Exception exception)

Constructs a new PrivilegedActionException "wrapping" the specific Exception.

Parameters

exception	The exception thrown

Public Methods

public Throwable getCause ()

Returns the cause of this exception (the exception thrown by the privileged computation that resulted in this PrivilegedActionException).

Returns

• the cause of this exception.

public Exception getException ()

Returns the exception thrown by the privileged computation that resulted in this PrivilegedActionException.

This method predates the general-purpose exception chaining facility. The Throwable.getCause() method is now the preferred means of obtaining this information.

Returns

• the exception thrown by the privileged computation that resulted in this PrivilegedActionException.

See Also

• PrivilegedExceptionAction
• AccessController.doPrivileged(PrivilegedExceptionAction)
• AccessController.doPrivileged(PrivilegedExceptionAction, AccessControlContext)

public String toString ()

Returns a short description of this throwable. The result is the concatenation of:

• the {@linkplain Class#getName() name} of the class of this object
• ": " (a colon and a space)
• the result of invoking this object's getLocalizedMessage() method

If getLocalizedMessage returns null, then just the class name is returned.

Returns

• a string representation of this throwable.