Interface OracleConnectionBuilder
- 
- All Superinterfaces:
- ConnectionBuilder
 - All Known Implementing Classes:
- OracleConnectionBuilderImpl
 
 public interface OracleConnectionBuilder extends ConnectionBuilder A builder created from aOracleDataSourceobject, used to establish a connection to the database that theOracleDataSourceobject represents. The connection properties that were specified for theOracleDataSourceare used as the default values by theOracleConnectionBuilder.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 OracleConnectionBuilderto create aOracleConnection: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();- Since:
- 12.2
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description OracleConnectionBuilderaccessToken(AccessToken accessToken)Specifies theaccessTokento be used when creating a connection.OracleConnectionbuild()Builds the connection object.default CompletionStage<OracleConnection>buildAsyncOracle()Returns aCompletionStagethat completes with aConnectionhaving the same state as if it were built by callingbuildon thisConnectionBuilder.default Flow.Publisher<OracleConnection>buildConnectionPublisherOracle()Returns aPublisherthat publishes a singleConnectionobject with the same state as if it were built by callingbuildon thisConnectionBuilder.OracleConnectionBuilderexecutorOracle(Executor executor)Set theExecutorused for asynchronous tasks by thisConnectionBuilderand anyConnectionobjects built by it.OracleConnectionBuildergssCredential(GSSCredential credential)Provide the GSSCredential used to authenticate the connection.OracleConnectionBuilderhostnameResolver(OracleHostnameResolver hostnameResolver)Sets a custom hostname resolver implementingOracleHostnameResolverused to provide a custom DNS name resolution strategy to locate the database host.OracleConnectionBuilderpassword(String password)OracleConnectionBuilderreadOnlyInstanceAllowed(boolean readOnlyInstanceAllowed)Sets the read-only instance allowed value on this builder.OracleConnectionBuildershardingKey(ShardingKey shardingKey)OracleConnectionBuildershardingKey(OracleShardingKey shardingKey)OracleConnectionBuildersslContext(SSLContext sslContext)Specifies aSSLContextto use as a factory for SSLEngine objects that carry out the TLS protocol.OracleConnectionBuildersuperShardingKey(ShardingKey superShardingKey)OracleConnectionBuildersuperShardingKey(OracleShardingKey superShardingKey)OracleConnectionBuilderuser(String user)
 
- 
- 
- 
Method Detail- 
userOracleConnectionBuilder user(String user) - Specified by:
- userin interface- ConnectionBuilder
- Parameters:
- user-
- Returns:
- This OracleConnectionBuilderobject
 
 - 
passwordOracleConnectionBuilder password(String password) - Specified by:
- passwordin interface- ConnectionBuilder
- Parameters:
- password-
- Returns:
- This OracleConnectionBuilderobject
 
 - 
shardingKeyOracleConnectionBuilder shardingKey(OracleShardingKey shardingKey) - Parameters:
- shardingKey- Sharding Key object that needs to be part of connection request
- Returns:
- This OracleConnectionBuilderobject
 
 - 
superShardingKeyOracleConnectionBuilder superShardingKey(OracleShardingKey superShardingKey) - Parameters:
- superShardingKey- Super sharding key object that needs to be part of connection request
- Returns:
- This OracleConnectionBuilderobject
 
 - 
shardingKeyOracleConnectionBuilder shardingKey(ShardingKey shardingKey) - Specified by:
- shardingKeyin interface- ConnectionBuilder
- Parameters:
- shardingKey- Sharding Key object that needs to be part of connection request
- Returns:
- This OracleConnectionBuilderobject
 
 - 
superShardingKeyOracleConnectionBuilder superShardingKey(ShardingKey superShardingKey) - Specified by:
- superShardingKeyin interface- ConnectionBuilder
- Parameters:
- superShardingKey- Super sharding key object that needs to be part of connection request
- Returns:
- This OracleConnectionBuilderobject
 
 - 
gssCredentialOracleConnectionBuilder gssCredential(GSSCredential credential) Provide the GSSCredential used to authenticate the connection.- Parameters:
- credential- used to authenticate the connection. Not null.
- Returns:
- This OracleConnectionBuilderobject
 
 - 
