software.amazon.jdbc

Interface ConnectionProvider

All Known Subinterfaces:

PooledConnectionProvider

All Known Implementing Classes:

C3P0PooledConnectionProvider, DataSourceConnectionProvider, DriverConnectionProvider, HikariPooledConnectionProvider

public interface ConnectionProvider

Implement this interface in order to handle the physical connection creation process.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(@NonNull 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.
java.sql.Connection	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.
HostSpec	getHostSpecByStrategy(@NonNull java.util.List<HostSpec> hosts, @NonNull HostRole role, @NonNull java.lang.String strategy, @Nullable java.util.Properties props) Return a reader or a writer node using the specified strategy.
java.lang.String	getTargetName()

Method Detail

acceptsUrl

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. Some ConnectionProvider implementations may not be able to handle certain URL types or properties.

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

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

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

Parameters:

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

strategy - the selection strategy to use

Returns:

whether the strategy is supported

getHostSpecByStrategy

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

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

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

Throws:

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

java.lang.UnsupportedOperationException - if the strategy is unsupported by the provider

connect

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

Called once per connection that needs to be created.

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:

Connection resulting from the given connection information

Throws:

java.sql.SQLException - if an error occurs

getTargetName

java.lang.String getTargetName()