com.amazonaws.secretsmanager.caching.cache

Class SecretCacheObject<T>

java.lang.Object

com.amazonaws.secretsmanager.caching.cache.SecretCacheObject<T>

Direct Known Subclasses:

SecretCacheItem, SecretCacheVersion

public abstract class SecretCacheObject<T>
extends Object

Basic secret caching object.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.amazonaws.services.secretsmanager.AWSSecretsManager	client The AWS Secrets Manager client to use for requesting secrets.
protected SecretCacheConfiguration	config The Secret Cache Configuration.
protected RuntimeException	exception If the last request to AWS Secrets Manager resulted in an exception, that exception will be thrown back to the caller when requesting secret data.
protected Object	lock A private object to synchronize access to certain methods.
protected String	secretId The secret identifier for this cached object.

Constructor Summary

Constructors

Constructor and Description
SecretCacheObject(String secretId, com.amazonaws.services.secretsmanager.AWSSecretsManager client, SecretCacheConfiguration config) Construct a new cached item for the secret.

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(Object obj)
protected abstract T	executeRefresh() Execute the actual refresh of the cached secret state.
com.amazonaws.services.secretsmanager.model.GetSecretValueResult	getSecretValue() Return the cached result from AWS Secrets Manager for GetSecretValue.
protected abstract com.amazonaws.services.secretsmanager.model.GetSecretValueResult	getSecretValue(T result) Execute the actual refresh of the cached secret state.
abstract int	hashCode()
protected boolean	isRefreshNeeded() Determine if the secret object should be refreshed.
boolean	refreshNow() Method to force the refresh of a cached secret state.
abstract String	toString()
protected <T extends com.amazonaws.AmazonWebServiceRequest> T	updateUserAgent(T request)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

secretId

protected final String secretId

The secret identifier for this cached object.

lock

protected final Object lock

A private object to synchronize access to certain methods.

client

protected final com.amazonaws.services.secretsmanager.AWSSecretsManager client

The AWS Secrets Manager client to use for requesting secrets.

config

protected final SecretCacheConfiguration config

The Secret Cache Configuration.

exception

protected RuntimeException exception

If the last request to AWS Secrets Manager resulted in an exception, that exception will be thrown back to the caller when requesting secret data.

Constructor Detail

SecretCacheObject

public SecretCacheObject(String secretId,
                         com.amazonaws.services.secretsmanager.AWSSecretsManager client,
                         SecretCacheConfiguration config)

Construct a new cached item for the secret.

Parameters:

secretId - The secret identifier. This identifier could be the full ARN or the friendly name for the secret.

client - The AWS Secrets Manager client to use for requesting the secret.

config - The secret cache configuration.

Method Detail

executeRefresh

protected abstract T executeRefresh()

Execute the actual refresh of the cached secret state.

Returns:

The result of the refresh

getSecretValue

protected abstract com.amazonaws.services.secretsmanager.model.GetSecretValueResult getSecretValue(T result)

Execute the actual refresh of the cached secret state.

Parameters:

result - The AWS Secrets Manager result for the secret state.

Returns:

The cached GetSecretValue result based on the current cached state.

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

toString

public abstract String toString()

Overrides:

toString in class Object

updateUserAgent

protected <T extends com.amazonaws.AmazonWebServiceRequest> T updateUserAgent(T request)

isRefreshNeeded

protected boolean isRefreshNeeded()

Determine if the secret object should be refreshed.

Returns:

True if the secret item should be refreshed.

refreshNow

public boolean refreshNow()
                   throws InterruptedException

Method to force the refresh of a cached secret state.

Returns:

True if the refresh completed without error.

Throws:

InterruptedException - If the thread is interrupted while waiting for the refresh.

getSecretValue

public com.amazonaws.services.secretsmanager.model.GetSecretValueResult getSecretValue()

Return the cached result from AWS Secrets Manager for GetSecretValue.

Returns:

The cached GetSecretValue result.