com.amazonaws.secretsmanager.caching.cache

Class SecretCacheItem

java.lang.Object

com.amazonaws.secretsmanager.caching.cache.SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

com.amazonaws.secretsmanager.caching.cache.SecretCacheItem

public class SecretCacheItem
extends SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

The cached secret item which contains information from the DescribeSecret request to AWS Secrets Manager along with any associated GetSecretValue results.

Field Summary

Fields inherited from class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject

client, config, exception, lock, secretId

Constructor Summary

Constructors

Constructor and Description
SecretCacheItem(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
boolean	equals(Object obj)
protected com.amazonaws.services.secretsmanager.model.DescribeSecretResult	executeRefresh() Execute the logic to perform the actual refresh of the item.
protected com.amazonaws.services.secretsmanager.model.GetSecretValueResult	getSecretValue(com.amazonaws.services.secretsmanager.model.DescribeSecretResult describeResult) Return the cached result from AWS Secrets Manager for GetSecretValue.
int	hashCode()
protected boolean	isRefreshNeeded() Determine if the secret object should be refreshed.
String	toString()

Methods inherited from class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject

getSecretValue, refreshNow, updateUserAgent

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretCacheItem

public SecretCacheItem(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 - Cache configuration.

Method Detail

equals

public boolean equals(Object obj)

Specified by:

equals in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

hashCode

public int hashCode()

Specified by:

hashCode in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

toString

public String toString()

Specified by:

toString in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

isRefreshNeeded

protected boolean isRefreshNeeded()

Determine if the secret object should be refreshed. This method extends the base class functionality to check if a refresh is needed based on the configured TTL for the item.

Overrides:

isRefreshNeeded in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

Returns:

True if the secret item should be refreshed.

executeRefresh

protected com.amazonaws.services.secretsmanager.model.DescribeSecretResult executeRefresh()

Execute the logic to perform the actual refresh of the item.

Specified by:

executeRefresh in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

Returns:

The result from AWS Secrets Manager for the refresh.

getSecretValue

protected com.amazonaws.services.secretsmanager.model.GetSecretValueResult getSecretValue(com.amazonaws.services.secretsmanager.model.DescribeSecretResult describeResult)

Return the cached result from AWS Secrets Manager for GetSecretValue.

Specified by:

getSecretValue in class SecretCacheObject<com.amazonaws.services.secretsmanager.model.DescribeSecretResult>

Parameters:

describeResult - The result of the Describe Secret request to AWS Secrets Manager.

Returns:

The cached GetSecretValue result.