com.amazonaws.secretsmanager.sql

Class AWSSecretsManagerMSSQLServerDriver

java.lang.Object

com.amazonaws.secretsmanager.sql.AWSSecretsManagerDriver

com.amazonaws.secretsmanager.sql.AWSSecretsManagerMSSQLServerDriver

All Implemented Interfaces:

Driver

public final class AWSSecretsManagerMSSQLServerDriver
extends AWSSecretsManagerDriver

Provides support for accessing MSSQLServer databases using credentials stored within AWS Secrets Manager.

Configuration properties are specified using the "sqlserver" subprefix (e.g drivers.sqlserver.realDriverClass).

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOGIN_FAILED The MSSQLServer error code for when a user logs in using an invalid password.
static String	SUBPREFIX Set to sqlserver.

Fields inherited from class com.amazonaws.secretsmanager.sql.AWSSecretsManagerDriver

INVALID_SECRET_STRING_JSON, MAX_RETRY, PROPERTY_PREFIX, SCHEME

Constructor Summary

Constructors

Constructor and Description
AWSSecretsManagerMSSQLServerDriver() Constructs the driver setting the properties from the properties file using system properties as defaults.
AWSSecretsManagerMSSQLServerDriver(com.amazonaws.services.secretsmanager.AWSSecretsManager client) Constructs the driver setting the properties from the properties file using system properties as defaults.
AWSSecretsManagerMSSQLServerDriver(com.amazonaws.services.secretsmanager.AWSSecretsManagerClientBuilder builder) Constructs the driver setting the properties from the properties file using system properties as defaults.
AWSSecretsManagerMSSQLServerDriver(com.amazonaws.secretsmanager.caching.SecretCache cache) Constructs the driver setting the properties from the properties file using system properties as defaults.
AWSSecretsManagerMSSQLServerDriver(com.amazonaws.secretsmanager.caching.SecretCacheConfiguration cacheConfig) Constructs the driver setting the properties from the properties file using system properties as defaults.

Method Summary

Modifier and Type	Method and Description
String	constructUrlFromEndpointPortDatabase(String endpoint, String port, String dbname) Construct a database URL from the endpoint, port and database name.
String	getDefaultDriverClass() Get the default real driver class name for this driver.
String	getPropertySubprefix() Gets the "subprefix" used for configuration properties for this driver.
boolean	isExceptionDueToAuthenticationError(Exception e) Determines whether or not an Exception is due to an authentication failure with the remote database.

Methods inherited from class com.amazonaws.secretsmanager.sql.AWSSecretsManagerDriver

acceptsURL, connect, getMajorVersion, getMinorVersion, getParentLogger, getPropertyInfo, getWrappedDriver, jdbcCompliant, register

Methods inherited from class java.lang.Object

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

Field Detail

LOGIN_FAILED

public static final int LOGIN_FAILED

The MSSQLServer error code for when a user logs in using an invalid password. See MSSQL Server error codes.

See Also:

Constant Field Values

SUBPREFIX

public static final String SUBPREFIX

Set to sqlserver.

See Also:

Constant Field Values

Constructor Detail

AWSSecretsManagerMSSQLServerDriver

public AWSSecretsManagerMSSQLServerDriver()

Constructs the driver setting the properties from the properties file using system properties as defaults. Instantiates the secret cache with default options.

AWSSecretsManagerMSSQLServerDriver

public AWSSecretsManagerMSSQLServerDriver(com.amazonaws.secretsmanager.caching.SecretCache cache)

Constructs the driver setting the properties from the properties file using system properties as defaults. Uses the passed in SecretCache.

Parameters:

cache - Secret cache to use to retrieve secrets

AWSSecretsManagerMSSQLServerDriver

public AWSSecretsManagerMSSQLServerDriver(com.amazonaws.services.secretsmanager.AWSSecretsManagerClientBuilder builder)

Constructs the driver setting the properties from the properties file using system properties as defaults. Instantiates the secret cache with the passed in client builder.

Parameters:

builder - Builder used to instantiate cache

AWSSecretsManagerMSSQLServerDriver

public AWSSecretsManagerMSSQLServerDriver(com.amazonaws.services.secretsmanager.AWSSecretsManager client)

Constructs the driver setting the properties from the properties file using system properties as defaults. Instantiates the secret cache with the provided AWS Secrets Manager client.

Parameters:

client - AWS Secrets Manager client to instantiate cache

AWSSecretsManagerMSSQLServerDriver

public AWSSecretsManagerMSSQLServerDriver(com.amazonaws.secretsmanager.caching.SecretCacheConfiguration cacheConfig)

Constructs the driver setting the properties from the properties file using system properties as defaults. Instantiates the secret cache with the provided cache configuration.

Parameters:

cacheConfig - Cache configuration to instantiate cache

Method Detail

getPropertySubprefix

public String getPropertySubprefix()

Description copied from class: AWSSecretsManagerDriver

Gets the "subprefix" used for configuration properties for this driver. For example, if this method returns the String, "mysql", then the real driver that this will forward requests to would be set to drivers.mysql.realDriverClass in the properties file or in the system properties.

Specified by:

getPropertySubprefix in class AWSSecretsManagerDriver

Returns:

String The subprefix to use for configuration properties.

isExceptionDueToAuthenticationError

public boolean isExceptionDueToAuthenticationError(Exception e)

Description copied from class: AWSSecretsManagerDriver

Determines whether or not an Exception is due to an authentication failure with the remote database. This method is called during connect to decide if authentication needs to be attempted again with refreshed credentials. A good way to implement this is to look up the error codes that java.sqlSQLExceptions will have when an authentication failure occurs. These are database specific.

Specified by:

isExceptionDueToAuthenticationError in class AWSSecretsManagerDriver

Parameters:

e - The Exception to test.

Returns:

boolean Whether or not the Exception indicates that the credentials used for authentication are stale.

constructUrlFromEndpointPortDatabase

public String constructUrlFromEndpointPortDatabase(String endpoint,
                                                   String port,
                                                   String dbname)

Description copied from class: AWSSecretsManagerDriver

Construct a database URL from the endpoint, port and database name. This method is called when the connect method is called with a secret ID instead of a URL.

Specified by:

constructUrlFromEndpointPortDatabase in class AWSSecretsManagerDriver

Parameters:

endpoint - The endpoint retrieved from the secret cache

port - The port retrieved from the secret cache

dbname - The database name retrieved from the secret cache

Returns:

String The constructed URL based on the endpoint and port

getDefaultDriverClass

public String getDefaultDriverClass()

Description copied from class: AWSSecretsManagerDriver

Get the default real driver class name for this driver.

Specified by:

getDefaultDriverClass in class AWSSecretsManagerDriver

Returns:

String The default real driver class name