software.amazon.jdbc.ds.xa

Class XADataSourceConnectionProvider

java.lang.Object

software.amazon.jdbc.ds.xa.XADataSourceConnectionProvider

All Implemented Interfaces:

ConnectionProvider, StateSnapshotProvider

public class XADataSourceConnectionProvider
extends java.lang.Object
implements ConnectionProvider

A ConnectionProvider for the XA datasource path. It wraps a configured target XADataSource, opens a single XAConnection lazily on first use, and returns a fresh logical Connection handle over that same physical XA connection on each connect(java.lang.String, software.amazon.jdbc.dialect.Dialect, software.amazon.jdbc.targetdriverdialect.TargetDriverDialect, software.amazon.jdbc.HostSpec, java.util.Properties) call.

Because an XA branch is pinned to one physical session and the XAResource is bound to this XAConnection, the same XAConnection is reused for the lifetime of this provider (i.e. of the owning XAConnectionWrapper); it is never repointed to a different host. The target XADataSource is expected to be fully configured before it is handed to this provider.

Constructor Summary

Constructors

Constructor and Description
XADataSourceConnectionProvider(@NonNull javax.sql.XADataSource xaDataSource)
XADataSourceConnectionProvider(@NonNull javax.sql.XADataSource xaDataSource, @Nullable java.lang.String resolvedUrl)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(@Nullable HostRole role, @NonNull java.lang.String strategy) Indicates whether the selection strategy is supported by the connection provider.
boolean	acceptsUrl(@NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props) Indicates whether this ConnectionProvider can provide connections for the given host and properties.
@NonNull ConnectionInfo	connect(@NonNull java.lang.String protocol, @NonNull Dialect dialect, @NonNull TargetDriverDialect targetDriverDialect, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props) Called once per connection that needs to be created.
@Nullable HostSpec	getHostSpecByStrategy(@NonNull java.util.List<HostSpec> hosts, @Nullable HostRole role, @NonNull java.lang.String strategy, @Nullable java.util.Properties props) Return a reader or a writer node using the specified strategy.
@NonNull javax.sql.XAConnection	getOrOpenXaConnection() Returns the single owning XAConnection, opening it on first use.
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
java.lang.String	getTargetName()
@Nullable javax.sql.XAConnection	getXaConnectionOrNull() Returns the owning XAConnection if it has been opened, otherwise null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XADataSourceConnectionProvider

public XADataSourceConnectionProvider(@NonNull javax.sql.XADataSource xaDataSource)

XADataSourceConnectionProvider

public XADataSourceConnectionProvider(@NonNull javax.sql.XADataSource xaDataSource,
                                      @Nullable java.lang.String resolvedUrl)

Method Detail

acceptsUrl

public boolean acceptsUrl(@NonNull java.lang.String protocol,
                          @NonNull HostSpec hostSpec,
                          @NonNull java.util.Properties props)

Description copied from interface: ConnectionProvider

Indicates whether this ConnectionProvider can provide connections for the given host and properties. Some ConnectionProvider implementations may not be able to handle certain URL types or properties.

Specified by:

acceptsUrl in interface ConnectionProvider

Parameters:

protocol - the connection protocol (example "jdbc:mysql://")

hostSpec - the HostSpec containing the host-port information for the host to connect to

props - the Properties to use for the connection

Returns:

true if this ConnectionProvider can provide connections for the given URL, otherwise return false

acceptsStrategy

public boolean acceptsStrategy(@Nullable HostRole role,
                               @NonNull java.lang.String strategy)

Description copied from interface: ConnectionProvider

Indicates whether the selection strategy is supported by the connection provider.

Specified by:

acceptsStrategy in interface ConnectionProvider

Parameters:

role - determines if the connection provider should return a reader host or a writer host. Null value means no preferences on host role.

strategy - the selection strategy to use

Returns:

whether the strategy is supported

getHostSpecByStrategy

public @Nullable HostSpec getHostSpecByStrategy(@NonNull java.util.List<HostSpec> hosts,
                                                @Nullable HostRole role,
                                                @NonNull java.lang.String strategy,
                                                @Nullable java.util.Properties props)
                                         throws java.sql.SQLException

Description copied from interface: ConnectionProvider

Return a reader or a writer node using the specified strategy. This method should raise an UnsupportedOperationException if the specified strategy is unsupported.

Specified by:

getHostSpecByStrategy in interface ConnectionProvider

Parameters:

hosts - the list of HostSpec to select from

role - determines if the connection provider should return a writer or a reader

strategy - the strategy determining how the HostSpec should be selected, e.g., random or round-robin

props - any properties that are required by the provided strategy to select a host

Returns:

the HostSpec selected using the specified strategy, or null if no host matches

Throws:

java.sql.SQLException - if an error occurred while returning the hosts

connect

public @NonNull ConnectionInfo connect(@NonNull java.lang.String protocol,
                                       @NonNull Dialect dialect,
                                       @NonNull TargetDriverDialect targetDriverDialect,
                                       @NonNull HostSpec hostSpec,
                                       @NonNull java.util.Properties props)
                                throws java.sql.SQLException

Description copied from interface: ConnectionProvider

Called once per connection that needs to be created.

Specified by:

connect in interface ConnectionProvider

Parameters:

protocol - the connection protocol (example "jdbc:mysql://")

dialect - the database dialect

targetDriverDialect - the target driver dialect

hostSpec - the HostSpec containing the host-port information for the host to connect to

props - the Properties to use for the connection

Returns:

ConnectionInfo resulting from the given connection information

Throws:

java.sql.SQLException - if an error occurs

getOrOpenXaConnection

public @NonNull javax.sql.XAConnection getOrOpenXaConnection()
                                                      throws java.sql.SQLException

Returns the single owning XAConnection, opening it on first use. Reused for the lifetime of this provider so the XAResource and every logical handle share one physical session.

Returns:

the owning XA connection.

Throws:

java.sql.SQLException - if the XA connection cannot be opened.

getXaConnectionOrNull

public @Nullable javax.sql.XAConnection getXaConnectionOrNull()

Returns the owning XAConnection if it has been opened, otherwise null.

Returns:

the owning XA connection, or null if not yet opened.

getTargetName

public java.lang.String getTargetName()

Specified by:

getTargetName in interface ConnectionProvider

getSnapshotState

public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()

Specified by:

getSnapshotState in interface StateSnapshotProvider