io.magj.iamjdbcdriver

Class IamAuthJdbcDriverWrapper

java.lang.Object

io.magj.iamjdbcdriver.IamAuthJdbcDriverWrapper

All Implemented Interfaces:

java.sql.Driver

Direct Known Subclasses:

MySqlIamAuthJdbcDriverWrapper, PostgreSqlIamAuthJdbcDriverWrapper

public class IamAuthJdbcDriverWrapper
extends java.lang.Object
implements java.sql.Driver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AWS_ACCESS_KEY_ID_PROPERTY An optional AWS access key to use as credentials when requesting an RDS token.
static java.lang.String	AWS_PROFILE_PROPERTY The optional name of an AWS profile to source credentials/region configuration from.
static java.lang.String	AWS_REGION_PROPERTY The optional AWS region to use, if not specified, will use the DefaultAwsRegionProviderChain or a region from a configured profile
static java.lang.String	AWS_SECRET_ACCESS_KEY_PROPERTY An optional AWS secret key to use as credentials when requesting an RDS token.
static java.lang.String	AWS_STS_CREDENTIAL_EXTERNAL_ID_PROPERTY An optional external ID to pass in the assume role call.
static java.lang.String	AWS_STS_CREDENTIAL_ROLE_ARN_PROPERTY An optional role ARN to assume before requesting RDS iam credentials
static java.lang.String	AWS_STS_CREDENTIAL_SESSION_NAME_PROPERTY An optional session name to use if assuming a role.
static java.lang.String	DEFAULT_PASSWORD_PROPERTY
static java.lang.String	DEFAULT_USER_PROPERTY
static java.lang.String	DELEGATE_DRIVER_CLASS_PROPERTY The JDBC driver class to delegate calls to, if not already configured.
static java.lang.String	DELEGATE_DRIVER_SCHEME_NAME_PROPERTY The JDBC url scheme of the driver to delegate calls to.

Constructor Summary

Constructors

Constructor and Description
IamAuthJdbcDriverWrapper() Creates a delegateless IAM Auth JDBC wrapper.
IamAuthJdbcDriverWrapper(java.lang.String wrapperSchemeName, java.lang.String delegateSchemeName, java.lang.Integer defaultPort, java.lang.String driverClassName)
IamAuthJdbcDriverWrapper(java.lang.String wrapperSchemeName, java.lang.String delegateSchemeName, java.lang.String passwordProperty, java.lang.String userProperty, java.lang.Integer defaultPort, java.lang.String driverClassName)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(java.lang.String url)
java.sql.Connection	connect(java.lang.String url, java.util.Properties connectionProperties)
java.lang.String	generateRdsIamAuthToken(java.lang.String host, int port, java.util.Map<java.lang.String,java.lang.String> properties)
int	getMajorVersion()
int	getMinorVersion()
java.util.logging.Logger	getParentLogger()
java.sql.DriverPropertyInfo[]	getPropertyInfo(java.lang.String url, java.util.Properties properties)
protected static void	initialiseDriverRegistration(IamAuthJdbcDriverWrapper driver)
boolean	jdbcCompliant()
static java.util.Map<java.lang.String,java.lang.String>	parseQueryString(java.net.URI uri)

Methods inherited from class java.lang.Object

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

Field Detail

DELEGATE_DRIVER_CLASS_PROPERTY

public static final java.lang.String DELEGATE_DRIVER_CLASS_PROPERTY

The JDBC driver class to delegate calls to, if not already configured.

Only required if using a wrapper instance with no pre-configured driver class

See Also:

Constant Field Values

DELEGATE_DRIVER_SCHEME_NAME_PROPERTY

public static final java.lang.String DELEGATE_DRIVER_SCHEME_NAME_PROPERTY

The JDBC url scheme of the driver to delegate calls to. This is the portion of the URL after "jdbc:"

For example "mysql" or "postgresql"

Only required if using a wrapper instance with no pre-configured driver class

See Also:

Constant Field Values

AWS_REGION_PROPERTY

public static final java.lang.String AWS_REGION_PROPERTY

The optional AWS region to use, if not specified, will use the DefaultAwsRegionProviderChain or a region from a configured profile

See Also:

Constant Field Values

AWS_PROFILE_PROPERTY

public static final java.lang.String AWS_PROFILE_PROPERTY

