software.amazon.jdbc.plugin.cache

Class CacheConnection

java.lang.Object

software.amazon.jdbc.plugin.cache.CacheConnection

public class CacheConnection
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static AwsWrapperProperty	CACHE_CONNECTION_POOL_SIZE
protected static AwsWrapperProperty	CACHE_CONNECTION_TIMEOUT
protected static AwsWrapperProperty	CACHE_IAM_REGION
protected static AwsWrapperProperty	CACHE_KEY_PREFIX
protected static AwsWrapperProperty	CACHE_NAME
protected static AwsWrapperProperty	CACHE_PASSWORD
protected static AwsWrapperProperty	CACHE_RO_ENDPOINT_ADDR
static AwsWrapperProperty	CACHE_RW_ENDPOINT_ADDR
protected static AwsWrapperProperty	CACHE_TLS_CA_CERT_PATH
protected static AwsWrapperProperty	CACHE_USE_SSL
protected static AwsWrapperProperty	CACHE_USERNAME
protected static AwsWrapperProperty	FAIL_WHEN_CACHE_DOWN

Constructor Summary

Constructors

Constructor and Description
CacheConnection(java.util.Properties properties, @Nullable TelemetryFactory telemetryFactory, @Nullable FullServicesContainer servicesContainer)

Method Summary

Modifier and Type	Method and Description
protected glide.api.models.configuration.BaseClientConfiguration	buildClientConfiguration(java.lang.String hostname, int port, java.lang.Boolean isRead) Builds Glide client configuration using instance fields.
protected static glide.api.models.configuration.BaseClientConfiguration	buildClientConfigurationStatic(java.lang.String hostname, int port, boolean useSSL, java.time.Duration connectionTimeout, boolean iamAuthEnabled, @Nullable java.lang.String cacheIamRegion, @Nullable java.lang.String cacheName, @Nullable java.lang.String cacheUsername, @Nullable java.lang.String cachePassword, java.lang.Boolean isRead, @Nullable java.lang.Boolean isClusterMode, byte[] caCert) Builds Glide client configuration for standalone or cluster mode.
static void	clearEndpointPoolRegistry()
protected void	decrementInFlightSize(long writeSize)
protected CacheMonitor.HealthState	getClusterHealthStateFromCacheMonitor()
protected void	handleCompletedCacheWrite(glide.api.BaseClient client, long writeSize, java.lang.Throwable ex)
protected void	incrementInFlightSize(long writeSize)
byte[]	readFromCache(java.lang.String key)
protected void	reportErrorToCacheMonitor(boolean isWrite, java.lang.Throwable error, java.lang.String operation)
protected void	setClusterMode(boolean clusterMode)
protected void	setConnectionPools(org.apache.commons.pool2.impl.GenericObjectPool<glide.api.BaseClient> readPool, org.apache.commons.pool2.impl.GenericObjectPool<glide.api.BaseClient> writePool)
protected boolean	shouldProceedWithOperation(CacheMonitor.HealthState state)
java.lang.String	toString()
protected void	triggerPoolInit(boolean isRead)
void	writeToCache(java.lang.String key, byte[] value, int expiry)

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_RW_ENDPOINT_ADDR

public static final AwsWrapperProperty CACHE_RW_ENDPOINT_ADDR

CACHE_RO_ENDPOINT_ADDR

protected static final AwsWrapperProperty CACHE_RO_ENDPOINT_ADDR

CACHE_USE_SSL

protected static final AwsWrapperProperty CACHE_USE_SSL

CACHE_TLS_CA_CERT_PATH

protected static final AwsWrapperProperty CACHE_TLS_CA_CERT_PATH

CACHE_IAM_REGION

protected static final AwsWrapperProperty CACHE_IAM_REGION

CACHE_USERNAME

protected static final AwsWrapperProperty CACHE_USERNAME

CACHE_PASSWORD

protected static final AwsWrapperProperty CACHE_PASSWORD

CACHE_NAME

protected static final AwsWrapperProperty CACHE_NAME

CACHE_CONNECTION_TIMEOUT

protected static final AwsWrapperProperty CACHE_CONNECTION_TIMEOUT

