org.nuxeo.ecm.core.cache

Class CacheServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.cache.CacheServiceImpl

All Implemented Interfaces:

CacheService, Adaptable, Component, Extensible, TimestampedService

public class CacheServiceImpl
extends DefaultComponent
implements CacheService

Cache service implementation to manage nuxeo cache

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CacheServiceImpl.AbstractCachePubSubInvalidator
protected static class	CacheServiceImpl.CacheDescriptorRegistry
protected static class	CacheServiceImpl.CacheInvalidation
protected class	CacheServiceImpl.CachePubSubInvalidator

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_INVAL_PUBSUB_TOPIC
protected Map<String,CacheManagement>	caches Currently registered caches.
static String	CLUSTERING_ENABLED_PROP Framework property defining whether clustering is enabled.
static String	DEFAULT_CACHE_ID
protected CacheServiceImpl.CachePubSubInvalidator	invalidator
static ComponentName	NAME
static String	NODE_ID_PROP Framework property containing the node id.
protected static Random	RANDOM
protected CacheServiceImpl.CacheDescriptorRegistry	registry

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Constructor Summary

Constructors

Constructor and Description
CacheServiceImpl()

Method Summary

Modifier and Type	Method and Description
int	getApplicationStartedOrder() The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).
Cache	getCache(String name) Gets the cache with the given name.
CacheDescriptor	getCacheDescriptor(String descriptor)
protected void	maybeStart(String name)
void	registerCache(String name) Programmatically registers a cache with the given name, with the the size and the timeout given by the default cache.
void	registerCache(String name, int maxSize, int timeout) Deprecated.
void	registerCacheDescriptor(CacheDescriptor descriptor)
void	registerContribution(Object contrib, String extensionPoint, ComponentInstance contributor)
void	start(ComponentContext context) Start the component.
protected void	startCacheDescriptor(CacheDescriptor desc) Creates and starts the cache.
void	stop(ComponentContext context) Stop the component.
void	unregisterCacheDescriptor(CacheDescriptor descriptor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, deactivate, getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted

Field Detail

NAME

public static final ComponentName NAME

RANDOM

protected static final Random RANDOM

DEFAULT_CACHE_ID

public static final String DEFAULT_CACHE_ID

Since:

8.2

See Also:

Constant Field Values

CACHE_INVAL_PUBSUB_TOPIC

public static final String CACHE_INVAL_PUBSUB_TOPIC

Since:

9.3

See Also:

Constant Field Values

CLUSTERING_ENABLED_PROP

public static final String CLUSTERING_ENABLED_PROP

Framework property defining whether clustering is enabled.

Since:

9.3

See Also:

Constant Field Values

NODE_ID_PROP

public static final String NODE_ID_PROP

Framework property containing the node id.

Since:

9.3

See Also:

Constant Field Values

registry

protected final CacheServiceImpl.CacheDescriptorRegistry registry

caches

protected final Map<String,CacheManagement> caches

Currently registered caches.

invalidator

protected CacheServiceImpl.CachePubSubInvalidator invalidator

Constructor Detail

CacheServiceImpl

public CacheServiceImpl()

Method Detail

registerContribution

public void registerContribution(Object contrib,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

registerCache

@Deprecated
public void registerCache(String name,
                                      int maxSize,
                                      int timeout)

Deprecated.

Description copied from interface: CacheService

Programmatically registers a cache with the given characteristics.

Specified by:

registerCache in interface CacheService

Parameters:

name - the cache name

maxSize - the maximum number of elements

timeout - the entry timeout (in minutes)

registerCache

public void registerCache(String name)

Description copied from interface: CacheService

Programmatically registers a cache with the given name, with the the size and the timeout given by the default cache.

Specified by:

registerCache in interface CacheService

Parameters:

name - the cache name

registerCacheDescriptor

public void registerCacheDescriptor(CacheDescriptor descriptor)

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

unregisterCacheDescriptor

public void unregisterCacheDescriptor(CacheDescriptor descriptor)

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

startCacheDescriptor

protected void startCacheDescriptor(CacheDescriptor desc)

Creates and starts the cache.

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

maybeStart

protected void maybeStart(String name)

getCache

public Cache getCache(String name)

Description copied from interface: CacheService

Gets the cache with the given name.

Specified by:

getCache in interface CacheService

Parameters:

name - the cache name

Returns:

the cache, or null if it does not exist

getCacheDescriptor

public CacheDescriptor getCacheDescriptor(String descriptor)

Since:

9.3