software.amazon.jdbc.plugin.encryption

Class KmsEncryptionUtility

java.lang.Object

software.amazon.jdbc.plugin.encryption.KmsEncryptionUtility

public class KmsEncryptionUtility
extends java.lang.Object

Main encryption plugin that integrates with the AWS Advanced JDBC Wrapper to provide transparent client-side encryption using AWS KMS.

This plugin intercepts JDBC operations to automatically encrypt data before storage and decrypt data upon retrieval based on metadata configuration.

Constructor Summary

Constructors

Constructor and Description
KmsEncryptionUtility() Default constructor for backward compatibility.
KmsEncryptionUtility(PluginService pluginService) Constructor that accepts PluginService for integration with AWS JDBC Wrapper.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleans up plugin resources.
void	ensureInitializedWithConnection(java.sql.Connection conn) Ensures the plugin is initialized with a database connection.
EncryptionConfig	getConfig() Returns the current configuration.
java.lang.String	getConnectionModeStatus() Creates a detailed status message about the current connection mode.
EncryptionService	getEncryptionService() Returns the encryption service.
IndependentDataSource	getIndependentDataSource() Returns the independent DataSource used by MetadataManager.
KeyManager	getKeyManager() Returns the key manager.
MetadataManager	getMetadataManager() Returns the metadata manager.
java.lang.String	getPluginName() Returns the plugin name for identification.
PluginService	getPluginService() Returns the plugin service.
void	initialize(java.util.Properties properties) Initializes the plugin with the provided configuration.
boolean	isClosed() Checks if the plugin is closed.
boolean	isInitialized() Checks if the plugin is initialized.
boolean	isUsingIndependentConnections() Checks if the plugin is using independent connections.
void	logCurrentStatus() Logs the current connection status and performance metrics.
void	onConnectionClosed(java.sql.Connection conn) Removes the type registration entry for a connection.
void	setPluginService(PluginService pluginService) Sets the PluginService instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

KmsEncryptionUtility

public KmsEncryptionUtility(PluginService pluginService)

Constructor that accepts PluginService for integration with AWS JDBC Wrapper.

Parameters:

pluginService - The PluginService instance from AWS JDBC Wrapper

KmsEncryptionUtility

public KmsEncryptionUtility()

Default constructor for backward compatibility.

Method Detail

setPluginService

public void setPluginService(PluginService pluginService)

Sets the PluginService instance. This method can be called to provide the PluginService after construction if it wasn't available during construction.

Parameters:

pluginService - The PluginService instance from AWS JDBC Wrapper

initialize

public void initialize(java.util.Properties properties)
                throws java.sql.SQLException

Initializes the plugin with the provided configuration. This method is called by the AWS JDBC Wrapper during plugin loading.

Parameters:

properties - Configuration properties for the plugin

Throws:

java.sql.SQLException - if initialization fails

onConnectionClosed

public void onConnectionClosed(java.sql.Connection conn)

Removes the type registration entry for a connection. Called on connection close so types are re-registered on the next connection.

Parameters:

conn - the connection being closed

ensureInitializedWithConnection

public void ensureInitializedWithConnection(java.sql.Connection conn)
                                     throws java.sql.SQLException

Ensures the plugin is initialized with a database connection. Called lazily when the first PreparedStatement is created.

Parameters:

conn - the database connection to initialize with

Throws:

java.sql.SQLException - if the plugin is not initialized or type registration fails

getPluginName

public java.lang.String getPluginName()

Returns the plugin name for identification.

Returns:

Plugin name

cleanup

public void cleanup()

Cleans up plugin resources. This method is called when the plugin is being unloaded.

getConfig

public EncryptionConfig getConfig()

Returns the current configuration.

Returns:

EncryptionConfig instance

getMetadataManager

public MetadataManager getMetadataManager()

Returns the metadata manager.

Returns:

MetadataManager instance

getKeyManager

public KeyManager getKeyManager()

Returns the key manager.

Returns:

KeyManager instance

getEncryptionService

public EncryptionService getEncryptionService()

Returns the encryption service.

Returns:

EncryptionService instance

isInitialized

public boolean isInitialized()

Checks if the plugin is initialized.

Returns:

true if initialized, false otherwise

isClosed

public boolean isClosed()

Checks if the plugin is closed.

Returns:

true if closed, false otherwise

getPluginService

public PluginService getPluginService()

Returns the plugin service.

Returns:

PluginService instance

getIndependentDataSource

public IndependentDataSource getIndependentDataSource()

Returns the independent DataSource used by MetadataManager.

Returns:

IndependentDataSource instance, or null if not initialized

isUsingIndependentConnections

public boolean isUsingIndependentConnections()

Checks if the plugin is using independent connections.

Returns:

true if using independent connections, false otherwise

getConnectionModeStatus

public java.lang.String getConnectionModeStatus()

Creates a detailed status message about the current connection mode.

Returns:

a comprehensive status message

logCurrentStatus

public void logCurrentStatus()

Logs the current connection status and performance metrics. This method can be called for troubleshooting purposes.