Package oracle.ucp.jdbc

Class UCPXAConnectionBuilderImpl

java.lang.Object

oracle.ucp.jdbc.UCPXAConnectionBuilderImpl

All Implemented Interfaces:

UCPXAConnectionBuilder

public abstract class UCPXAConnectionBuilderImpl
extends Object
implements UCPXAConnectionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isBuilt
protected Properties	labels
protected OpaqueString	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	Description
UCPXAConnectionBuilderImpl()

Method Summary

Modifier and Type	Method	Description
abstract XAConnection	build()	Builds the XA connection object.
UCPXAConnectionBuilder	labels(Properties labels)	Sets the labels attribute on the builder
UCPXAConnectionBuilder	password(String password)	Sets the password attribute on the builder
UCPXAConnectionBuilder	pdbRoles(Properties pdbRoles)	Sets the PDB roles to be set on the connection from the pool in connection repurposing case for a multitenant database.
UCPXAConnectionBuilder	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
UCPXAConnectionBuilder	serviceName(String serviceName)	Sets the service name attribute on the builder
UCPXAConnectionBuilder	shardingKey(OracleShardingKey shardingKey)
UCPXAConnectionBuilder	superShardingKey(OracleShardingKey superShardingKey)
UCPXAConnectionBuilder	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 OpaqueString password

labels

protected Properties labels

serviceName

protected String serviceName

proxyType

protected int proxyType

proxyProperties

protected Properties proxyProperties

isBuilt

protected boolean isBuilt

shardingKey

protected OracleShardingKey shardingKey

superShardingKey

protected OracleShardingKey superShardingKey

pdbRoles

protected Properties pdbRoles

Constructor Detail

UCPXAConnectionBuilderImpl

public UCPXAConnectionBuilderImpl()

Method Detail

user

public UCPXAConnectionBuilder user(String user)

Sets the user attribute on the builder

Specified by:

user in interface UCPXAConnectionBuilder

Parameters:

user - the database user on whose behalf the connection is being made

Returns:

this builder object

See Also:

UCPXAConnectionBuilder.user(java.lang.String)

password

public UCPXAConnectionBuilder password(String password)

Sets the password attribute on the builder

Specified by:

password in interface UCPXAConnectionBuilder

Parameters:

password -

Returns:

this connection builder object

See Also:

UCPXAConnectionBuilder.password(java.lang.String)

labels

public UCPXAConnectionBuilder labels(Properties labels)

Sets the labels attribute on the builder

Specified by:

labels in interface UCPXAConnectionBuilder

Parameters:

labels - The requested connection labels.

Returns:

this connection builder object

See Also:

UCPXAConnectionBuilder.labels(java.util.Properties)

serviceName

public UCPXAConnectionBuilder serviceName(String serviceName)

Sets the service name attribute on the builder

Specified by:

serviceName in interface UCPXAConnectionBuilder

Parameters:

serviceName - to retrieve the connection

Returns:

this connection builder instance

See Also:

UCPXAConnectionBuilder.serviceName(java.lang.String)

proxyProperties

public UCPXAConnectionBuilder 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 UCPXAConnectionBuilder

Parameters:

proxyType - create proxy session of this type

proxyProperties - connection with these proxy properties

Returns:

this connection builder instance

See Also:

UCPXAConnectionBuilder.proxyProperties(int, java.util.Properties)

shardingKey

public UCPXAConnectionBuilder shardingKey(OracleShardingKey shardingKey)

Specified by:

shardingKey in interface UCPXAConnectionBuilder

Parameters:

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

Returns:

This instance of the connection builder.

See Also:

UCPXAConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)

superShardingKey

public UCPXAConnectionBuilder superShardingKey(OracleShardingKey superShardingKey)

Specified by:

superShardingKey in interface UCPXAConnectionBuilder

Parameters:

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

Returns:

This instance of the connection builder.

See Also:

UCPXAConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)

pdbRoles

public UCPXAConnectionBuilder 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 UCPXAConnectionBuilder

Parameters:

pdbRoles - PDB roles and their passwords passed in as key value pairs

Returns:

This instance of the connection builder.

See Also:

UCPXAConnectionBuilder.pdbRoles(java.util.Properties)

build

public abstract XAConnection build()
                            throws SQLException

Builds the XA connection object.

Specified by:

build in interface UCPXAConnectionBuilder

Returns:

XAConnection created considering the builder attributes

Throws:

SQLException - if there is a failure in building the connection.

See Also:

UCPXAConnectionBuilder.build()