Package org.opencms.loader.imagecache

Class CmsS3ImageCacheMaintenance

java.lang.Object

org.opencms.loader.imagecache.CmsS3ImageCacheMaintenance

All Implemented Interfaces:

I_CmsImageCacheMaintenance

public class CmsS3ImageCacheMaintenance
extends Object
implements I_CmsImageCacheMaintenance

Maintenance adapter for the S3 image cache.

Constructor Summary

Constructors

Constructor	Description
CmsS3ImageCacheMaintenance(CmsS3ImageCache cache)	Creates a maintenance adapter.
CmsS3ImageCacheMaintenance(CmsS3ImageCache cache, int deleteBatchSize, int deleteConcurrency)	Creates a maintenance adapter.
CmsS3ImageCacheMaintenance(CmsS3ImageCache cache, int deleteBatchSize, int deleteConcurrency, int copyConcurrency, int maxCopiesPerSecond, int renewalQueueCapacity)	Creates a maintenance adapter.

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.
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.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsS3ImageCacheMaintenance

public CmsS3ImageCacheMaintenance(CmsS3ImageCache cache)

Creates a maintenance adapter.

Parameters:

cache - the S3 cache

CmsS3ImageCacheMaintenance

public CmsS3ImageCacheMaintenance(CmsS3ImageCache cache,
 int deleteBatchSize,
 int deleteConcurrency)

Creates a maintenance adapter.

Parameters:

cache - the S3 cache

deleteBatchSize - the maximum number of keys per delete request

deleteConcurrency - the number of concurrent delete requests

CmsS3ImageCacheMaintenance

public CmsS3ImageCacheMaintenance(CmsS3ImageCache cache,
 int deleteBatchSize,
 int deleteConcurrency,
 int copyConcurrency,
 int maxCopiesPerSecond,
 int renewalQueueCapacity)

Creates a maintenance adapter.

Parameters:

cache - the S3 cache

deleteBatchSize - the maximum number of keys per delete request

deleteConcurrency - the number of concurrent delete requests

copyConcurrency - the number of concurrent copy requests

maxCopiesPerSecond - the maximum number of copy requests started per second

renewalQueueCapacity - the maximum number of waiting renewal tasks

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

Parameters:

request - the request

Returns:

the maintenance result

Throws:

Exception - if the request can not be completed

See Also:

• I_CmsImageCacheMaintenance.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

Returns:

the backend identifier

See Also:

• I_CmsImageCacheMaintenance.getBackendId()

getCapabilities

public CmsImageCacheCapabilities getCapabilities()

Description copied from interface: I_CmsImageCacheMaintenance

Returns the backend capabilities.

Specified by:

getCapabilities in interface I_CmsImageCacheMaintenance

Returns:

the backend capabilities

See Also:

• I_CmsImageCacheMaintenance.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

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

Parameters:

visitor - the entry visitor

Throws:

Exception - if listing fails

See Also:

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