Package org.opencms.loader.imagecache

Class CmsImageCacheMaintenanceService

java.lang.Object

org.opencms.loader.imagecache.CmsImageCacheMaintenanceService

public final class CmsImageCacheMaintenanceService
extends Object

Capability-aware entry point for image cache maintenance clients.

Constructor Summary

Constructors

Constructor	Description
CmsImageCacheMaintenanceService(I_CmsImageCacheMaintenance backend)	Creates a maintenance service.

Method Summary

Modifier and Type	Method	Description
static CmsImageCacheMaintenanceService	create(I_CmsImageCache cache)	Creates a service for an image cache implementation.
static CmsImageCacheMaintenanceService	create(I_CmsImageCache cache, CmsImageCacheConfiguration configuration)	Creates a service using the central image cache maintenance configuration.
static CmsImageCacheMaintenanceService	createForConfiguredCache()	Creates a service for the image cache currently configured in the image loader.
static CmsImageCacheMaintenanceService	createForRfsRepository(String repositoryPath)	Creates a service for the classic RFS image cache repository.
CmsImageCacheMaintenanceResult	execute(CmsImageCacheMaintenanceRequest request)	Executes a maintenance request after checking backend capabilities.
String	getBackendId()	Returns the backend identifier.
CmsImageCacheCapabilities	getCapabilities()	Returns the backend capabilities.
CmsImageCacheEntry	getEntry(String key)	Loads metadata for one cache entry.
void	visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)	Streams all cache entries.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsImageCacheMaintenanceService

public CmsImageCacheMaintenanceService(I_CmsImageCacheMaintenance backend)

Creates a maintenance service.

Parameters:

backend - the maintenance backend

Method Details

create

public static CmsImageCacheMaintenanceService create(I_CmsImageCache cache)

Creates a service for an image cache implementation.

Parameters:

cache - the image cache

Returns:

the maintenance service

create

public static CmsImageCacheMaintenanceService create(I_CmsImageCache cache,
 CmsImageCacheConfiguration configuration)

Creates a service using the central image cache maintenance configuration.

Parameters:

cache - the image cache

configuration - the image cache configuration

Returns:

the maintenance service

createForConfiguredCache

public static CmsImageCacheMaintenanceService createForConfiguredCache()
                                                                throws Exception

Creates a service for the image cache currently configured in the image loader.

Returns:

the maintenance service

Throws:

Exception - if the configured cache can not be accessed

createForRfsRepository

public static CmsImageCacheMaintenanceService createForRfsRepository(String repositoryPath)
                                                              throws Exception

Creates a service for the classic RFS image cache repository.

Parameters:

repositoryPath - the repository path

Returns:

the maintenance service

Throws:

Exception - if the repository can not be initialized

execute

public CmsImageCacheMaintenanceResult execute(CmsImageCacheMaintenanceRequest request)
                                       throws Exception

Executes a maintenance request after checking backend capabilities.

Parameters:

request - the request

Returns:

the result

Throws:

Exception - if execution fails

getBackendId

public String getBackendId()

Returns the backend identifier.

getCapabilities

public CmsImageCacheCapabilities getCapabilities()

Returns the backend capabilities.

getEntry

public CmsImageCacheEntry getEntry(String key)
                            throws Exception

Loads metadata for one 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

public void visitEntries(I_CmsImageCacheMaintenanceEntryVisitor visitor)
                  throws Exception

Streams all cache entries.

Parameters:

visitor - the visitor

Throws:

Exception - if listing fails