The optional name of an AWS profile to source credentials/region configuration from.

See Also:

Constant Field Values

AWS_STS_CREDENTIAL_ROLE_ARN_PROPERTY

public static final java.lang.String AWS_STS_CREDENTIAL_ROLE_ARN_PROPERTY

An optional role ARN to assume before requesting RDS iam credentials

See Also:

Constant Field Values

AWS_STS_CREDENTIAL_SESSION_NAME_PROPERTY

public static final java.lang.String AWS_STS_CREDENTIAL_SESSION_NAME_PROPERTY

An optional session name to use if assuming a role. A random session name will be generated if not specified. This option has no effect if AWS_STS_CREDENTIAL_ROLE_ARN_PROPERTY is not configured

See Also:

Constant Field Values

AWS_STS_CREDENTIAL_EXTERNAL_ID_PROPERTY

public static final java.lang.String AWS_STS_CREDENTIAL_EXTERNAL_ID_PROPERTY

An optional external ID to pass in the assume role call. This option has no effect if AWS_STS_CREDENTIAL_ROLE_ARN_PROPERTY is not configured

See Also:

Constant Field Values

AWS_ACCESS_KEY_ID_PROPERTY

public static final java.lang.String AWS_ACCESS_KEY_ID_PROPERTY

An optional AWS access key to use as credentials when requesting an RDS token. This option must be configured in conjunction with AWS_SECRET_ACCESS_KEY_PROPERTY or will be ignored

See Also:

Constant Field Values

AWS_SECRET_ACCESS_KEY_PROPERTY

public static final java.lang.String AWS_SECRET_ACCESS_KEY_PROPERTY

An optional AWS secret key to use as credentials when requesting an RDS token. This option must be configured in conjunction with AWS_ACCESS_KEY_ID_PROPERTY or will be ignored

See Also:

Constant Field Values

DEFAULT_PASSWORD_PROPERTY

public static final java.lang.String DEFAULT_PASSWORD_PROPERTY

See Also:

Constant Field Values

DEFAULT_USER_PROPERTY

public static final java.lang.String DEFAULT_USER_PROPERTY

See Also:

Constant Field Values

Constructor Detail

IamAuthJdbcDriverWrapper

public IamAuthJdbcDriverWrapper()

Creates a delegateless IAM Auth JDBC wrapper.

Delegate driver class must later be configured with DELEGATE_DRIVER_CLASS_PROPERTY

IamAuthJdbcDriverWrapper

public IamAuthJdbcDriverWrapper(java.lang.String wrapperSchemeName,
                                java.lang.String delegateSchemeName,
                                java.lang.Integer defaultPort,
                                java.lang.String driverClassName)

IamAuthJdbcDriverWrapper

public IamAuthJdbcDriverWrapper(java.lang.String wrapperSchemeName,
                                java.lang.String delegateSchemeName,
                                java.lang.String passwordProperty,
                                java.lang.String userProperty,
                                java.lang.Integer defaultPort,
                                java.lang.String driverClassName)

Method Detail

initialiseDriverRegistration

protected static void initialiseDriverRegistration(IamAuthJdbcDriverWrapper driver)

parseQueryString

public static java.util.Map<java.lang.String,java.lang.String> parseQueryString(java.net.URI uri)

acceptsURL

public boolean acceptsURL(java.lang.String url)
                   throws java.sql.SQLException

Specified by:

acceptsURL in interface java.sql.Driver

Throws:

java.sql.SQLException

connect

public java.sql.Connection connect(java.lang.String url,
                                   java.util.Properties connectionProperties)
                            throws java.sql.SQLException

Specified by:

connect in interface java.sql.Driver

Throws:

java.sql.SQLException

generateRdsIamAuthToken

public java.lang.String generateRdsIamAuthToken(java.lang.String host,
                                                int port,
                                                java.util.Map<java.lang.String,java.lang.String> properties)

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface java.sql.Driver

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface java.sql.Driver

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface java.sql.Driver

Throws:

java.sql.SQLFeatureNotSupportedException

getPropertyInfo

public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url,
                                                     java.util.Properties properties)
                                              throws java.sql.SQLException

Specified by:

getPropertyInfo in interface java.sql.Driver

Throws:

java.sql.SQLException

jdbcCompliant

public boolean jdbcCompliant()

Specified by:

jdbcCompliant in interface java.sql.Driver