Package software.amazon.awssdk.util

Class ResponseMetadataCache

java.lang.Object

software.amazon.awssdk.util.ResponseMetadataCache

All Implemented Interfaces:

MetadataCache

public class ResponseMetadataCache
extends Object
implements MetadataCache

Cache of response metadata for recently executed requests for diagnostic purposes. This cache has a max size and as entries are added, the oldest entry is aged out once the max size has been reached.

Constructor Summary

Constructors

Constructor	Description
ResponseMetadataCache(int maxEntries)	Creates a new cache that will contain, at most the specified number of entries.

Method Summary

Modifier and Type	Method	Description
void	add(Object obj, ResponseMetadata metadata)	Adds a new entry to this cache, possibly evicting the oldest entry if the cache is at its size limit.
ResponseMetadata	get(Object obj)	Returns the response metadata associated with the specified object, or null if no metadata is associated with that object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseMetadataCache

public ResponseMetadataCache(int maxEntries)

Creates a new cache that will contain, at most the specified number of entries.

Parameters:

maxEntries - The maximum size of this cache.

Method Detail

add

public void add(Object obj,
                ResponseMetadata metadata)

Description copied from interface: MetadataCache

Adds a new entry to this cache, possibly evicting the oldest entry if the cache is at its size limit.

Specified by:

add in interface MetadataCache

Parameters:

obj - The key by which to store the metadata.

metadata - The metadata for this entry.

get

public ResponseMetadata get(Object obj)

Description copied from interface: MetadataCache

Returns the response metadata associated with the specified object, or null if no metadata is associated with that object.

Specified by:

get in interface MetadataCache

Parameters:

obj - The key by which the desired metadata is stored.

Returns:

The response metadata associated with the given object key, otherwise null if no metadata is associated with that object.