software.amazon.jdbc.hostlistprovider

Class AuroraHostListProvider

java.lang.Object

software.amazon.jdbc.hostlistprovider.AuroraHostListProvider

All Implemented Interfaces:

HostListProvider, DynamicHostListProvider

public class AuroraHostListProvider
extends java.lang.Object
implements HostListProvider, DynamicHostListProvider

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	CLUSTER_ID
static AwsWrapperProperty	CLUSTER_INSTANCE_HOST_PATTERN
static AwsWrapperProperty	CLUSTER_TOPOLOGY_REFRESH_RATE_MS
protected java.lang.String	clusterId
protected HostSpec	clusterInstanceTemplate
protected ConnectionUrlParser	connectionUrlParser
protected boolean	isInitialized
protected boolean	isPrimaryClusterId
protected static ExpiringCache<java.lang.String,software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo>	topologyCache

Constructor Summary

Constructors

Constructor and Description
AuroraHostListProvider(java.lang.String driverProtocol, HostListProviderService hostListProviderService, java.util.Properties properties, java.lang.String originalUrl)
AuroraHostListProvider(java.lang.String driverProtocol, HostListProviderService hostListProviderService, java.util.Properties properties, java.lang.String originalUrl, ConnectionUrlParser connectionUrlParser)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear topology cache for the current cluster.
void	clearAll() Clear topology cache for all clusters.
java.util.List<HostSpec>	forceRefresh()
java.util.List<HostSpec>	forceRefresh(java.sql.Connection connection)
@Nullable java.util.List<HostSpec>	getCachedTopology() Get cached topology.
HostSpec	getHostByName(java.sql.Connection conn) Return the HostSpec object that is associated with a provided connection from the topology host list.
RdsUrlType	getRdsUrlType()
software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.FetchTopologyResult	getTopology(java.sql.Connection conn, boolean forceUpdate) Get cluster topology.
protected void	init()
boolean	isMultiWriterCluster() Check if cached topology belongs to multi-writer cluster.
static void	logCache()
protected software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo	queryForTopology(java.sql.Connection conn) Obtain a cluster topology from database.
java.util.List<HostSpec>	refresh()
java.util.List<HostSpec>	refresh(java.sql.Connection connection)
protected void	suggestPrimaryCluster(@NonNull software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo primaryClusterTopologyInfo)

Methods inherited from class java.lang.Object

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

Field Detail

CLUSTER_TOPOLOGY_REFRESH_RATE_MS

public static final AwsWrapperProperty CLUSTER_TOPOLOGY_REFRESH_RATE_MS

CLUSTER_ID

public static final AwsWrapperProperty CLUSTER_ID

CLUSTER_INSTANCE_HOST_PATTERN

public static final AwsWrapperProperty CLUSTER_INSTANCE_HOST_PATTERN

topologyCache

protected static final ExpiringCache<java.lang.String,software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo> topologyCache

clusterId

protected java.lang.String clusterId

clusterInstanceTemplate

protected HostSpec clusterInstanceTemplate

connectionUrlParser

protected ConnectionUrlParser connectionUrlParser

isPrimaryClusterId

protected boolean isPrimaryClusterId

isInitialized

protected boolean isInitialized

Constructor Detail

AuroraHostListProvider

public AuroraHostListProvider(java.lang.String driverProtocol,
                              HostListProviderService hostListProviderService,
                              java.util.Properties properties,
                              java.lang.String originalUrl)

AuroraHostListProvider

public AuroraHostListProvider(java.lang.String driverProtocol,
                              HostListProviderService hostListProviderService,
                              java.util.Properties properties,
                              java.lang.String originalUrl,
                              ConnectionUrlParser connectionUrlParser)

Method Detail

init

protected void init()
             throws java.sql.SQLException

Throws:

java.sql.SQLException

getTopology

public software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.FetchTopologyResult getTopology(java.sql.Connection conn,
                                                                                                    boolean forceUpdate)
                                                                                             throws java.sql.SQLException

Get cluster topology. It may require an extra call to database to fetch the latest topology. A cached copy of topology is returned if it's not yet outdated (controlled by refreshRateInMilliseconds).

Parameters:

conn - A connection to database to fetch the latest topology, if needed.

forceUpdate - If true, it forces a service to ignore cached copy of topology and to fetch a fresh one.

Returns:

a list of hosts that describes cluster topology. A writer is always at position 0. Returns an empty list if isn't available or is invalid (doesn't contain a writer).

Throws:

java.sql.SQLException - if errors occurred while retrieving the topology.

suggestPrimaryCluster

protected void suggestPrimaryCluster(@NonNull software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo primaryClusterTopologyInfo)

queryForTopology

protected software.amazon.jdbc.hostlistprovider.AuroraHostListProvider.ClusterTopologyInfo queryForTopology(java.sql.Connection conn)
                                                                                                     throws java.sql.SQLException

Obtain a cluster topology from database.

Parameters:

conn - A connection to database to fetch the latest topology.

Returns:

a ClusterTopologyInfo instance which contains details of the fetched topology

Throws:

java.sql.SQLException - if errors occurred while retrieving the topology.

getCachedTopology

public @Nullable java.util.List<HostSpec> getCachedTopology()

Get cached topology.

Returns:

list of hosts that represents topology. If there's no topology in the cache or the cached topology is outdated, it returns null.

isMultiWriterCluster

public boolean isMultiWriterCluster()

Check if cached topology belongs to multi-writer cluster.

Returns:

True, if it's multi-writer cluster.

getHostByName

public HostSpec getHostByName(java.sql.Connection conn)

Return the HostSpec object that is associated with a provided connection from the topology host list.

Parameters:

conn - A connection to database.

Returns:

The HostSpec object from the topology host list. Returns null if the connection host is not found in the latest topology.

clearAll

public void clearAll()

Clear topology cache for all clusters.

clear

public void clear()

Clear topology cache for the current cluster.

refresh

public java.util.List<HostSpec> refresh()
                                 throws java.sql.SQLException

Specified by:

refresh in interface HostListProvider

Throws:

java.sql.SQLException

refresh

public java.util.List<HostSpec> refresh(java.sql.Connection connection)
                                 throws java.sql.SQLException

Specified by:

refresh in interface HostListProvider

Throws:

java.sql.SQLException

forceRefresh

public java.util.List<HostSpec> forceRefresh()
                                      throws java.sql.SQLException

Specified by:

forceRefresh in interface HostListProvider

Throws:

java.sql.SQLException

forceRefresh

public java.util.List<HostSpec> forceRefresh(java.sql.Connection connection)
                                      throws java.sql.SQLException

Specified by:

forceRefresh in interface HostListProvider

Throws:

java.sql.SQLException

getRdsUrlType

public RdsUrlType getRdsUrlType()
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

logCache

public static void logCache()