software.amazon.jdbc

Interface HostListProvider

All Known Subinterfaces:

BlockingHostListProvider, DynamicHostListProvider, StaticHostListProvider

All Known Implementing Classes:

AuroraHostListProvider, ConnectionStringHostListProvider, MonitoringRdsHostListProvider, MonitoringRdsMultiAzHostListProvider, RdsHostListProvider, RdsMultiAzDbClusterListProvider

public interface HostListProvider

Method Summary

Modifier and Type	Method and Description
java.util.List<HostSpec>	forceRefresh()
java.util.List<HostSpec>	forceRefresh(java.sql.Connection connection)
java.lang.String	getClusterId()
HostRole	getHostRole(java.sql.Connection connection) Evaluates the host role of the given connection - either a writer or a reader.
HostSpec	identifyConnection(java.sql.Connection connection)
java.util.List<HostSpec>	refresh()
java.util.List<HostSpec>	refresh(java.sql.Connection connection)

Method Detail

refresh

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

Throws:

java.sql.SQLException

refresh

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

Throws:

java.sql.SQLException

forceRefresh

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

Throws:

java.sql.SQLException

forceRefresh

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

Throws:

java.sql.SQLException

getHostRole

HostRole getHostRole(java.sql.Connection connection)
              throws java.sql.SQLException

Evaluates the host role of the given connection - either a writer or a reader.

Parameters:

connection - a connection to the database instance whose role should be determined

Returns:

the role of the given connection - either a writer or a reader

Throws:

java.sql.SQLException - if there is a problem executing or processing the SQL query used to determine the host role

identifyConnection

HostSpec identifyConnection(java.sql.Connection connection)
                     throws java.sql.SQLException

Throws:

java.sql.SQLException

getClusterId

java.lang.String getClusterId()
                       throws java.lang.UnsupportedOperationException,
                              java.sql.SQLException

Throws:

java.lang.UnsupportedOperationException

java.sql.SQLException