com.sdl.context.image.api.admin

Class ContextualImageDeliveryAdministrator

java.lang.Object

com.sdl.context.image.api.admin.ContextualImageDeliveryAdministrator

All Implemented Interfaces:

TransformationCacheAdministrator

@Component
public class ContextualImageDeliveryAdministrator
extends Object
implements TransformationCacheAdministrator

The Contextual Image Delivery Administrator is used for administration actions on the Contextual Image Delivery module.

You can obtain the Contextual Image Delivery (CID) Administrator using the getInstance() method.

For example, to remove all cache entries:

 
 ContextualImageDeliveryAdministrator.getInstance().remove();
 
 

To get the number of items in the in-memory cache:

 
 long inMemoryCacheSize = ContextualImageDeliveryAdministrator.getInstance().getStatistics().getLocalHeapSize();
 
 

Constructor Summary

Constructors

Constructor and Description
ContextualImageDeliveryAdministrator()

Method Summary

Modifier and Type	Method and Description
static ContextualImageDeliveryAdministrator	getInstance() Get the Contextual Image Delivery (CID) Administrator.
CacheStatistics	getStatistics() Gets the cache statistics for the underlying cache.
void	remove(String uriRegexAsString) Remove transformations which were generated from sources URLs matching the given string as a regex.
void	removeAll() Remove all the items inside the transformation caches completely.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextualImageDeliveryAdministrator

public ContextualImageDeliveryAdministrator()

Method Detail

getInstance

public static ContextualImageDeliveryAdministrator getInstance()

Get the Contextual Image Delivery (CID) Administrator.

Returns:

the Contextual Image Delivery (CID) Administrator

removeAll

public void removeAll()

Remove all the items inside the transformation caches completely.

Specified by:

removeAll in interface TransformationCacheAdministrator

remove

public void remove(String uriRegexAsString)

Remove transformations which were generated from sources URLs matching the given string as a regex.

Specified by:

remove in interface TransformationCacheAdministrator

getStatistics

public CacheStatistics getStatistics()

Gets the cache statistics for the underlying cache.

Specified by:

getStatistics in interface TransformationCacheAdministrator

Returns:

the cache statistics