Class XMLSignatureException

javax.xml.crypto.dsig.XMLSignatureException

All Implemented Interfaces:: Serializable

public class XMLSignatureException extends Exception

Indicates an exceptional condition that occurred during the XML signature generation or validation process.

An XMLSignatureException can contain a cause: another throwable that caused this XMLSignatureException to get thrown.

Since:

1.6

See Also:

Constructor Summary

Constructor	Description
`XMLSignatureException()`	Constructs a new `XMLSignatureException` with `null` as its detail message.
`XMLSignatureException(String message)`	Constructs a new `XMLSignatureException` with the specified detail message.
`XMLSignatureException(String message, Throwable cause)`	Constructs a new `XMLSignatureException` with the specified detail message and cause.
`XMLSignatureException(Throwable cause)`	Constructs a new `XMLSignatureException` with the specified cause and a detail message of `(cause==null ? null : cause.toString())` (which typically contains the class and detail message of `cause`).

Method Summary

Modifier and Type	Method	Description
`Throwable`	`getCause()`	Returns the cause of this `XMLSignatureException` or `null` if the cause is nonexistent or unknown.
`void`	`printStackTrace()`	Prints this `XMLSignatureException`, its backtrace and the cause's backtrace to the standard error stream.
`void`	`printStackTrace(PrintStream s)`	Prints this `XMLSignatureException`, its backtrace and the cause's backtrace to the specified print stream.
`void`	`printStackTrace(PrintWriter s)`	Prints this `XMLSignatureException`, its backtrace and the cause's backtrace to the specified print writer.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Modifier and Type	Method	Description
`final void`	`addSuppressed(Throwable exception)`	Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()`	Fills in the execution stack trace.
`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 `Throwable.printStackTrace()`.
`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.
`Throwable`	`initCause(Throwable cause)`	Initializes the cause of this throwable to the specified value.
`void`	`setStackTrace(StackTraceElement[] stackTrace)`	Sets the stack trace elements that will be returned by `Throwable.getStackTrace()` and printed by `Throwable.printStackTrace()` and related methods.
`String`	`toString()`	Returns a short description of this throwable.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

XMLSignatureException

public XMLSignatureException()

Constructs a new XMLSignatureException with null as its detail message.

XMLSignatureException

public XMLSignatureException(String message)

Constructs a new XMLSignatureException with the specified detail message.

Parameters:: message - the detail message

XMLSignatureException

public XMLSignatureException(String message, Throwable cause)

Constructs a new XMLSignatureException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:: message - the detail message; cause - the cause (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

XMLSignatureException

public XMLSignatureException(Throwable cause)

Constructs a new XMLSignatureException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Parameters:: cause - the cause (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Method Details

getCause

public Throwable getCause()

Returns the cause of this XMLSignatureException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this XMLSignatureException to get thrown.)

Overrides:: getCause in class Throwable
Returns:: the cause of this XMLSignatureException or null if the cause is nonexistent or unknown.

printStackTrace

public void printStackTrace()

Prints this XMLSignatureException, its backtrace and the cause's backtrace to the standard error stream.

Overrides:: printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)

Prints this XMLSignatureException, its backtrace and the cause's backtrace to the specified print stream.

Overrides:: printStackTrace in class Throwable
Parameters:: s - PrintStream to use for output

printStackTrace

public void printStackTrace(PrintWriter s)

Prints this XMLSignatureException, its backtrace and the cause's backtrace to the specified print writer.

Overrides:: printStackTrace in class Throwable
Parameters:: s - PrintWriter to use for output

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.