OracleXAConnectionBuilderImpl (Oracle Database JDBC Java API Reference)

java.lang.Object
- oracle.jdbc.xa.OracleXAConnectionBuilderImpl

All Implemented Interfaces:

XAConnectionBuilder, OracleXAConnectionBuilder
```
public abstract class OracleXAConnectionBuilderImpl
extends Object
implements OracleXAConnectionBuilder
```
Oracle Implementation class for Connection Builder

Field Summary

Fields
Modifier and Type	Field	Description
`protected GSSCredential`	`gssCredential`
`protected String`	`instanceName`
`protected String`	`password`
`protected String`	`serviceName`
`protected OracleShardingKey`	`shardingKey`
`protected SSLContext`	`sslContext`
`protected OracleShardingKey`	`superShardingKey`
`protected String`	`user`

Constructor Summary

Constructors
Constructor Description

OracleXAConnectionBuilderImpl()

Constructors
Constructor	Description
`OracleXAConnectionBuilderImpl()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract OracleXAConnection`	`build()`	Builds the connection of type OracleXAConnection.
`GSSCredential`	`getGSSCredential()`
`String`	`getInstanceName()`
`OracleConnectionBuilderImpl`	`getOracleConnectionBuilder(OracleConnectionBuilderImpl connBldr)`	Utility method to set all the builder attributes on a Connection builder from this XA connection builder instance .
`String`	`getPassword()`
`String`	`getServiceName()`
`OracleShardingKeyImpl`	`getShardingKey()`
`SSLContext`	`getSSLContext()`
`OracleShardingKeyImpl`	`getSuperShardingKey()`
`String`	`getUser()`
`OracleXAConnectionBuilderImpl`	`gssCredential(GSSCredential credential)`	Provide the GSSCredential used to authenticate the connection.
`OracleXAConnectionBuilderImpl`	`instanceName(String instanceName)`
`OracleXAConnectionBuilderImpl`	`password(String password)`
`OracleXAConnectionBuilderImpl`	`serviceName(String serviceName)`
`OracleXAConnectionBuilderImpl`	`shardingKey(ShardingKey shardingKey)`
`OracleXAConnectionBuilderImpl`	`shardingKey(OracleShardingKey shardingKey)`
`OracleXAConnectionBuilderImpl`	`sslContext(SSLContext sslContext)`	Set the SSLContext on this builder.
`OracleXAConnectionBuilderImpl`	`superShardingKey(ShardingKey superShardingKey)`
`OracleXAConnectionBuilderImpl`	`superShardingKey(OracleShardingKey superShardingKey)`
`OracleXAConnectionBuilderImpl`	`user(String user)`

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
```
  - serviceName
```
protected String serviceName
```
  - instanceName
```
protected String instanceName
```
  - shardingKey
```
protected OracleShardingKey shardingKey
```
  - superShardingKey
```
protected OracleShardingKey superShardingKey
```
  - gssCredential
```
protected GSSCredential gssCredential
```
  - sslContext
```
protected SSLContext sslContext
```
- Constructor Detail
  - OracleXAConnectionBuilderImpl
```
public OracleXAConnectionBuilderImpl()
```
- Method Detail
  - build
```
public abstract OracleXAConnection build()
                                  throws SQLException
