software.amazon.jdbc.plugin.customendpoint

Class CustomEndpointMonitorImpl

java.lang.Object

software.amazon.jdbc.util.monitoring.AbstractMonitor

software.amazon.jdbc.plugin.customendpoint.CustomEndpointMonitorImpl

All Implemented Interfaces:

java.lang.Runnable, CustomEndpointMonitor, Monitor

public class CustomEndpointMonitorImpl
extends AbstractMonitor
implements CustomEndpointMonitor

The default custom endpoint monitor implementation. This class uses a background thread to monitor a given custom endpoint for custom endpoint information and future changes to the custom endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	CUSTOM_ENDPOINT_INFO_EXPIRATION_NANO
protected HostSpec	customEndpointHostSpec
protected static CacheMap<java.lang.String,CustomEndpointInfo>	customEndpointInfoCache
protected java.lang.String	endpointIdentifier
protected static long	MONITOR_TERMINATION_TIMEOUT_SEC
protected software.amazon.awssdk.services.rds.RdsClient	rdsClient
protected long	refreshRateNano
protected software.amazon.awssdk.regions.Region	region
protected StorageService	storageService
protected static long	UNAUTHORIZED_SLEEP_SEC

Fields inherited from class software.amazon.jdbc.util.monitoring.AbstractMonitor

lastActivityTimestampNanos, monitorExecutor, state, stop, terminationTimeoutSec

Constructor Summary

Constructors

Constructor and Description

CustomEndpointMonitorImpl(StorageService storageService, TelemetryFactory telemetryFactory, HostSpec customEndpointHostSpec, java.lang.String endpointIdentifier, software.amazon.awssdk.regions.Region region, long refreshRateNano, java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient> rdsClientFunc) Constructs a CustomEndpointMonitorImpl instance for the host specified by customEndpointHostSpec.

Method Summary

Modifier and Type	Method and Description
static void	clearCache() Clears the shared custom endpoint information cache.
void	close() Closes all resources used by this monitor.
boolean	hasCustomEndpointInfo() Indicates whether the monitor has info about the custom endpoint or not.
void	monitor() Analyzes a given custom endpoint for changes to custom endpoint information.

Methods inherited from class software.amazon.jdbc.util.monitoring.AbstractMonitor

canDispose, getLastActivityTimestampNanos, getState, run, start, stop

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.util.monitoring.Monitor

canDispose, getLastActivityTimestampNanos, getState, start, stop

Field Detail

customEndpointInfoCache

protected static final CacheMap<java.lang.String,CustomEndpointInfo> customEndpointInfoCache

CUSTOM_ENDPOINT_INFO_EXPIRATION_NANO

protected static final long CUSTOM_ENDPOINT_INFO_EXPIRATION_NANO

UNAUTHORIZED_SLEEP_SEC

protected static final long UNAUTHORIZED_SLEEP_SEC

MONITOR_TERMINATION_TIMEOUT_SEC

protected static final long MONITOR_TERMINATION_TIMEOUT_SEC

See Also:

Constant Field Values

rdsClient

protected final software.amazon.awssdk.services.rds.RdsClient rdsClient

customEndpointHostSpec

protected final HostSpec customEndpointHostSpec

endpointIdentifier

protected final java.lang.String endpointIdentifier

region

protected final software.amazon.awssdk.regions.Region region

refreshRateNano

protected long refreshRateNano

storageService

protected final StorageService storageService

Constructor Detail

CustomEndpointMonitorImpl

public CustomEndpointMonitorImpl(StorageService storageService,
                                 TelemetryFactory telemetryFactory,
                                 HostSpec customEndpointHostSpec,
                                 java.lang.String endpointIdentifier,
                                 software.amazon.awssdk.regions.Region region,
                                 long refreshRateNano,
                                 java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient> rdsClientFunc)

Constructs a CustomEndpointMonitorImpl instance for the host specified by customEndpointHostSpec.

Parameters:

storageService - The storage service used to store the set of allowed/blocked hosts according to the custom endpoint info.

telemetryFactory - The telemetry factory used to create telemetry data.

customEndpointHostSpec - The host information for the custom endpoint to be monitored.

endpointIdentifier - An endpoint identifier.

region - The region of the custom endpoint to be monitored.

refreshRateNano - Controls how often the custom endpoint information should be fetched and analyzed for changes. The value specified should be in nanoseconds.

rdsClientFunc - The function to call to create the RDS client that will fetch custom endpoint information.

Method Detail

monitor

public void monitor()

Analyzes a given custom endpoint for changes to custom endpoint information.

Specified by:

monitor in interface Monitor

hasCustomEndpointInfo

public boolean hasCustomEndpointInfo()

Description copied from interface: CustomEndpointMonitor

Indicates whether the monitor has info about the custom endpoint or not. This will be false if the monitor is new and has not yet had enough time to fetch the info.

Specified by:

hasCustomEndpointInfo in interface CustomEndpointMonitor

Returns:

true if the monitor has info about the custom endpoint, otherwise returns false.

close

public void close()

Description copied from interface: Monitor

Closes all resources used by this monitor. This method will be called as part of Monitor.stop().

Specified by:

close in interface Monitor

Overrides:

close in class AbstractMonitor

clearCache

public static void clearCache()

Clears the shared custom endpoint information cache.