software.amazon.jdbc.plugin.encryption.key

Class KeyManagementException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.sql.SQLException

software.amazon.jdbc.plugin.encryption.key.KeyManagementException

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.lang.Throwable>

public class KeyManagementException
extends java.sql.SQLException

Exception thrown when key management operations fail. Extends SQLException to integrate with JDBC error handling. Provides enhanced error context information for better troubleshooting.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INVALID_KEY_METADATA_STATE
static java.lang.String	KEY_CREATION_FAILED_STATE
static java.lang.String	KEY_DECRYPTION_FAILED_STATE
static java.lang.String	KEY_RETRIEVAL_FAILED_STATE
static java.lang.String	KEY_STORAGE_FAILED_STATE
static java.lang.String	KMS_CONNECTION_FAILED_STATE

Constructor Summary

Constructors

Constructor and Description
KeyManagementException(java.lang.String message) Constructs a KeyManagementException with the specified detail message.
KeyManagementException(java.lang.String message, java.lang.String sqlState, int vendorCode) Constructs a KeyManagementException with the specified detail message, SQL state, and vendor code.
KeyManagementException(java.lang.String message, java.lang.String sqlState, int vendorCode, java.lang.Throwable cause) Constructs a KeyManagementException with the specified detail message, SQL state, vendor code, and cause.
KeyManagementException(java.lang.String message, java.lang.String sqlState, java.lang.Throwable cause) Constructs a KeyManagementException with the specified detail message, SQL state and cause.
KeyManagementException(java.lang.String message, java.lang.Throwable cause) Constructs a KeyManagementException with the specified detail message and cause.
KeyManagementException(java.lang.Throwable cause) Constructs a KeyManagementException with the specified cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetailedMessage() Gets a formatted error message including context information.
java.util.Map<java.lang.String,java.lang.Object>	getErrorContext() Gets the error context map.
static KeyManagementException	invalidKeyMetadata(java.lang.String message) Creates a KeyManagementException for invalid key metadata.
static KeyManagementException	keyCreationFailed(java.lang.String message, java.lang.Throwable cause) Creates a KeyManagementException for key creation failures.
static KeyManagementException	keyDecryptionFailed(java.lang.String keyId, java.lang.String masterKeyArn, java.lang.Throwable cause) Creates a KeyManagementException for key decryption failures.
static KeyManagementException	keyStorageFailed(java.lang.String message, java.lang.Throwable cause) Creates a KeyManagementException for key storage failures.
static KeyManagementException	kmsConnectionFailed(java.lang.String message, java.lang.Throwable cause) Creates a KeyManagementException for KMS connection failures.
KeyManagementException	withContext(java.lang.String key, java.lang.Object value) Adds context information to the exception.
KeyManagementException	withKeyId(java.lang.String keyId) Adds key ID to the error context (sanitized).
KeyManagementException	withMasterKeyArn(java.lang.String masterKeyArn) Adds master key ARN to the error context (sanitized).
KeyManagementException	withOperation(java.lang.String operation) Adds operation type to the error context.
KeyManagementException	withRetryInfo(int attempt, int maxAttempts) Adds retry attempt information to the error context.

Methods inherited from class java.sql.SQLException

getErrorCode, getNextException, getSQLState, iterator, setNextException

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

KEY_CREATION_FAILED_STATE

public static final java.lang.String KEY_CREATION_FAILED_STATE

See Also:

Constant Field Values

KEY_RETRIEVAL_FAILED_STATE

public static final java.lang.String KEY_RETRIEVAL_FAILED_STATE

See Also:

Constant Field Values

KEY_DECRYPTION_FAILED_STATE

public static final java.lang.String KEY_DECRYPTION_FAILED_STATE

See Also:

Constant Field Values

KEY_STORAGE_FAILED_STATE

public static final java.lang.String KEY_STORAGE_FAILED_STATE

See Also:

Constant Field Values

KMS_CONNECTION_FAILED_STATE

public static final java.lang.String KMS_CONNECTION_FAILED_STATE

See Also:

Constant Field Values

INVALID_KEY_METADATA_STATE

public static final java.lang.String INVALID_KEY_METADATA_STATE

See Also:

Constant Field Values

Constructor Detail

KeyManagementException

public KeyManagementException(java.lang.String message)

