software.amazon.jdbc.plugin.encryption.service

Class EncryptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.sql.SQLException

software.amazon.jdbc.plugin.encryption.service.EncryptionException

All Implemented Interfaces:

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

public class EncryptionException
extends java.sql.SQLException

Exception thrown when encryption or decryption 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	DECRYPTION_FAILED_STATE
static java.lang.String	ENCRYPTION_FAILED_STATE
static java.lang.String	INVALID_ALGORITHM_STATE
static java.lang.String	INVALID_KEY_STATE
static java.lang.String	TYPE_CONVERSION_FAILED_STATE

Constructor Summary

Constructors

Constructor and Description
EncryptionException(java.lang.String message) Constructs an EncryptionException with the specified detail message.
EncryptionException(java.lang.String message, java.lang.String sqlState, java.lang.Throwable cause) Constructs an EncryptionException with the specified detail message, SQL state and cause.
EncryptionException(java.lang.String message, java.lang.Throwable cause) Constructs an EncryptionException with the specified detail message and cause.
EncryptionException(java.lang.Throwable cause) Constructs an EncryptionException with the specified cause.

Method Summary

Modifier and Type	Method and Description
static EncryptionException	decryptionFailed(java.lang.String message, java.lang.Throwable cause) Creates an EncryptionException for decryption failures.
static EncryptionException	encryptionFailed(java.lang.String message, java.lang.Throwable cause) Creates an EncryptionException for encryption failures.
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 EncryptionException	invalidAlgorithm(java.lang.String algorithm) Creates an EncryptionException for invalid algorithm errors.
static EncryptionException	invalidKey(java.lang.String message) Creates an EncryptionException for invalid key errors.
static EncryptionException	typeConversionFailed(java.lang.String fromType, java.lang.String toType, java.lang.Throwable cause) Creates an EncryptionException for type conversion errors.
EncryptionException	withAlgorithm(java.lang.String algorithm) Adds algorithm to the error context.
EncryptionException	withColumn(java.lang.String columnName) Adds column name to the error context.
EncryptionException	withContext(java.lang.String key, java.lang.Object value) Adds context information to the exception.
EncryptionException	withDataType(java.lang.String dataType) Adds data type to the error context.
EncryptionException	withOperation(java.lang.String operation) Adds operation type to the error context.
EncryptionException	withTable(java.lang.String tableName) Adds table name 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

ENCRYPTION_FAILED_STATE

public static final java.lang.String ENCRYPTION_FAILED_STATE

See Also:

Constant Field Values

DECRYPTION_FAILED_STATE

public static final java.lang.String DECRYPTION_FAILED_STATE

See Also:

Constant Field Values

INVALID_ALGORITHM_STATE

public static final java.lang.String INVALID_ALGORITHM_STATE

See Also:

Constant Field Values

INVALID_KEY_STATE

public static final java.lang.String INVALID_KEY_STATE

See Also:

Constant Field Values

TYPE_CONVERSION_FAILED_STATE

public static final java.lang.String TYPE_CONVERSION_FAILED_STATE

See Also:

Constant Field Values

Constructor Detail

EncryptionException

public EncryptionException(java.lang.String message)

Constructs an EncryptionException with the specified detail message.

Parameters:

message - the detail message

EncryptionException

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

Constructs an EncryptionException with the specified detail message and cause.

Parameters:

message - the detail message

cause - the cause of this exception

EncryptionException

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

Constructs an EncryptionException with the specified detail message, SQL state and cause.

Parameters:

message - the detail message

sqlState - the SQL state

cause - the cause of this exception

EncryptionException

public EncryptionException(java.lang.Throwable cause)

Constructs an EncryptionException with the specified cause.

Parameters:

cause - the cause of this exception

Method Detail

withContext

public EncryptionException 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

withTable

public EncryptionException withTable(java.lang.String tableName)

Adds table name to the error context.

Parameters:

tableName - the table name

Returns:

this exception for method chaining

withColumn

public EncryptionException withColumn(java.lang.String columnName)

Adds column name to the error context.

Parameters:

columnName - the column name

Returns:

this exception for method chaining

withAlgorithm

public EncryptionException withAlgorithm(java.lang.String algorithm)

Adds algorithm to the error context.

Parameters:

algorithm - the encryption algorithm

Returns:

this exception for method chaining

withDataType

public EncryptionException withDataType(java.lang.String dataType)

Adds data type to the error context.

Parameters:

dataType - the data type being processed

Returns:

this exception for method chaining

withOperation

public EncryptionException withOperation(java.lang.String operation)

Adds operation type to the error context.

Parameters:

operation - the operation being performed

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

encryptionFailed

public static EncryptionException encryptionFailed(java.lang.String message,
                                                   java.lang.Throwable cause)

Creates an EncryptionException for encryption failures.

Parameters:

message - Error message

cause - Root cause

Returns:

New EncryptionException instance

decryptionFailed

public static EncryptionException decryptionFailed(java.lang.String message,
                                                   java.lang.Throwable cause)

Creates an EncryptionException for decryption failures.

Parameters:

message - Error message

cause - Root cause

Returns:

New EncryptionException instance

invalidAlgorithm

public static EncryptionException invalidAlgorithm(java.lang.String algorithm)

Creates an EncryptionException for invalid algorithm errors.

Parameters:

algorithm - Invalid algorithm name

Returns:

New EncryptionException instance

invalidKey

public static EncryptionException invalidKey(java.lang.String message)

Creates an EncryptionException for invalid key errors.

Parameters:

message - Error message

Returns:

New EncryptionException instance

typeConversionFailed

public static EncryptionException typeConversionFailed(java.lang.String fromType,
                                                       java.lang.String toType,
                                                       java.lang.Throwable cause)

Creates an EncryptionException for type conversion errors.

Parameters:

fromType - Source type

toType - Target type

cause - Root cause

Returns:

New EncryptionException instance