oracle.jdbc

Interface OracleConnectionBuilder

All Known Implementing Classes:

OracleConnectionBuilderImpl

public interface OracleConnectionBuilder

A builder created from a 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();
  
  

Since:

12.2

Method Summary

Modifier and Type	Method and Description
OracleConnection	build() Builds the connection object.
OracleConnectionBuilder	password(String password)
OracleConnectionBuilder	shardingKey(OracleShardingKey shardingKey)
OracleConnectionBuilder	superShardingKey(OracleShardingKey superShardingKey)
OracleConnectionBuilder	user(String user)

Method Detail

user

OracleConnectionBuilder user(String user)

Parameters:

user -

Returns:

This OracleConnectionBuilder object

password

OracleConnectionBuilder password(String password)

Parameters:

password -

Returns:

This OracleConnectionBuilder object

shardingKey

OracleConnectionBuilder shardingKey(OracleShardingKey shardingKey)

Parameters:

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

Returns:

This OracleConnectionBuilder object

superShardingKey

OracleConnectionBuilder superShardingKey(OracleShardingKey superShardingKey)

Parameters:

superShardingKey - Super sharding key object that needs to be part of connection request

Returns:

This OracleConnectionBuilder object

build

OracleConnection build()
                throws SQLException

Builds the connection object.

Returns:

New OracleConnection that is created.

Throws:

SQLException