CACHE_CONNECTION_POOL_SIZE

protected static final AwsWrapperProperty CACHE_CONNECTION_POOL_SIZE

FAIL_WHEN_CACHE_DOWN

protected static final AwsWrapperProperty FAIL_WHEN_CACHE_DOWN

CACHE_KEY_PREFIX

protected static final AwsWrapperProperty CACHE_KEY_PREFIX

Constructor Detail

CacheConnection

public CacheConnection(java.util.Properties properties,
                       @Nullable TelemetryFactory telemetryFactory,
                       @Nullable FullServicesContainer servicesContainer)

Method Detail

buildClientConfiguration

protected glide.api.models.configuration.BaseClientConfiguration buildClientConfiguration(java.lang.String hostname,
                                                                                          int port,
                                                                                          java.lang.Boolean isRead)

Builds Glide client configuration using instance fields. Delegates to static method for actual configuration building.

Parameters:

hostname - the cache server hostname

port - the cache server port

isRead - true for read-only replica connections, false for primary connections

Returns:

the configured BaseClientConfiguration

buildClientConfigurationStatic

protected static glide.api.models.configuration.BaseClientConfiguration buildClientConfigurationStatic(java.lang.String hostname,
                                                                                                       int port,
                                                                                                       boolean useSSL,
                                                                                                       java.time.Duration connectionTimeout,
                                                                                                       boolean iamAuthEnabled,
                                                                                                       @Nullable java.lang.String cacheIamRegion,
                                                                                                       @Nullable java.lang.String cacheName,
                                                                                                       @Nullable java.lang.String cacheUsername,
                                                                                                       @Nullable java.lang.String cachePassword,
                                                                                                       java.lang.Boolean isRead,
                                                                                                       @Nullable java.lang.Boolean isClusterMode,
                                                                                                       byte[] caCert)

Builds Glide client configuration for standalone or cluster mode. Returns GlideClientConfiguration for standalone or GlideClusterClientConfiguration for cluster mode.

Parameters:

hostname - the cache server hostname

port - the cache server port

useSSL - whether to use TLS for the connection

connectionTimeout - the connection timeout duration

iamAuthEnabled - whether IAM authentication is enabled

cacheIamRegion - the AWS region for IAM authentication

cacheName - the cache name for IAM authentication

cacheUsername - the username for cache authentication

cachePassword - the password for cache authentication

isRead - true for read-only replica connections, false for primary connections

isClusterMode - true for cluster mode (CME), false for standalone mode (CMD)

caCert - the CA certificate bytes for TLS, or null

Returns:

BaseClientConfiguration configured for the specified mode

readFromCache

public byte[] readFromCache(java.lang.String key)
                     throws java.sql.SQLException

Throws:

java.sql.SQLException

handleCompletedCacheWrite

protected void handleCompletedCacheWrite(glide.api.BaseClient client,
                                         long writeSize,
                                         java.lang.Throwable ex)

writeToCache

public void writeToCache(java.lang.String key,
                         byte[] value,
                         int expiry)

getClusterHealthStateFromCacheMonitor

protected CacheMonitor.HealthState getClusterHealthStateFromCacheMonitor()

reportErrorToCacheMonitor

protected void reportErrorToCacheMonitor(boolean isWrite,
                                         java.lang.Throwable error,
                                         java.lang.String operation)

incrementInFlightSize

protected void incrementInFlightSize(long writeSize)

decrementInFlightSize

protected void decrementInFlightSize(long writeSize)

shouldProceedWithOperation

protected boolean shouldProceedWithOperation(CacheMonitor.HealthState state)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setConnectionPools

protected void setConnectionPools(org.apache.commons.pool2.impl.GenericObjectPool<glide.api.BaseClient> readPool,
                                  org.apache.commons.pool2.impl.GenericObjectPool<glide.api.BaseClient> writePool)

triggerPoolInit

protected void triggerPoolInit(boolean isRead)

setClusterMode

protected void setClusterMode(boolean clusterMode)

clearEndpointPoolRegistry

public static void clearEndpointPoolRegistry()