Class XMLSignatureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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:

• Serialized Form

Constructor Summary

Constructors

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)	The specified exception is going to be suppressed in order to give priority to this exception (primary exception) and to be appended to the list of suppressed exceptions.
Throwable	fillInStackTrace()	Record in the receiver a walkback from the point where this message was sent.
String	getLocalizedMessage()	Answers the extra information message which was provided when the throwable was created.
String	getMessage()	Answers the extra information message which was provided when the throwable was created.
StackTraceElement[]	getStackTrace()	Answers an array of StackTraceElement.
final Throwable[]	getSuppressed()	Returns an array of exceptions suppressed, typically by the automatically generated code from the try-with-resources statement, in order to give priority to this exception (primary exception).
Throwable	initCause(Throwable throwable)	Initialize the cause of the receiver.
void	setStackTrace(StackTraceElement[] trace)	Sets the array of StackTraceElements.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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