software.amazon.jdbc

Interface BlockingHostListProvider

All Superinterfaces:

HostListProvider

All Known Implementing Classes:

MonitoringRdsHostListProvider, MonitoringRdsMultiAzHostListProvider

public interface BlockingHostListProvider
extends HostListProvider

Method Summary

Modifier and Type	Method and Description
java.util.List<HostSpec>	forceRefresh(boolean shouldVerifyWriter, long timeoutMs) Force a host list provider to update its topology information.

Methods inherited from interface software.amazon.jdbc.HostListProvider

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

Method Detail

forceRefresh

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

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.

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