software.amazon.jdbc.plugin.encryption.metadata

Class MetadataManager

java.lang.Object

software.amazon.jdbc.plugin.encryption.metadata.MetadataManager

public class MetadataManager
extends java.lang.Object

Manages encryption metadata by loading configuration from database tables, providing caching mechanisms, and offering lookup methods for column encryption settings.

Constructor Summary

Constructors

Constructor and Description
MetadataManager(java.sql.Connection connection, EncryptionConfig config)
MetadataManager(javax.sql.DataSource dataSource, EncryptionConfig config)
MetadataManager(PluginService pluginService, EncryptionConfig config)

Method Summary

Modifier and Type	Method and Description
int	getCacheSize() Returns the current size of the metadata cache.
ColumnEncryptionConfig	getColumnConfig(java.lang.String tableName, java.lang.String columnName) Retrieves the encryption configuration for a specific column.
java.time.Instant	getLastRefreshTime() Returns the timestamp of the last cache refresh.
void	initialize() Initializes the metadata cache by loading all configurations from database.
boolean	isColumnEncrypted(java.lang.String tableName, java.lang.String columnName) Checks if a specific column is configured for encryption.
java.util.Map<java.lang.String,ColumnEncryptionConfig>	loadEncryptionMetadata() Loads encryption metadata from database tables and returns a map of column configurations.
void	refreshMetadata() Refreshes the metadata cache by reloading from the database.
void	shutdown() Shuts down the metadata manager and cleans up resources.
void	updateConfig(EncryptionConfig newConfig) Updates the configuration and adjusts refresh behavior accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataManager

public MetadataManager(PluginService pluginService,
                       EncryptionConfig config)

MetadataManager

public MetadataManager(javax.sql.DataSource dataSource,
                       EncryptionConfig config)

MetadataManager

public MetadataManager(java.sql.Connection connection,
                       EncryptionConfig config)

Method Detail

loadEncryptionMetadata

public java.util.Map<java.lang.String,ColumnEncryptionConfig> loadEncryptionMetadata()
                                                                              throws MetadataException

Loads encryption metadata from database tables and returns a map of column configurations.

Returns:

Map of column identifiers to ColumnEncryptionConfig objects

Throws:

MetadataException - if database operations fail

refreshMetadata

public void refreshMetadata()
                     throws MetadataException

Refreshes the metadata cache by reloading from the database. This method is thread-safe and can be called without application restart.

Throws:

MetadataException - if refresh operation fails

isColumnEncrypted

public boolean isColumnEncrypted(java.lang.String tableName,
                                 java.lang.String columnName)
                          throws MetadataException

Checks if a specific column is configured for encryption. Uses cache if available and valid, otherwise queries database directly.

Parameters:

tableName - the table name

columnName - the column name

Returns:

true if column is encrypted, false otherwise

Throws:

MetadataException - if database operations fail

getColumnConfig

public ColumnEncryptionConfig getColumnConfig(java.lang.String tableName,
                                              java.lang.String columnName)
                                       throws MetadataException

Retrieves the encryption configuration for a specific column. Uses cache if available and valid, otherwise queries database directly.

Parameters:

tableName - the table name

columnName - the column name

Returns:

ColumnEncryptionConfig if found, null otherwise

Throws:

MetadataException - if database operations fail

initialize

public void initialize()
                throws MetadataException

Initializes the metadata cache by loading all configurations from database. Should be called during plugin initialization.

Throws:

MetadataException - if initialization fails

updateConfig

public void updateConfig(EncryptionConfig newConfig)

Updates the configuration and adjusts refresh behavior accordingly.

Parameters:

newConfig - New encryption configuration

shutdown

public void shutdown()

Shuts down the metadata manager and cleans up resources.

getLastRefreshTime

public java.time.Instant getLastRefreshTime()

Returns the timestamp of the last cache refresh.

Returns:

Instant of last refresh, or Instant.EPOCH if never refreshed

getCacheSize

public int getCacheSize()

Returns the current size of the metadata cache.

Returns:

number of cached configurations