Package Summary Overview Summary |
public interface XAConnectionBuilder
XADataSource
object, used to establish a connection to the database that the data source
object represents. The connection properties that were specified for the data source
are used as the default values by the XAConnectionBuilder
.
The following example illustrates the use of XAConnectionBuilder
to create a XAConnection
:
XADataSource ds = new MyXADataSource();
ShardingKey superShardingKey = ds.createShardingKeyBuilder()
.subkey("EASTERN_REGION", JDBCType.VARCHAR)
.build();
ShardingKey shardingKey = ds.createShardingKeyBuilder()
.subkey("PITTSBURGH_BRANCH", JDBCType.VARCHAR)
.build();
XAConnection con = ds.createXAConnectionBuilder()
.user("rafa")
.password("tennis")
.setShardingKey(shardingKey)
.setSuperShardingKey(superShardingKey)
.build();
Modifier and Type | Method | Description |
---|---|---|
XAConnection | build() |
Returns an instance of the object defined by this builder.
|
XAConnectionBuilder | password(java.lang.String password) |
Specifies the password to be used when creating a connection
|
XAConnectionBuilder | shardingKey(ShardingKey shardingKey) |
Specifies a
shardingKey to be used when creating a connection
|
XAConnectionBuilder | superShardingKey(ShardingKey superShardingKey) |
Specifies a
superShardingKey to be used when creating a connection
|
XAConnectionBuilder | user(java.lang.String username) |
Specifies the username to be used when creating a connection
|
XAConnectionBuilder user(java.lang.String username)
username
- the database user on whose behalf the connection is being made
XAConnectionBuilder
instance
XAConnectionBuilder password(java.lang.String password)
password
- the password to use for this connection. May be null
XAConnectionBuilder
instance
XAConnectionBuilder shardingKey(ShardingKey shardingKey)
shardingKey
to be used when creating a connection
shardingKey
- the ShardingKey. May be null
XAConnectionBuilder
instance
ShardingKey
, ShardingKeyBuilder
XAConnectionBuilder superShardingKey(ShardingKey superShardingKey)
superShardingKey
to be used when creating a connection
superShardingKey
- the SuperShardingKey. May be null
XAConnectionBuilder
instance
ShardingKey
, ShardingKeyBuilder
XAConnection build() throws SQLException
SQLException
- If an error occurs building the object