public interface OracleConnectionBuilder
OracleDataSource
object, used to establish a connection to the database that the OracleDataSource
object represents. The connection properties that were specified for the OracleDataSource
are used as the default values by the OracleConnectionBuilder
.
To use the builder, the corresponding builder method needs to be called for each parameter that needs to be part of the connection request followed by a build() method. The order in which the builder methods are called is not important. However if the same builder attribute is applied more than once, only the most recent value will be considered while building the connection. The builder object can be reused to build more than one connection and the builder attributes will be retained across multiple invocations of the build() method.
The following example illustrates the use of OracleConnectionBuilder
to create a OracleConnection
:
OracleDataSource ods = new oracle.jdbc.pool.OracleDataSource();
OracleShardingKey superShardingKey =
ods.createShardingKeyBuilder()
.subkey("EASTERN_REGION", JDBCType.VARCHAR)
.build();
OracleShardingKey shardingKey =
ods.createShardingKeyBuilder()
.subkey("PITTSBURGH_BRANCH", JDBCType.VARCHAR)
.build();
OracleConnection connection = ods.createConnectionBuilder()
.user("rafa")
.password("tennis")
.shardingKey(shardingKey)
.superShardingKey(superShardingKey)
.build();
Modifier and Type | Method and Description |
---|---|
OracleConnectionBuilder |
accessToken(AccessToken accessToken)
Specifies the
accessToken to be used when creating a connection. |
OracleConnection |
build()
Builds the connection object.
|
OracleConnectionBuilder |
gssCredential(GSSCredential credential)
Provide the GSSCredential used to authenticate the connection.
|
OracleConnectionBuilder |
password(String password) |
OracleConnectionBuilder |
shardingKey(OracleShardingKey shardingKey) |
OracleConnectionBuilder |
sslContext(SSLContext sslContext)
Specifies a
SSLContext to use as a factory for SSLEngine objects that carry out the TLS protocol. |
OracleConnectionBuilder |
superShardingKey(OracleShardingKey superShardingKey) |
OracleConnectionBuilder |
user(String user) |
OracleConnectionBuilder user(String user)
user
-OracleConnectionBuilder
objectOracleConnectionBuilder password(String password)
password
-OracleConnectionBuilder
objectOracleConnectionBuilder shardingKey(OracleShardingKey shardingKey)
shardingKey
- Sharding Key object that needs to be part of connection requestOracleConnectionBuilder
objectOracleConnectionBuilder superShardingKey(OracleShardingKey superShardingKey)
superShardingKey
- Super sharding key object that needs to be part of connection requestOracleConnectionBuilder
objectOracleConnectionBuilder gssCredential(GSSCredential credential)
credential
- used to authenticate the connection. Not null.OracleConnectionBuilder sslContext(SSLContext sslContext)
SSLContext
to use as a factory for SSLEngine objects that carry out the TLS protocol.
The SSLContext must be initialized before building the connection. The certificates specified by that initialization will be used in place of any connection properties that would otherwise have specified certificates, such as key store and trust store property values.
Specifying a null value will clear any non-null value that may have been set previously, causing this builder to behave as if this method had never been called at all.
sslContext
- An SSLContext to use as an SSLEngine factory.OracleConnectionBuilder
objectOracleConnectionBuilder accessToken(AccessToken accessToken)
Specifies the accessToken
to be used when creating a connection. The issuer of the token must be one that is supported by Oracle Database for client authentication.
It is invalid to configure this builder with both a token and with a username or password. If both this method and password(String)
or user(String)
are invoked with non null values, then a SQLException
indicating an invalid configuration is thrown when creating a connection with this builder.
accessToken
- the token to use for this connection. Not null
.ConnectionBuilder
instanceNullPointerException
- If the accessToken
is null
.OracleConnection build() throws SQLException
OracleConnection
that is created.SQLException