UCPConnectionBuilderImpl (Oracle Database JDBC and UCP Java API Reference)

java.lang.Object
- oracle.ucp.jdbc.UCPConnectionBuilderImpl

All Implemented Interfaces:

UCPConnectionBuilder
```
public abstract class UCPConnectionBuilderImpl
extends Object
implements UCPConnectionBuilder
```
UCP Connection Builder class for building connection objects with additional parameters other than just the username, password and labels. 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 is 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. Example usage : PoolDataSource pds = PoolDataSourceFactory.getPoolDataSource(); ..//set the required properties on the datasource OracleShardingKey superShardingKey = pds.createShardingKeyBuilder() .subkey("EASTERN_REGION", JDBCType.VARCHAR) .build(); OracleShardingKey shardingKey = pds.createShardingKeyBuilder() .subkey("PITTSBURGH_BRANCH", JDBCType.VARCHAR) .build(); Connection conn = pds.createConnectionBuilder() .user("user") .password("password") .serviceName("service_name") .shardingKey(shardingKey) .superShardingKey(superShardingKey) .build();

Field Summary

Fields
Modifier and Type	Field and Description
`protected Properties`	`labels`
`protected String`	`password`
`protected Properties`	`pdbRoles`
`protected Properties`	`proxyProperties`
`protected int`	`proxyType`
`protected String`	`serviceName`
`protected OracleShardingKey`	`shardingKey`
`protected OracleShardingKey`	`superShardingKey`
`protected String`	`user`

Constructor Summary

Constructors
Constructor and Description

UCPConnectionBuilderImpl()

Constructors
Constructor and Description
`UCPConnectionBuilderImpl()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Connection`	`build()` Builds the connection object.
`UCPConnectionBuilder`	`labels(Properties labels)` Sets the labels attribute on the builder
`UCPConnectionBuilder`	`password(String password)` Sets the password attribute on the builder
`UCPConnectionBuilder`	`pdbRoles(Properties pdbRoles)` Sets the PDB roles to be set on the connection from the pool in connection repurposing case for a multitenant database.
`UCPConnectionBuilder`	`proxyProperties(int proxyType, Properties proxyProperties)` Sets the proxy properties on the builder that is used to create proxy session of the particular type as specified by the parameter proxyType
`UCPConnectionBuilder`	`serviceName(String serviceName)` Sets the service name attribute on the builder
`UCPConnectionBuilder`	`shardingKey(OracleShardingKey shardingKey)`
`UCPConnectionBuilder`	`superShardingKey(OracleShardingKey superShardingKey)`
`UCPConnectionBuilder`	`user(String user)` Sets the user attribute on the builder

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
```
  - labels
```
protected Properties labels
```
  - serviceName
```
protected String serviceName
```
  - proxyType
```
protected int proxyType
```
  - proxyProperties
```
protected Properties proxyProperties
```
  - shardingKey
```
protected OracleShardingKey shardingKey
```
  - superShardingKey
```
protected OracleShardingKey superShardingKey
```
  - pdbRoles
```
protected Properties pdbRoles
```
- Constructor Detail
  - UCPConnectionBuilderImpl
```
public UCPConnectionBuilderImpl()
```
- Method Detail
  - user
```
public UCPConnectionBuilder user(String user)
```
    Sets the user attribute on the builder
    
    Specified by:
    
    user in interface UCPConnectionBuilder
    
    Parameters:
    
    user - the database user on whose behalf the connection is being made
    
    Returns:
    
    this builder object
    
    See Also:
    
    UCPConnectionBuilder.user(java.lang.String)
  - password
```
public UCPConnectionBuilder password(String password)
```
    Sets the password attribute on the builder
    
    Specified by:
    
    password in interface UCPConnectionBuilder
    
    Parameters:
    
    password -
    
    Returns:
    
    this connection builder object
    
    See Also:
    
    UCPConnectionBuilder.password(java.lang.String)
  - labels
```
public UCPConnectionBuilder labels(Properties labels)
```
    Sets the labels attribute on the builder
    
    Specified by:
    
    labels in interface UCPConnectionBuilder
    
    Parameters:
    
    labels - The requested connection labels.
    
    Returns:
    
    this connection builder object
    
    See Also:
    
    UCPConnectionBuilder.labels(java.util.Properties)
  - serviceName
```
public UCPConnectionBuilder serviceName(String serviceName)
```
    Sets the service name attribute on the builder
    
    Specified by:
    
    serviceName in interface UCPConnectionBuilder
    
    Parameters:
    
    serviceName - to retrieve the connection
    
    Returns:
    
    this connection builder instance
    
    See Also:
    
    UCPConnectionBuilder.serviceName(java.lang.String)
  - proxyProperties
```
public UCPConnectionBuilder proxyProperties(int proxyType,
                                            Properties proxyProperties)
```
    Sets the proxy properties on the builder that is used to create proxy session of the particular type as specified by the parameter proxyType
    
    Specified by:
    
    proxyProperties in interface UCPConnectionBuilder
    
    Parameters:
    
    proxyType - create proxy session of this type
    
    proxyProperties - connection with these proxy properties
    
    Returns:
    
    this connection builder instance
    
    See Also:
    
    for valid combinations of the proxy session properties, UCPConnectionBuilder.proxyProperties(int, java.util.Properties)
  - shardingKey
```
public UCPConnectionBuilder shardingKey(OracleShardingKey shardingKey)
```
    Specified by:
    
    shardingKey in interface UCPConnectionBuilder
    
    Parameters:
    
    shardingKey -
    
    Returns:
    
    See Also:
    
    UCPConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)
  - superShardingKey
```
public UCPConnectionBuilder superShardingKey(OracleShardingKey superShardingKey)
```
    Specified by:
    
    superShardingKey in interface UCPConnectionBuilder
    
    Parameters:
    
    superShardingKey -
    
    Returns:
    
    See Also:
    
    UCPConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)
  - pdbRoles
```
public UCPConnectionBuilder pdbRoles(Properties pdbRoles)
```
    Sets the PDB roles to be set on the connection from the pool in connection repurposing case for a multitenant database.
    
    Specified by:
    
    pdbRoles in interface UCPConnectionBuilder
    
    Parameters:
    
    pdbRoles - PDB roles and their passwords passed in as key value pairs
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    UCPConnectionBuilder.pdbRoles(java.util.Properties)
  - build
```
public abstract Connection build()
                          throws SQLException
```
    Builds the connection object.
    
    Specified by:
    
    build in interface UCPConnectionBuilder
    
    Returns:
    
    Connection object built considering the builder attributes
    
    Throws:
    
    SQLException - if there is a failure in building the connection.
    
    See Also:
    
    UCPConnectionBuilder.build()

Class UCPConnectionBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

user

password

labels

serviceName

proxyType

proxyProperties

shardingKey

superShardingKey

pdbRoles

Constructor Detail

UCPConnectionBuilderImpl

Method Detail

user

password

labels

serviceName

proxyProperties

shardingKey

superShardingKey

pdbRoles

build