Class ChronicleMapCache

java.lang.Object

se.liu.ida.hefquin.federation.access.impl.cache.CacheLayer<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry>

se.liu.ida.hefquin.federation.access.impl.cache.chroniclemap.ChronicleMapCache

All Implemented Interfaces:

AutoCloseable, Cache<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>>

public class ChronicleMapCache
extends CacheLayer<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry>

Persistent cache backed by a ChronicleMap.

This class is thread-safe for concurrent access through its public methods on a single ChronicleMapCache instance. All access is guarded by synchronization on map.

Cache entry creation, invalidation, and replacement behavior are delegated to the configured cache policies.

The cache enforces a maximum capacity. If the persisted map contains more entries than allowed when opened, entries are evicted according to the configured replacement policy until the capacity constraint is satisfied.

Caveats:

Thread safety is provided only at the level of this cache instance. If two ChronicleMapCache objects point to the same persisted file, this class does not coordinate:

• replacement policy state
• capacity enforcement
• invalidation/eviction decisions

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_CAPACITY
protected static final String	DEFAULT_FILENAME

Fields inherited from class se.liu.ida.hefquin.federation.access.impl.cache.CacheLayer

capacity, entryFactory, invalidationPolicy, lock, map, replacementPolicy

Constructor Summary

Constructors

Constructor	Description
ChronicleMapCache(int capacity, String filename, CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)	Creates a cache with the given capacity and file path.
ChronicleMapCache(int capacity, CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)	Creates a cache with the given capacity and the default file path.
ChronicleMapCache(String filename, CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)	Constructs a new ChronicleMapCache with a custom file path and the default cache capacity.
ChronicleMapCache(CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)	Creates a cache with the default capacity and default file path.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying ChronicleMap and releases associated resources.
protected static Map<PersistentCacheKey,PersistentCacheEntry>	createChronicleMap(String filename, int capacity)
protected static File	ensureParentDirectoryExists(String filename)	Ensures that the parent directory of the given file path exists.

Methods inherited from class se.liu.ida.hefquin.federation.access.impl.cache.CacheLayer

clear, evict, evict, get, isEmpty, put

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CAPACITY

protected static final int DEFAULT_CAPACITY

See Also:

• Constant Field Values

DEFAULT_FILENAME

protected static final String DEFAULT_FILENAME

See Also:

• Constant Field Values

Constructor Details

ChronicleMapCache

public ChronicleMapCache(CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)
                  throws IOException

Creates a cache with the default capacity and default file path.

Parameters:

policies - the cache policies to use

Throws:

IOException - if the cache file cannot be created or opened

ChronicleMapCache

public ChronicleMapCache(int capacity,
 CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)
                  throws IOException

Creates a cache with the given capacity and the default file path.

Parameters:

capacity - the maximum number of cache entries

policies - the cache policies to use

Throws:

IOException - if the cache file cannot be created or opened

ChronicleMapCache

public ChronicleMapCache(String filename,
 CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)
                  throws IOException

Constructs a new ChronicleMapCache with a custom file path and the default cache capacity.

Parameters:

filename - the path to the cache file

policies - the cache policies to use

Throws:

IOException - if the cache file cannot be created or opened

ChronicleMapCache

public ChronicleMapCache(int capacity,
 String filename,
 CachePolicies<PersistentCacheKey,CompletableFuture<? extends DataRetrievalResponse<?>>,PersistentCacheEntry> policies)
                  throws IOException

Creates a cache with the given capacity and file path.

If the persisted map already contains entries, the replacement policy is initialized accordingly and eviction is performed if necessary to satisfy the capacity constraint.

Parameters:

capacity - the maximum number of cache entries

filename - the path to the cache file

policies - the cache policies to use

Throws:

IOException - if the cache file cannot be created or opened

Method Details

ensureParentDirectoryExists

protected static File ensureParentDirectoryExists(String filename)

Ensures that the parent directory of the given file path exists.

Parameters:

filename - the path to the file

Returns:

a File object for the given path

Throws:

IllegalStateException - if the parent directory does not exist and cannot be created

createChronicleMap

protected static Map<PersistentCacheKey,PersistentCacheEntry> createChronicleMap(String filename,
 int capacity)
                                                                          throws IOException

Throws:

IOException

close

public void close()

Closes the underlying ChronicleMap and releases associated resources.

Closing the map is not required but ensures that all data is properly flushed to disk and that off-heap resources are released.