software.amazon.jdbc.plugin.encryption.metadata

Class MetadataException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.sql.SQLException

software.amazon.jdbc.plugin.encryption.metadata.MetadataException

All Implemented Interfaces:

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

public class MetadataException
extends java.sql.SQLException

Exception thrown when metadata operations fail, such as loading encryption configuration from database or cache operations. 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	METADATA_CACHE_FAILED_STATE
static java.lang.String	METADATA_LOAD_FAILED_STATE
static java.lang.String	METADATA_LOOKUP_FAILED_STATE
static java.lang.String	METADATA_REFRESH_FAILED_STATE
static java.lang.String	METADATA_VALIDATION_FAILED_STATE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static MetadataException	cacheFailed(java.lang.String message, java.lang.Throwable cause) Creates a MetadataException for cache operation 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 MetadataException	loadFailed(java.lang.String message, java.lang.Throwable cause) Creates a MetadataException for metadata loading failures.
static MetadataException	lookupFailed(java.lang.String tableName, java.lang.String columnName, java.lang.Throwable cause) Creates a MetadataException for metadata lookup failures.
static MetadataException	refreshFailed(java.lang.String message, java.lang.Throwable cause) Creates a MetadataException for metadata refresh failures.
static MetadataException	validationFailed(java.lang.String message) Creates a MetadataException for metadata validation failures.
MetadataException	withCacheInfo(int cacheSize, boolean cacheHit) Adds cache information to the error context.
MetadataException	withColumn(java.lang.String columnName) Adds column name to the error context.
MetadataException	withContext(java.lang.String key, java.lang.Object value) Adds context information to the exception.
MetadataException	withOperation(java.lang.String operation) Adds operation type to the error context.
MetadataException	withSql(java.lang.String sql) Adds SQL query information to the error context (sanitized).
MetadataException	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

METADATA_LOAD_FAILED_STATE

public static final java.lang.String METADATA_LOAD_FAILED_STATE

See Also:

Constant Field Values

METADATA_CACHE_FAILED_STATE

public static final java.lang.String METADATA_CACHE_FAILED_STATE

See Also:

Constant Field Values

METADATA_REFRESH_FAILED_STATE

public static final java.lang.String METADATA_REFRESH_FAILED_STATE

See Also:

Constant Field Values

METADATA_LOOKUP_FAILED_STATE

public static final java.lang.String METADATA_LOOKUP_FAILED_STATE

See Also:

Constant Field Values

METADATA_VALIDATION_FAILED_STATE

public static final java.lang.String METADATA_VALIDATION_FAILED_STATE

See Also:

Constant Field Values

Constructor Detail

MetadataException

public MetadataException(java.lang.String message)

Constructs a MetadataException with the specified detail message.

Parameters:

message - the detail message

MetadataException

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

Constructs a MetadataException with the specified detail message and cause.

Parameters:

message - the detail message

cause - the cause of this exception

MetadataException

public MetadataException(java.lang.Throwable cause)

Constructs a MetadataException with the specified cause.

Parameters:

cause - the cause of this exception

MetadataException

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

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

Parameters:

message - the detail message

sqlState - the SQL state

vendorCode - the vendor-specific error code

cause - the cause of this exception

MetadataException

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

Constructs a MetadataException 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 MetadataException 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 MetadataException 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 MetadataException withColumn(java.lang.String columnName)

Adds column name to the error context.

Parameters:

columnName - the column name

Returns:

this exception for method chaining

withOperation

public MetadataException withOperation(java.lang.String operation)

Adds operation type to the error context.

Parameters:

operation - the operation being performed

Returns:

this exception for method chaining

withCacheInfo

public MetadataException withCacheInfo(int cacheSize,
                                       boolean cacheHit)

Adds cache information to the error context.

Parameters:

cacheSize - the current cache size

cacheHit - whether this was a cache hit or miss

Returns:

this exception for method chaining

withSql

public MetadataException withSql(java.lang.String sql)

Adds SQL query information to the error context (sanitized).

Parameters:

sql - the SQL query

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

loadFailed

public static MetadataException loadFailed(java.lang.String message,
                                           java.lang.Throwable cause)

Creates a MetadataException for metadata loading failures.

Parameters:

message - Error message

cause - Root cause

Returns:

New MetadataException instance

cacheFailed

public static MetadataException cacheFailed(java.lang.String message,
                                            java.lang.Throwable cause)

Creates a MetadataException for cache operation failures.

Parameters:

message - Error message

cause - Root cause

Returns:

New MetadataException instance

refreshFailed

public static MetadataException refreshFailed(java.lang.String message,
                                              java.lang.Throwable cause)

Creates a MetadataException for metadata refresh failures.

Parameters:

message - Error message

cause - Root cause

Returns:

New MetadataException instance

lookupFailed

public static MetadataException lookupFailed(java.lang.String tableName,
                                             java.lang.String columnName,
                                             java.lang.Throwable cause)

Creates a MetadataException for metadata lookup failures.

Parameters:

tableName - Table name

columnName - Column name

cause - Root cause

Returns:

New MetadataException instance

validationFailed

public static MetadataException validationFailed(java.lang.String message)

Creates a MetadataException for metadata validation failures.

Parameters:

message - Error message

Returns:

New MetadataException instance