Class CacheFacade

java.lang.Object

is.galia.cache.CacheFacade

public final class CacheFacade
extends Object

Simplified interface to the caching architecture.

Constructor Summary

Constructors

Constructor	Description
CacheFacade()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up all active caches.
void	evict(Identifier identifier)	Evicts all cached items associated with a source image from all caches.
void	evict(OperationList opList)	Evicts the given variant image from the variant cache.
void	evictAsync(Identifier identifier)	Invokes evict(Identifier) asynchronously.
void	evictInfos()	Purges all infos from the InfoCache and HeapInfoCache.
void	evictInvalid()	Purges all invalid content from all caches.
Optional<Info>	fetchInfo(Identifier identifier)	Returns the Info of the source image corresponding to the given identifier.
Optional<Info>	fetchOrReadInfo(Identifier identifier, Format format, Decoder decoder)	Returns the Info of the source image corresponding to the given identifier.
Optional<HeapInfoCache>	getHeapInfoCache()
long	getHeapInfoCacheSize()
Optional<InfoCache>	getInfoCache()
Optional<VariantCache>	getVariantCache()
boolean	isHeapInfoCacheEnabled()
boolean	isInfoCacheEnabled()
boolean	isVariantCacheEnabled()
InputStream	newVariantImageInputStream(OperationList opList)
InputStream	newVariantImageInputStream(OperationList opList, StatResult statResult)
CompletableOutputStream	newVariantImageOutputStream(OperationList opList)
void	purge()	Purges all information from all caches.

Methods inherited from class java.lang.Object

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

Constructor Details

CacheFacade

public CacheFacade()

Method Details

cleanUp

public void cleanUp()
             throws IOException

Cleans up all active caches.

Throws:

IOException

See Also:

• Cache.cleanUp()

evict

public void evict(Identifier identifier)
           throws IOException

Evicts all cached items associated with a source image from all caches.

Throws:

IOException

See Also:

• Cache.evict(Identifier)

evict

public void evict(OperationList opList)
           throws IOException

Evicts the given variant image from the variant cache.

Throws:

IOException

See Also:

• VariantCache.evict(OperationList)

evictAsync

public void evictAsync(Identifier identifier)

Invokes evict(Identifier) asynchronously.

evictInfos

public void evictInfos()
                throws IOException

Purges all infos from the InfoCache and HeapInfoCache.

Throws:

IOException

See Also:

• InfoCache.evictInfos()

evictInvalid

public void evictInvalid()
                  throws IOException

Purges all invalid content from all caches.

Throws:

IOException

See Also:

• Cache.evictInvalid()

fetchInfo

public Optional<Info> fetchInfo(Identifier identifier)
                         throws IOException

Returns the Info of the source image corresponding to the given identifier.

The following caches are consulted in order of preference:

1. The HeapInfoCache, if enabled by the Key.HEAP_INFO_CACHE_ENABLED configuration key
2. The instance returned by CacheFactory.getInfoCache()

If an info exists in a cache but is corrupt, the error is swallowed and logged and an empty instance is returned.

Parameters:

identifier - Identifier of the source image for which to retrieve the info.

Returns:

Info for the image with the given identifier.

Throws:

IOException - If there is an error reading or writing to or from the cache.

See Also:

• fetchOrReadInfo(Identifier, Format, Decoder)

fetchOrReadInfo

public Optional<Info> fetchOrReadInfo(Identifier identifier,
 Format format,
 Decoder decoder)
                               throws IOException

Returns the Info of the source image corresponding to the given identifier.

The following sources are consulted in order of preference:

1. The HeapInfoCache, if enabled by the Key.HEAP_INFO_CACHE_ENABLED configuration key;
2. The instance returned by CacheFactory.getInfoCache();
3. The given processor. If this is the case, it will also be cached in whichever of the above caches are available. (This may happen asynchronously.)

If an info exists in a cache but is corrupt, the error is swallowed and logged.

Parameters:

identifier - Identifier of the source image for which to retrieve the info.

format - Source image format.

decoder - Instance to use to read the info if necessary.

Returns:

Info for the image with the given identifier.

Throws:

IOException - if there is an error reading or writing to or from the cache.

See Also:

• fetchInfo(Identifier)

getHeapInfoCache

public Optional<HeapInfoCache> getHeapInfoCache()

Returns:

The HeapInfoCache, if it is enabled.

getHeapInfoCacheSize

public long getHeapInfoCacheSize()

Returns:

Number of instances contained in the HeapInfoCache, if enabled, or else 0.

getInfoCache

public Optional<InfoCache> getInfoCache()

Returns:

The active InfoCache, if one is enabled.

See Also:

• CacheFactory.getInfoCache()

getVariantCache

public Optional<VariantCache> getVariantCache()

Returns:

The active VariantCache, if one is enabled.

See Also:

• CacheFactory.getVariantCache()

isHeapInfoCacheEnabled

public boolean isHeapInfoCacheEnabled()

isInfoCacheEnabled

public boolean isInfoCacheEnabled()

isVariantCacheEnabled

public boolean isVariantCacheEnabled()

newVariantImageInputStream

public InputStream newVariantImageInputStream(OperationList opList)
                                       throws IOException

Throws:

IOException

See Also:

• VariantCache.newVariantImageInputStream(OperationList)

newVariantImageInputStream

public InputStream newVariantImageInputStream(OperationList opList,
 StatResult statResult)
                                       throws IOException

Throws:

IOException

See Also:

• VariantCache.newVariantImageInputStream(OperationList, StatResult)

newVariantImageOutputStream

public CompletableOutputStream newVariantImageOutputStream(OperationList opList)
                                                    throws IOException

Throws:

IOException

See Also:

• VariantCache.newVariantImageOutputStream(OperationList)

purge

public void purge()
           throws IOException

Purges all information from all caches.

Throws:

IOException

See Also:

• Cache.purge()