Package org.opencms.loader.imagecache

Class CmsFsImageCacheMaintenance

java.lang.Object

org.opencms.loader.imagecache.CmsRfsImageCacheMaintenance

org.opencms.loader.imagecache.CmsFsImageCacheMaintenance

All Implemented Interfaces:

I_CmsImageCacheMaintenance

public class CmsFsImageCacheMaintenance
extends CmsRfsImageCacheMaintenance

Maintenance adapter for the shared file system image cache.

Constructor Summary

Constructors

Constructor	Description
CmsFsImageCacheMaintenance(CmsFsImageCache cache)	Creates a maintenance adapter.
CmsFsImageCacheMaintenance(CmsFsImageCache cache, boolean touchEnabled, int touchConcurrency)	Creates a maintenance adapter.

Method Summary

Modifier and Type	Method	Description
protected void	afterDelete(String key)	Called after an entry has been deleted.
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.
CmsImageCacheEntry	getEntry(String key)	Loads metadata for a single image cache entry.
protected void	removeEmptyDirectories()	Shared-FS deletes deliberately leave empty directories in place.
void	visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)	Streams all image cache entries to a visitor.

Methods inherited from class org.opencms.loader.imagecache.CmsRfsImageCacheMaintenance

getRepository, toPath

Methods inherited from class java.lang.Object

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

Constructor Details

CmsFsImageCacheMaintenance

public CmsFsImageCacheMaintenance(CmsFsImageCache cache)

Creates a maintenance adapter.

Parameters:

cache - the shared file system cache

CmsFsImageCacheMaintenance

public CmsFsImageCacheMaintenance(CmsFsImageCache cache,
 boolean touchEnabled,
 int touchConcurrency)

Creates a maintenance adapter.

Parameters:

cache - the shared file system cache

touchEnabled - whether touching cache entries is enabled

touchConcurrency - the maximum number of concurrent touch operations

Method Details

execute

public CmsImageCacheMaintenanceResult execute(CmsImageCacheMaintenanceRequest request)
                                       throws Exception

Description copied from interface: I_CmsImageCacheMaintenance

Executes a maintenance request.

Specified by:

execute in interface I_CmsImageCacheMaintenance

Overrides:

execute in class CmsRfsImageCacheMaintenance

Parameters:

request - the request

Returns:

the maintenance result

Throws:

Exception - if the request can not be completed

See Also:

• CmsRfsImageCacheMaintenance.execute(org.opencms.loader.imagecache.CmsImageCacheMaintenanceRequest)

getBackendId

public String getBackendId()

Description copied from interface: I_CmsImageCacheMaintenance

Returns the backend identifier used for diagnostics and metrics.

Specified by:

getBackendId in interface I_CmsImageCacheMaintenance

Overrides:

getBackendId in class CmsRfsImageCacheMaintenance

Returns:

the backend identifier

See Also:

• CmsRfsImageCacheMaintenance.getBackendId()

getCapabilities

public CmsImageCacheCapabilities getCapabilities()

Description copied from interface: I_CmsImageCacheMaintenance

Returns the backend capabilities.

Specified by:

getCapabilities in interface I_CmsImageCacheMaintenance

Overrides:

getCapabilities in class CmsRfsImageCacheMaintenance

Returns:

the backend capabilities

See Also:

• CmsRfsImageCacheMaintenance.getCapabilities()

getEntry

public CmsImageCacheEntry getEntry(String key)
                            throws Exception

Description copied from interface: I_CmsImageCacheMaintenance

Loads metadata for a single image cache entry.

Specified by:

getEntry in interface I_CmsImageCacheMaintenance

Overrides:

getEntry in class CmsRfsImageCacheMaintenance

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

See Also:

• I_CmsImageCacheMaintenance.getEntry(java.lang.String)

visitEntries

public void visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)
                  throws Exception

Description copied from interface: I_CmsImageCacheMaintenance

Streams all image cache entries to a visitor.

Specified by:

visitEntries in interface I_CmsImageCacheMaintenance

Overrides:

visitEntries in class CmsRfsImageCacheMaintenance

Parameters:

visitor - the entry visitor

Throws:

Exception - if listing fails

See Also:

• CmsRfsImageCacheMaintenance.visitEntries(org.opencms.loader.imagecache.I_CmsImageCacheMaintenanceEntryVisitor)

afterDelete

protected void afterDelete(String key)
                    throws Exception

Description copied from class: CmsRfsImageCacheMaintenance

Called after an entry has been deleted.

Overrides:

afterDelete in class CmsRfsImageCacheMaintenance

Parameters:

key - the deleted cache key

Throws:

Exception - if post-processing fails

See Also:

• CmsRfsImageCacheMaintenance.afterDelete(java.lang.String)

removeEmptyDirectories

protected void removeEmptyDirectories()

Shared-FS deletes deliberately leave empty directories in place.

Traversing the complete shared repository after every delete request would turn deletion of one image into a full NFS metadata scan. The directories are harmless and are removed by a complete cache clear.

Overrides:

removeEmptyDirectories in class CmsRfsImageCacheMaintenance