org.nuxeo.ecm.directory

Class DirectoryCache

java.lang.Object

org.nuxeo.ecm.directory.DirectoryCache

public class DirectoryCache
extends Object

Very simple cache system to cache directory entry lookups (not search queries) on top of nuxeo cache

Beware that this cache is not transaction aware (which is not a problem for LDAP directories anyway).

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache	entryCache
protected String	entryCacheName
protected Cache	entryCacheWithoutReferences
protected String	entryCacheWithoutReferencesName
protected com.codahale.metrics.Counter	hitsCounter
protected com.codahale.metrics.Counter	invalidationsCounter
protected com.codahale.metrics.MetricRegistry	metrics
protected com.codahale.metrics.Counter	missesCounter
protected String	name
protected boolean	negativeCaching
protected com.codahale.metrics.Counter	negativeHitsCounter
protected com.codahale.metrics.Counter	sizeCounter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirectoryCache(String name)

Method Summary

Modifier and Type	Method and Description
protected CacheService	getCacheService()
DocumentModel	getEntry(String entryId, EntrySource source)
DocumentModel	getEntry(String entryId, EntrySource source, boolean fetchReferences)
Cache	getEntryCache()
Cache	getEntryCacheWithoutReferences()
void	invalidate(List<String> entryIds)
void	invalidate(String... entryIds)
void	invalidateAll()
protected boolean	isCacheEnabled()
void	setEntryCacheName(String entryCacheName)
void	setEntryCacheWithoutReferencesName(String entryCacheWithoutReferencesName)
void	setNegativeCaching(Boolean negativeCaching)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

entryCache

protected Cache entryCache

entryCacheName

protected String entryCacheName

entryCacheWithoutReferences

protected Cache entryCacheWithoutReferences

entryCacheWithoutReferencesName

protected String entryCacheWithoutReferencesName

negativeCaching

protected boolean negativeCaching

metrics

protected final com.codahale.metrics.MetricRegistry metrics

hitsCounter

protected final com.codahale.metrics.Counter hitsCounter

negativeHitsCounter

protected final com.codahale.metrics.Counter negativeHitsCounter

missesCounter

protected final com.codahale.metrics.Counter missesCounter

invalidationsCounter

protected final com.codahale.metrics.Counter invalidationsCounter

sizeCounter

protected final com.codahale.metrics.Counter sizeCounter

Constructor Detail

DirectoryCache

protected DirectoryCache(String name)

Method Detail

isCacheEnabled

protected boolean isCacheEnabled()

getEntry

public DocumentModel getEntry(String entryId,
                              EntrySource source)
                       throws DirectoryException

Throws:

DirectoryException

getEntry

public DocumentModel getEntry(String entryId,
                              EntrySource source,
                              boolean fetchReferences)
                       throws DirectoryException

Throws:

DirectoryException

invalidate

public void invalidate(List<String> entryIds)

invalidate

public void invalidate(String... entryIds)

invalidateAll

public void invalidateAll()

setEntryCacheName

public void setEntryCacheName(String entryCacheName)

setEntryCacheWithoutReferencesName

public void setEntryCacheWithoutReferencesName(String entryCacheWithoutReferencesName)

setNegativeCaching

public void setNegativeCaching(Boolean negativeCaching)

getEntryCache

public Cache getEntryCache()

getEntryCacheWithoutReferences

public Cache getEntryCacheWithoutReferences()

getCacheService

protected CacheService getCacheService()