```
    Builds the connection of type OracleXAConnection. The build() method can be called only once on a builder object.
    
    Specified by:
    
    build in interface OracleXAConnectionBuilder
    
    Specified by:
    
    build in interface XAConnectionBuilder
    
    Returns:
    
    the new object that is built.
    
    Throws:
    
    SQLException
    
    See Also:
    
    OracleXAConnectionBuilder.build()
  - password
```
public OracleXAConnectionBuilderImpl password(String password)
```
    Specified by:
    
    password in interface OracleXAConnectionBuilder
    
    Specified by:
    
    password in interface XAConnectionBuilder
    
    Parameters:
    
    password - Password to be a part of the connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.password(java.lang.String)
  - user
```
public OracleXAConnectionBuilderImpl user(String user)
```
    Specified by:
    
    user in interface OracleXAConnectionBuilder
    
    Specified by:
    
    user in interface XAConnectionBuilder
    
    Parameters:
    
    user - User Name to be a part of the connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.user(java.lang.String)
  - serviceName
```
public OracleXAConnectionBuilderImpl serviceName(String serviceName)
```
    Parameters:
    
    serviceName - Service name to be part of the connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    oracle.jdbc.OracleXAConnectionBuilder#serviceName(java.lang.String)
  - instanceName
```
public OracleXAConnectionBuilderImpl instanceName(String instanceName)
```
    Parameters:
    
    instanceName - Instance name to be part of the connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    oracle.jdbc.OracleXAConnectionBuilder#instanceName(java.lang.String)
  - shardingKey
```
public OracleXAConnectionBuilderImpl shardingKey(OracleShardingKey shardingKey)
```
    Specified by:
    
    shardingKey in interface OracleXAConnectionBuilder
    
    Parameters:
    
    shardingKey - Sharding Key object that needs to be part of connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)
  - superShardingKey
```
public OracleXAConnectionBuilderImpl superShardingKey(OracleShardingKey superShardingKey)
```
    Specified by:
    
    superShardingKey in interface OracleXAConnectionBuilder
    
    Parameters:
    
    superShardingKey - Super Sharding Key object that needs to be part of connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)
  - shardingKey
```
public OracleXAConnectionBuilderImpl shardingKey(ShardingKey shardingKey)
```
    Specified by:
    
    shardingKey in interface OracleXAConnectionBuilder
    
    Specified by:
    
    shardingKey in interface XAConnectionBuilder
    
    Parameters:
    
    shardingKey - Sharding Key object that needs to be part of connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.shardingKey(oracle.jdbc.OracleShardingKey)
  - superShardingKey
```
public OracleXAConnectionBuilderImpl superShardingKey(ShardingKey superShardingKey)
```
    Specified by:
    
    superShardingKey in interface OracleXAConnectionBuilder
    
    Specified by:
    
    superShardingKey in interface XAConnectionBuilder
    
    Parameters:
    
    superShardingKey - Super Sharding Key object that needs to be part of connection request
    
    Returns:
    
    This instance of the connection builder.
    
    See Also:
    
    OracleXAConnectionBuilder.superShardingKey(oracle.jdbc.OracleShardingKey)
  - gssCredential
```
public OracleXAConnectionBuilderImpl gssCredential(GSSCredential credential)
```
    Provide the GSSCredential used to authenticate the connection.
    
    Specified by:
    
    gssCredential in interface OracleXAConnectionBuilder
    
    Parameters:
    
    credential - used to authenticate the connection. Not null.
  - sslContext
```
public OracleXAConnectionBuilderImpl sslContext(SSLContext sslContext)
```
    Set the SSLContext on this builder.
    
    Specified by:
    
    sslContext in interface OracleXAConnectionBuilder
    
    Parameters:
    
    sslContext - An SSLContext to set. May be null.
    
    Returns:
    
    This builder.
  - getSSLContext
```
public final SSLContext getSSLContext()
```
    Returns:
    
    SSLContext set on this builder. May be null.
  - getUser
```
public String getUser()
```
    Returns:
    
    user name set on the builder object
  - getPassword
```
public String getPassword()
```
    Returns:
    
    password set on the builder object
  - getServiceName
```
public String getServiceName()
```
    Returns:
    
    service name set on the builder object
  - getInstanceName
```
public String getInstanceName()
```
    Returns:
    
    instance name set on the builder object
  - getShardingKey
```
public OracleShardingKeyImpl getShardingKey()
```
    Returns:
    
    Sharding key if set on the builder object
  - getSuperShardingKey
```
public OracleShardingKeyImpl getSuperShardingKey()
```
    Returns:
    
    Super sharding key if set on the builder object
  - getGSSCredential
```
public GSSCredential getGSSCredential()
```
    Returns:
    
    GSSCredential set on the builder object
  - getOracleConnectionBuilder
```
public OracleConnectionBuilderImpl getOracleConnectionBuilder(OracleConnectionBuilderImpl connBldr)
```
    Utility method to set all the builder attributes on a Connection builder from this XA connection builder instance .
    
    Parameters:
    
    connBldr - The connection builder instance that needs to be initialized with this builder attributes.
    
    Returns:
    
    Connection builder object

Class OracleXAConnectionBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

user

password

serviceName

instanceName

shardingKey

superShardingKey

gssCredential

sslContext

Constructor Detail

OracleXAConnectionBuilderImpl

Method Detail

build

password

user

serviceName

instanceName

shardingKey

superShardingKey

shardingKey

superShardingKey

gssCredential

sslContext

getSSLContext

getUser

getPassword

getServiceName

getInstanceName

getShardingKey

getSuperShardingKey

getGSSCredential

getOracleConnectionBuilder