EncryptingDataSource (aws-advanced-jdbc-wrapper 4.3.0 API)

java.lang.Object
- software.amazon.jdbc.plugin.encryption.wrapper.EncryptingDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
```
public class EncryptingDataSource
extends java.lang.Object
implements javax.sql.DataSource
```
A DataSource wrapper that integrates encryption capabilities with the AWS Advanced JDBC Wrapper. This DataSource wraps connections to provide transparent encryption/decryption functionality.

Constructor Summary

Constructors
Constructor and Description
`EncryptingDataSource(javax.sql.DataSource delegate, java.util.Properties encryptionProperties)` Creates an encrypting DataSource that wraps the provided DataSource.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the encryption plugin and releases resources.
`java.sql.Connection`	`getConnection()`
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`
`javax.sql.DataSource`	`getDelegate()` Gets the underlying DataSource.
`KmsEncryptionUtility`	`getEncryptionPlugin()` Gets the encryption plugin instance.
`int`	`getLoginTimeout()`
`java.io.PrintWriter`	`getLogWriter()`
`java.util.logging.Logger`	`getParentLogger()`
`boolean`	`isClosed()` Checks if this DataSource has been closed.
`boolean`	`isConnectionAvailable()` Tests if the DataSource can provide a valid connection.
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogWriter(java.io.PrintWriter out)`
`<T> T`	`unwrap(java.lang.Class<T> iface)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EncryptingDataSource
```
public EncryptingDataSource(javax.sql.DataSource delegate,
                            java.util.Properties encryptionProperties)
                     throws java.sql.SQLException
```
    Creates an encrypting DataSource that wraps the provided DataSource.
    
    Parameters:
    
    delegate - The underlying DataSource to wrap
    
    encryptionProperties - Properties for configuring encryption
    
    Throws:
    
    java.sql.SQLException - if encryption plugin initialization fails
- Method Detail
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
```
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLFeatureNotSupportedException
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - getDelegate
```
public javax.sql.DataSource getDelegate()
```
    Gets the underlying DataSource.
    
    Returns:
    
    The wrapped DataSource
  - getEncryptionPlugin
```
public KmsEncryptionUtility getEncryptionPlugin()
```
    Gets the encryption plugin instance.
    
    Returns:
    
    The KmsEncryptionPlugin instance
  - isConnectionAvailable
```
public boolean isConnectionAvailable()
```
    Tests if the DataSource can provide a valid connection. This method attempts to get a connection and immediately closes it.
    
    Returns:
    
    true if a valid connection can be obtained, false otherwise
  - close
```
public void close()
```
    Closes the encryption plugin and releases resources.
  - isClosed
```
public boolean isClosed()
```
    Checks if this DataSource has been closed.
    
    Returns:
    
    true if closed, false otherwise

Class EncryptingDataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncryptingDataSource

Method Detail

getConnection

getConnection

getLogWriter

setLogWriter

setLoginTimeout

getLoginTimeout

getParentLogger

unwrap

isWrapperFor

getDelegate

getEncryptionPlugin

isConnectionAvailable

close

isClosed