software.amazon.jdbc.hostlistprovider

Class ConnectionStringHostListProvider

java.lang.Object

software.amazon.jdbc.hostlistprovider.ConnectionStringHostListProvider

All Implemented Interfaces:

HostListProvider, StaticHostListProvider

public class ConnectionStringHostListProvider
extends java.lang.Object
implements StaticHostListProvider

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	SINGLE_WRITER_CONNECTION_STRING

Constructor Summary

Constructors

Constructor and Description
ConnectionStringHostListProvider(@NonNull java.util.Properties properties, java.lang.String initialUrl, @NonNull HostListProviderService hostListProviderService)

Method Summary

Modifier and Type	Method and Description
java.util.List<HostSpec>	forceRefresh() Force a host list provider to update its topology information.
java.util.List<HostSpec>	forceRefresh(boolean verifyTopology, long timeoutMs) Force a host list provider to update its topology information.
java.lang.String	getClusterId()
java.util.List<HostSpec>	getCurrentTopology(java.sql.Connection conn, HostSpec initialHostSpec) Get current topology information for the connected database.
java.util.List<HostSpec>	refresh()
void	stopMonitor()

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_WRITER_CONNECTION_STRING

public static final AwsWrapperProperty SINGLE_WRITER_CONNECTION_STRING

Constructor Detail

ConnectionStringHostListProvider

public ConnectionStringHostListProvider(@NonNull java.util.Properties properties,
                                        java.lang.String initialUrl,
                                        @NonNull HostListProviderService hostListProviderService)

Method Detail

getCurrentTopology

public java.util.List<HostSpec> getCurrentTopology(java.sql.Connection conn,
                                                   HostSpec initialHostSpec)
                                            throws java.sql.SQLException

Description copied from interface: HostListProvider

Get current topology information for the connected database. The returned topology should be the static host list if `this` is a StaticHostListProvider. The returned topology should be fresh info returned from a topology query if `this` is a DynamicHostListProvider,

Specified by:

getCurrentTopology in interface HostListProvider

Parameters:

conn - the connection to use to query the database for topology information, if needed.

initialHostSpec - the host details of the initial connection.

Returns:

the topology information for the connected database.

Throws:

java.sql.SQLException - if an error occurs while attempting to acquire the database topology information.

refresh

public java.util.List<HostSpec> refresh()
                                 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

Description copied from interface: HostListProvider

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 default timeout is hit. It the caller needs topology from a verified writer or with a different timeout value, they should call HostListProvider.forceRefresh(boolean, long) instead.

Specified by:

forceRefresh in interface HostListProvider

Returns:

a list of host details representing a cluster topology

Throws:

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

forceRefresh

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

Description copied from interface: HostListProvider

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 HostListProvider

Parameters:

verifyTopology - defines whether extra measures should be taken to verify the topology. If false, the method will return as soon as topology is successfully retrieved from any instance. If true, extra steps are taken to verify the topology is accurate.

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 the cluster topology

Throws:

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

java.util.concurrent.TimeoutException - if the timeout is hit

getClusterId

public java.lang.String getClusterId()
                              throws java.lang.UnsupportedOperationException

Specified by:

getClusterId in interface HostListProvider

Throws:

java.lang.UnsupportedOperationException

stopMonitor

public void stopMonitor()

Specified by:

stopMonitor in interface HostListProvider