Package org.opencms.loader.imagecache

Interface I_CmsImageCacheMaintenance

All Known Implementing Classes:

CmsFsImageCacheMaintenance, CmsRfsImageCacheMaintenance, CmsS3ImageCacheMaintenance

public interface I_CmsImageCacheMaintenance

Backend SPI for image cache maintenance.

Method Summary

Modifier and Type	Method	Description
CmsImageCacheMaintenanceResult	execute(CmsImageCacheMaintenanceRequest request)	Executes a maintenance request.
String	getBackendId()	Returns the backend identifier used for diagnostics and metrics.
CmsImageCacheCapabilities	getCapabilities()	Returns the backend capabilities.
default CmsImageCacheEntry	getEntry(String key)	Loads metadata for a single image cache entry.
void	visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)	Streams all image cache entries to a visitor.

Method Details

execute

CmsImageCacheMaintenanceResult execute(CmsImageCacheMaintenanceRequest request)
                                throws Exception

Executes a maintenance request.

Parameters:

request - the request

Returns:

the maintenance result

Throws:

Exception - if the request can not be completed

getBackendId

String getBackendId()

Returns the backend identifier used for diagnostics and metrics.

Returns:

the backend identifier

getCapabilities

CmsImageCacheCapabilities getCapabilities()

Returns the backend capabilities.

Returns:

the backend capabilities

getEntry

default CmsImageCacheEntry getEntry(String key)
                             throws Exception

Loads metadata for a single image cache entry.

Parameters:

key - the image cache key

Returns:

the entry metadata, or null if the entry does not exist

Throws:

Exception - if the metadata can not be loaded

visitEntries

void visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)
           throws Exception

Streams all image cache entries to a visitor.

Parameters:

visitor - the entry visitor

Throws:

Exception - if listing fails