sslContextOracleConnectionBuilder sslContext(SSLContext sslContext) Specifies aSSLContextto 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. - Parameters:
- sslContext- An SSLContext to use as an SSLEngine factory.
- Returns:
- This OracleConnectionBuilderobject
- Since:
- 20
 
 - 
hostnameResolverOracleConnectionBuilder hostnameResolver(OracleHostnameResolver hostnameResolver) Sets a custom hostname resolver implementingOracleHostnameResolverused to provide a custom DNS name resolution strategy to locate the database host.- Parameters:
- hostnameResolver- an OracleHostnameResolver to use when resolving the datasource hostname
- Returns:
- This OracleConnectionBuilderobject
- Since:
- 23
 
 - 
readOnlyInstanceAllowedOracleConnectionBuilder readOnlyInstanceAllowed(boolean readOnlyInstanceAllowed) Sets the read-only instance allowed value on this builder. This property is applicable to sharded database only. When the property value is set to true, the database allows connection creation to read-only instances as well otherwise not. A shard instance goes into read-only mode for a chunk if the chunk move/split operation is in progress on that instance. The default value is false which means by default connection creation is not allowed to a read-only instance.- Parameters:
- readOnlyInstanceAllowed- whether to allow connection creation to a read-only instance or not
- Returns:
- This OracleConnectionBuilderobject
 
 - 
executorOracleOracleConnectionBuilder executorOracle(Executor executor) Set the Executorused for asynchronous tasks by thisConnectionBuilderand anyConnectionobjects built by it. The default value isForkJoinPool.commonPool().Asynchronous tasks will be executed as a PrivilegedActionwith the sameAccessControlContextas the thread which initiated the asynchronous task.The following API calls initiate asynchronous tasks: - 
    buildConnectionPublisherOracle()
- 
    OraclePreparedStatement.executeAsyncOracle()
- 
    OraclePreparedStatement.executeQueryAsyncOracle()
- 
    OraclePreparedStatement.executeUpdateAsyncOracle()
- 
    OraclePreparedStatement.executeBatchAsyncOracle()
- 
    OracleResultSet#publisherOracle()
- 
    OracleBlob.publisherOracle(long)
- 
    OracleClob.publisherOracle(long)
- 
    OracleBfile.publisherOracle(long)
- 
    OracleConnection.commitAsyncOracle()
- 
    OracleConnection.rollbackAsyncOracle()
- 
    OracleConnection.closeAsyncOracle()
 - Parameters:
- exec- an Executor to use for asynchronous tasks. Not null.
- Returns:
- this OracleConnectionBuilder
- Since:
- 20
 
- 
    
 - 
accessTokenOracleConnectionBuilder accessToken(AccessToken accessToken) Specifies the accessTokento 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)oruser(String)are invoked with non null values, then aSQLExceptionindicating an invalid configuration is thrown when creating a connection with this builder.- Parameters:
- accessToken- the token to use for this connection. Not- null.
- Returns:
- the same ConnectionBuilderinstance
- Throws:
- NullPointerException- If the- accessTokenis- null.
 
 - 
buildAsyncOracledefault CompletionStage<OracleConnection> buildAsyncOracle() throws SQLException Returns aCompletionStagethat completes with aConnectionhaving the same state as if it were built by callingbuildon thisConnectionBuilder.The returned stage is completed exceptionally with a SQLExceptionif a failure occurs when building theConnection.- Returns:
- a CompletionStagewhich completes with aConnectionbuilt by thisConnectionBuilder
- Throws:
- SQLException
- Since:
- 20
 
 - 
buildConnectionPublisherOracledefault Flow.Publisher<OracleConnection> buildConnectionPublisherOracle() throws SQLException Returns aPublisherthat publishes a singleConnectionobject with the same state as if it were built by callingbuildon thisConnectionBuilder. The returnedPublisherdoes not support multipleSubscribers.- Returns:
- a Publisherof aConnectionbuilt by thisConnectionBuilder
- Throws:
- SQLException
- Since:
- 20
 
 - 
buildOracleConnection build() throws SQLException Builds the connection object.- Specified by:
- buildin interface- ConnectionBuilder
- Returns:
- New OracleConnectionthat is created.
- Throws:
- SQLException
 
 
- 
 
-