Package oracle.jdbc.pool

Class OracleConnectionBuilderImpl

java.lang.Object

oracle.jdbc.pool.OracleConnectionBuilderImpl

All Implemented Interfaces:

ConnectionBuilder, OracleConnectionBuilder

public abstract class OracleConnectionBuilderImpl
extends Object
implements OracleConnectionBuilder

Oracle Implementation class for Connection Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected GSSCredential	gssCredential
protected String	instanceName
protected String	password
protected String	serviceName
protected OracleShardingKey	shardingKey
protected SSLContext	sslContext
protected OracleShardingKey	superShardingKey
protected java.util.function.Supplier<? extends AccessToken>	tokenSupplier	Supplier of access tokens that this builder is configured to use for authenticating a connection.
protected String	user

Constructor Summary

Constructors

Constructor	Description
OracleConnectionBuilderImpl()

Method Summary

Modifier and Type	Method	Description
OracleConnectionBuilderImpl	accessToken(AccessToken accessToken)	Sets the accessToken(oracle.jdbc.AccessToken) field of this builder.
abstract OracleConnection	build()	Builds the connection of type OracleConnection.
GSSCredential	getGSSCredential()
String	getInstanceName()
String	getPassword()
String	getServiceName()
OracleShardingKeyImpl	getShardingKey()
SSLContext	getSSLContext()
OracleShardingKeyImpl	getSuperShardingKey()
java.util.function.Supplier<? extends AccessToken>	getTokenSupplier()	Returns a supplier of AccessTokens if one has been specified by user code calling accessToken(AccessToken), or by internal code calling setTokenSupplier(Supplier).
String	getUser()
OracleConnectionBuilderImpl	gssCredential(GSSCredential credential)	Provide the GSSCredential used to authenticate the connection.
OracleConnectionBuilderImpl	instanceName(String instanceName)
OracleConnectionBuilderImpl	password(String password)
OracleConnectionBuilderImpl	serviceName(String serviceName)
void	setTokenSupplier(java.util.function.Supplier<? extends AccessToken> tokenSupplier)	Internal API to configure this builder with a Supplier of AccessTokens.
OracleConnectionBuilderImpl	shardingKey(ShardingKey shardingKey)
OracleConnectionBuilderImpl	shardingKey(OracleShardingKey shardingKey)
OracleConnectionBuilderImpl	sslContext(SSLContext sslContext)	Set the SSLContext on this builder.
OracleConnectionBuilderImpl	superShardingKey(ShardingKey superShardingKey)
OracleConnectionBuilderImpl	superShardingKey(OracleShardingKey superShardingKey)
OracleConnectionBuilderImpl	user(String user)
void	verifyBuildConfiguration()	Verifies if this builder has been configured such that a call to build() will produce a valid connection.

Methods inherited from class java.lang.Object

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

Field Detail

user

protected String user

password

protected String password

serviceName

protected String serviceName

instanceName

protected String instanceName

shardingKey

protected OracleShardingKey shardingKey

superShardingKey

protected OracleShardingKey superShardingKey

sslContext

protected SSLContext sslContext

tokenSupplier

protected java.util.function.Supplier<? extends AccessToken> tokenSupplier

Supplier of access tokens that this builder is configured to use for authenticating a connection. The value of this field may either be specified by user code calling accessToken(AccessToken), or internal code calling setTokenSupplier(Supplier). In the case of user code calling the external API, this supplier returns a fixed value tht was passed into accessToken(AccessToken) This field stores security sensitive valus. It should not be included in log messages. It should be annotated with @Blind by getter and setter methods.

gssCredential

protected GSSCredential gssCredential

Constructor Detail

OracleConnectionBuilderImpl

public OracleConnectionBuilderImpl()

Method Detail

build

public abstract OracleConnection build()
                                throws SQLException

Builds the connection of type OracleConnection. The build() method can be called only once on a builder object.

Specified by:

build in interface ConnectionBuilder

Specified by:

build in interface OracleConnectionBuilder

Returns:

the new object that is built.

Throws:

SQLException

See Also:

OracleConnectionBuilder.build()

password

public OracleConnectionBuilderImpl password(String password)

Specified by:

password in interface ConnectionBuilder

Specified by:

password in interface OracleConnectionBuilder

Parameters:

password - Password to be a part of the connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.password(java.lang.String)

user

public OracleConnectionBuilderImpl user(String user)

Specified by:

user in interface ConnectionBuilder

Specified by:

user in interface OracleConnectionBuilder

Parameters:

user - User Name to be a part of the connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.user(java.lang.String)

serviceName

public OracleConnectionBuilderImpl serviceName(String serviceName)

Parameters:

serviceName - Service name to be part of the connection request

Returns:

This instance of the connection builder.

instanceName

public OracleConnectionBuilderImpl instanceName(String instanceName)

Parameters:

instanceName - Instance name to be part of the connection request

Returns:

This instance of the connection builder.

shardingKey

public OracleConnectionBuilderImpl shardingKey(OracleShardingKey shardingKey)

Specified by:

shardingKey in interface OracleConnectionBuilder

Parameters:

shardingKey - Sharding Key object that needs to be part of connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)

superShardingKey

public OracleConnectionBuilderImpl superShardingKey(OracleShardingKey superShardingKey)

Specified by:

superShardingKey in interface OracleConnectionBuilder

Parameters:

superShardingKey - Super Sharding Key object that needs to be part of connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)

shardingKey

public OracleConnectionBuilderImpl shardingKey(ShardingKey shardingKey)

Specified by:

shardingKey in interface ConnectionBuilder

Specified by:

shardingKey in interface OracleConnectionBuilder

Parameters:

shardingKey - Sharding Key object that needs to be part of connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)

superShardingKey

public OracleConnectionBuilderImpl superShardingKey(ShardingKey superShardingKey)

Specified by:

superShardingKey in interface ConnectionBuilder

Specified by:

superShardingKey in interface OracleConnectionBuilder

Parameters:

superShardingKey - Super Sharding Key object that needs to be part of connection request

Returns:

This instance of the connection builder.

See Also:

OracleConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)

gssCredential

public OracleConnectionBuilderImpl gssCredential(GSSCredential credential)

Provide the GSSCredential used to authenticate the connection.

Specified by:

gssCredential in interface OracleConnectionBuilder

Parameters:

credential - used to authenticate the connection. Not null.

sslContext

public OracleConnectionBuilderImpl sslContext(SSLContext sslContext)

Set the SSLContext on this builder.

Specified by:

sslContext in interface OracleConnectionBuilder

Parameters:

sslContext - An SSLContext to set. May be null.

Returns:

This builder.

getSSLContext

public final SSLContext getSSLContext()

Returns:

SSLContext set on this builder. May be null.

getUser

public String getUser()

Returns:

user name set on the builder object

getPassword

public String getPassword()

Returns:

password set on the builder object

getServiceName

public String getServiceName()

Returns:

service name set on the builder object

getInstanceName

public String getInstanceName()

Returns:

instance name set on the builder object

getShardingKey

public OracleShardingKeyImpl getShardingKey()

Returns:

Sharding key if set on the builder object

getSuperShardingKey

public OracleShardingKeyImpl getSuperShardingKey()

Returns:

Super sharding key if set on the builder object

getGSSCredential

public GSSCredential getGSSCredential()

Returns:

GSSCredential set on the builder object

accessToken

public final OracleConnectionBuilderImpl accessToken(AccessToken accessToken)

Sets the accessToken(oracle.jdbc.AccessToken) field of this builder.

The behavior and signature of this method are identical to what is specified by oracle.jdbc.OracleConnectionBuilder#accessToken(char[], PrivateKey). Subclasses that implement OracleConnectionBuilder may inherit this implementation.

Specified by:

accessToken in interface OracleConnectionBuilder

Parameters:

accessToken - the token to use for this connection. Not null.

Returns:

the same ConnectionBuilder instance

Throws:

NullPointerException - If accessToken is null.

setTokenSupplier

public final void setTokenSupplier(java.util.function.Supplier<? extends AccessToken> tokenSupplier)

Internal API to configure this builder with a Supplier of AccessTokens. The Supplier may assume that the driver will only request a token from it immediately prior to sending that token to the database. This affords highest possible precision for a Supplier when estimating whether or not a cached token would reach the database before expiring.

Parameters:

tokenSupplier - Supplier of tokens

getTokenSupplier

public final java.util.function.Supplier<? extends AccessToken> getTokenSupplier()

Returns a supplier of AccessTokens if one has been specified by user code calling accessToken(AccessToken), or by internal code calling setTokenSupplier(Supplier). The Supplier returned by this method should only be invoked to output a token immediately prior to sending the token to the database. This affords the supplier with the best possible preceision for estimating whether or not a cached token would reach the database before expiring.

Returns:

Supplier of AccessTokens specified to this builder, or null if none has been specified.

verifyBuildConfiguration

public final void verifyBuildConfiguration()
                                    throws SQLException

Verifies if this builder has been configured such that a call to build() will produce a valid connection. This method verifies any conditions described in the JavaDocs of AbstractConnectionBuilder. Subclasses implement build() to call this method prior to returning a connection.

Throws:

SQLException - If this builder has an invalid configuration.