Constructs a KeyManagementException with the specified detail message.

Parameters:

message - the detail message

KeyManagementException

public KeyManagementException(java.lang.String message,
                              java.lang.Throwable cause)

Constructs a KeyManagementException with the specified detail message and cause.

Parameters:

message - the detail message

cause - the cause of this exception

KeyManagementException

public KeyManagementException(java.lang.Throwable cause)

Constructs a KeyManagementException with the specified cause.

Parameters:

cause - the cause of this exception

KeyManagementException

public KeyManagementException(java.lang.String message,
                              java.lang.String sqlState,
                              int vendorCode)

Constructs a KeyManagementException with the specified detail message, SQL state, and vendor code.

Parameters:

message - the detail message

sqlState - the SQL state

vendorCode - the vendor-specific error code

KeyManagementException

public KeyManagementException(java.lang.String message,
                              java.lang.String sqlState,
                              int vendorCode,
                              java.lang.Throwable cause)

Constructs a KeyManagementException with the specified detail message, SQL state, vendor code, and cause.

Parameters:

message - the detail message

sqlState - the SQL state

vendorCode - the vendor-specific error code

cause - the cause of this exception

KeyManagementException

public KeyManagementException(java.lang.String message,
                              java.lang.String sqlState,
                              java.lang.Throwable cause)

Constructs a KeyManagementException with the specified detail message, SQL state and cause.

Parameters:

message - the detail message

sqlState - the SQL state

cause - the cause of this exception

Method Detail

withContext

public KeyManagementException withContext(java.lang.String key,
                                          java.lang.Object value)

Adds context information to the exception.

Parameters:

key - the context key

value - the context value

Returns:

this exception for method chaining

withKeyId

public KeyManagementException withKeyId(java.lang.String keyId)

Adds key ID to the error context (sanitized).

Parameters:

keyId - the key ID

Returns:

this exception for method chaining

withMasterKeyArn

public KeyManagementException withMasterKeyArn(java.lang.String masterKeyArn)

Adds master key ARN to the error context (sanitized).

Parameters:

masterKeyArn - the master key ARN

Returns:

this exception for method chaining

withOperation

public KeyManagementException withOperation(java.lang.String operation)

Adds operation type to the error context.

Parameters:

operation - the operation being performed

Returns:

this exception for method chaining

withRetryInfo

public KeyManagementException withRetryInfo(int attempt,
                                            int maxAttempts)

Adds retry attempt information to the error context.

Parameters:

attempt - the current attempt number

maxAttempts - the maximum number of attempts

Returns:

this exception for method chaining

getErrorContext

public java.util.Map<java.lang.String,java.lang.Object> getErrorContext()

Gets the error context map.

Returns:

a copy of the error context

getDetailedMessage

public java.lang.String getDetailedMessage()

Gets a formatted error message including context information.

Returns:

formatted error message with context

keyCreationFailed

public static KeyManagementException keyCreationFailed(java.lang.String message,
                                                       java.lang.Throwable cause)

Creates a KeyManagementException for key creation failures.

Parameters:

message - Error message

cause - Root cause

Returns:

KeyManagementException instance

keyDecryptionFailed

public static KeyManagementException keyDecryptionFailed(java.lang.String keyId,
                                                         java.lang.String masterKeyArn,
                                                         java.lang.Throwable cause)

Creates a KeyManagementException for key decryption failures.

Parameters:

keyId - Key ID

masterKeyArn - Master key ARN

cause - Root cause

Returns:

KeyManagementException instance

keyStorageFailed

public static KeyManagementException keyStorageFailed(java.lang.String message,
                                                      java.lang.Throwable cause)

Creates a KeyManagementException for key storage failures.

Parameters:

message - Error message

cause - Root cause

Returns:

KeyManagementException instance

kmsConnectionFailed

public static KeyManagementException kmsConnectionFailed(java.lang.String message,
                                                         java.lang.Throwable cause)

Creates a KeyManagementException for KMS connection failures.

Parameters:

message - Error message

cause - Root cause

Returns:

KeyManagementException instance

invalidKeyMetadata

public static KeyManagementException invalidKeyMetadata(java.lang.String message)

Creates a KeyManagementException for invalid key metadata.

Parameters:

message - Error message

Returns:

New KeyManagementException instance