KeyException

AI-generated Key Takeaways

• KeyException is a fundamental exception in Java security indicating a problem with a cryptographic key.

• It's a subclass of GeneralSecurityException and serves as the base class for more specific key-related exceptions like InvalidKeyException and KeyManagementException.

• InvalidKeyException signals issues with the key itself, such as incorrect encoding, length, or initialization.

• KeyManagementException covers broader problems encountered during key management operations.

• KeyException provides constructors to create instances with custom messages or underlying causes, offering flexibility in error handling.

public class KeyException extends GeneralSecurityException

Known Direct Subclasses InvalidKeyException, KeyManagementException InvalidKeyException This is the exception for invalid Keys (invalid encoding, wrong length, uninitialized, etc).  KeyManagementException This is the general key management exception for all operations dealing with key management.

This is the basic key exception.

See Also

• Key
• InvalidKeyException
• KeyManagementException

Public Constructor Summary

	KeyException() Constructs a KeyException with no detail message.
	KeyException(String msg) Constructs a KeyException with the specified detail message.
	KeyException(String message, Throwable cause) Creates a KeyException with the specified detail message and cause.
	KeyException(Throwable cause) Creates a KeyException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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 KeyException ()

Constructs a KeyException with no detail message. A detail message is a String that describes this particular exception.

public KeyException (String msg)

Constructs a KeyException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters

msg	the detail message.

public KeyException (String message, Throwable cause)

Creates a KeyException with the specified detail message and cause.

Parameters

message	the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
cause	the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

public KeyException (Throwable cause)

Creates a KeyException 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 (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)