software.amazon.jdbc.hostlistprovider.monitoring

Class MonitoringRdsHostListProvider

java.lang.Object

software.amazon.jdbc.hostlistprovider.RdsHostListProvider

software.amazon.jdbc.hostlistprovider.monitoring.MonitoringRdsHostListProvider

All Implemented Interfaces:

BlockingHostListProvider, CanReleaseResources, HostListProvider, DynamicHostListProvider

Direct Known Subclasses:

MonitoringRdsMultiAzHostListProvider

public class MonitoringRdsHostListProvider
extends RdsHostListProvider
implements BlockingHostListProvider, CanReleaseResources

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jdbc.hostlistprovider.RdsHostListProvider

RdsHostListProvider.ClusterSuggestedResult, RdsHostListProvider.FetchTopologyResult

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS
protected long	highRefreshRateNano
protected PluginService	pluginService
protected FullServicesContainer	servicesContainer
protected java.lang.String	writerTopologyQuery

Fields inherited from class software.amazon.jdbc.hostlistprovider.RdsHostListProvider

CLUSTER_ID, CLUSTER_INSTANCE_HOST_PATTERN, CLUSTER_TOPOLOGY_REFRESH_RATE_MS, clusterId, clusterInstanceTemplate, connectionUrlParser, defaultTopologyQueryTimeoutMs, hostList, hostListProviderService, initialHostList, initialHostSpec, isInitialized, isPrimaryClusterId, isReaderQuery, lock, networkTimeoutExecutor, nodeIdQuery, originalUrl, primaryClusterIdCache, properties, rdsHelper, rdsUrlType, refreshRateNano, suggestedClusterIdRefreshRateNano, suggestedPrimaryClusterIdCache, topologyQuery

Constructor Summary

Constructors

Constructor and Description
MonitoringRdsHostListProvider(java.util.Properties properties, java.lang.String originalUrl, FullServicesContainer servicesContainer, java.lang.String topologyQuery, java.lang.String nodeIdQuery, java.lang.String isReaderQuery, java.lang.String writerTopologyQuery)

Method Summary

Modifier and Type	Method and Description
static void	clearCache()
protected void	clusterIdChanged(java.lang.String oldClusterId)
java.util.List<HostSpec>	forceRefresh(boolean shouldVerifyWriter, long timeoutMs) Force a host list provider to update its topology information.
protected void	init()
protected ClusterTopologyMonitor	initMonitor()
protected java.util.List<HostSpec>	queryForTopology(java.sql.Connection conn) Obtain a cluster topology from database.
void	releaseResources() An object that implements this interface should release all acquired resources assuming it may be disposed at any time.

Methods inherited from class software.amazon.jdbc.hostlistprovider.RdsHostListProvider

clear, clearAll, createHost, createHost, forceRefresh, forceRefresh, getClusterId, getHostEndpoint, getHostRole, getRdsUrlType, getStoredTopology, getSuggestedClusterId, getTopology, identifyConnection, refresh, refresh, suggestPrimaryCluster

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jdbc.HostListProvider

forceRefresh, forceRefresh, getClusterId, getHostRole, identifyConnection, refresh, refresh

Field Detail

CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS

public static final AwsWrapperProperty CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS

servicesContainer

protected final FullServicesContainer servicesContainer

pluginService

protected final PluginService pluginService

highRefreshRateNano

protected final long highRefreshRateNano

writerTopologyQuery

protected final java.lang.String writerTopologyQuery

Constructor Detail

MonitoringRdsHostListProvider

public MonitoringRdsHostListProvider(java.util.Properties properties,
                                     java.lang.String originalUrl,
                                     FullServicesContainer servicesContainer,
                                     java.lang.String topologyQuery,
                                     java.lang.String nodeIdQuery,
                                     java.lang.String isReaderQuery,
                                     java.lang.String writerTopologyQuery)

Method Detail

clearCache

public static void clearCache()

init

protected void init()
             throws java.sql.SQLException

Overrides:

init in class RdsHostListProvider

Throws:

java.sql.SQLException

initMonitor

protected ClusterTopologyMonitor initMonitor()
                                      throws java.sql.SQLException

Throws:

java.sql.SQLException

queryForTopology

protected java.util.List<HostSpec> queryForTopology(java.sql.Connection conn)
                                             throws java.sql.SQLException

Description copied from class: RdsHostListProvider

Obtain a cluster topology from database.

Overrides:

queryForTopology in class RdsHostListProvider

Parameters:

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

Returns:

a list of HostSpec objects representing the topology

Throws:

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

clusterIdChanged

protected void clusterIdChanged(java.lang.String oldClusterId)
                         throws java.sql.SQLException

Overrides:

clusterIdChanged in class RdsHostListProvider

Throws:

java.sql.SQLException

forceRefresh

public java.util.List<HostSpec> forceRefresh(boolean shouldVerifyWriter,
                                             long timeoutMs)
                                      throws java.sql.SQLException,
                                             java.util.concurrent.TimeoutException

Description copied from interface: BlockingHostListProvider

Force a host list provider to update its topology information. Results will be returned when the topology is updated or the writer is verified, unless the timeout is hit.

Specified by:

forceRefresh in interface BlockingHostListProvider

Parameters:

shouldVerifyWriter - a flag indicating that the provider should verify the writer before returning the updated topology.

timeoutMs - timeout in msec to wait until topology is updated or the writer is verified. If a timeout of 0 is provided, a topology update will be initiated but cached topology will be returned. If a non-zero timeout is provided and the timeout is hit, a TimeoutException will be thrown.

Returns:

a list of host details representing a cluster topology

Throws:

java.sql.SQLException - if there's errors updating topology

java.util.concurrent.TimeoutException - if topology update takes longer time than expected

releaseResources

public void releaseResources()

Description copied from interface: CanReleaseResources

An object that implements this interface should release all acquired resources assuming it may be disposed at any time. This method may be called more than once.

Calling this method does NOT mean that an object is disposing and there won't be any further calls. An object should keep its functional state after calling this method.

Specified by:

releaseResources in interface CanReleaseResources