software.amazon.jdbc.plugin.customendpoint

Class CustomEndpointMonitorImpl

java.lang.Object

software.amazon.jdbc.plugin.customendpoint.CustomEndpointMonitorImpl

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable, CustomEndpointMonitor

public class CustomEndpointMonitorImpl
extends java.lang.Object
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 java.util.concurrent.ExecutorService	monitorExecutor
protected PluginService	pluginService
protected software.amazon.awssdk.services.rds.RdsClient	rdsClient
protected long	refreshRateNano
protected software.amazon.awssdk.regions.Region	region
protected java.util.concurrent.atomic.AtomicBoolean	stop

Constructor Summary

Constructors

Constructor and Description

CustomEndpointMonitorImpl(PluginService pluginService, 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() Stops the custom endpoint monitor.
boolean	hasCustomEndpointInfo() Indicates whether the monitor has info about the custom endpoint or not.
void	run() Analyzes a given custom endpoint for changes to custom endpoint information.
boolean	shouldDispose() Evaluates whether the monitor should be disposed.

Methods inherited from class java.lang.Object

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

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

stop

protected final java.util.concurrent.atomic.AtomicBoolean stop

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 final long refreshRateNano

pluginService

protected final PluginService pluginService

monitorExecutor

protected final java.util.concurrent.ExecutorService monitorExecutor

Constructor Detail

CustomEndpointMonitorImpl

public CustomEndpointMonitorImpl(PluginService pluginService,
                                 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:

pluginService - The plugin service to use to update the set of allowed/blocked hosts according to the custom endpoint info.

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

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

run

public void run()

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

Specified by:

run in interface java.lang.Runnable

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.

shouldDispose

public boolean shouldDispose()

Description copied from interface: CustomEndpointMonitor

Evaluates whether the monitor should be disposed.

Specified by:

shouldDispose in interface CustomEndpointMonitor

Returns:

true if the monitor should be disposed, otherwise return false.

close

public void close()

Stops the custom endpoint monitor.

Specified by:

close in interface java.lang.AutoCloseable

clearCache

public static void clearCache()

Clears the shared custom endpoint information cache.