com.eibus.directory.soap

Class Cache

java.lang.Object

com.eibus.directory.soap.Cache

public class Cache
extends java.lang.Object

The Cache is used by a Proxy for improved LDAP caching. This cache will be updated automatically by the LDAP service (i.e., the LDAP SOAP Node) if an update on the LDAP server has happened through a SOAP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cache.CacheListeners Wraps all the operations related to management of all types of CacheListeners
static class	Cache.OptimizedComparator Optimized search uses a sorted tree map on dn.

Field Summary

Fields

Modifier and Type	Field and Description
protected LDAPSearchCache	cacheSearch All lock handling is synchronized on this cache object.
protected boolean	cacheupdate Register for cache listeners
protected LDAPConnection	connection Holds jldap connection object
protected LDAPSearchConstraints	constraints
protected LDAPControl	ldapWrapper
protected IEventOccurrenceCounter	m_accessDenied
protected IEventOccurrenceCounter	m_lookupCounter
protected IEventOccurrenceCounter	m_removeCounter Statistics of LDAP Directory cache
protected int	numFlushes
static int	USE_LDAP_CONNECTION
static int	USE_LDAP_SOAPPROCESSOR Constant variables for setting context for LDAP Cache Key
static int	USE_MULTI_CAST_SOCKET

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the cache.
void	close() Stop all activities for this cache instance, e.g.
void	createManagedComponent(IManagedComponent parentComponent)
IEventOccurrenceCounter	getAccessDeniedCounter() Get a event occurrence Counter for this LDAP Directory.
static java.util.Comparator<LDAPCacheKey>	getComparator()
java.lang.String	getLDAPSOAPNodeDN()
IManagedComponent	getManagedComponent() Get a managed component for this LDAP Directory/
int	getNumFlushes()
int	getNumHits()
int	getNumMisses()
int	getSize()
int	getTotalOperations() statstics for LDAP Cache
void	normalRemove(java.lang.String dnString, java.util.Map<java.lang.String,java.lang.String> metadata)
void	optimizedRemove(java.lang.String dnString, java.util.Map<java.lang.String,java.lang.String> metadata)
void	refillBootstrapInformationFromFile()
void	registerCacheListener(CacheListener listener) A CacheListener is notified of changes in the cache.
void	registerCacheListener(CacheListenerWithMetadata listener) A CacheListenerWithMetadata is notified of changes in the cache.
void	remove(java.lang.String dnString, java.util.Map<java.lang.String,java.lang.String> metadata) Removes all search results from the cache in which extent the specified DN falls.
void	removeCacheListener(CacheListener listener) Removes the Cache Listener from the pool
void	removeCacheListener(CacheListenerWithMetadata listener) Removes the Cache Listener from the pool
void	removeSearch(java.lang.String dn, int scope, java.lang.String filter, java.lang.String[] attributes, boolean returnValues) Removes the results of the search from the cache.
void	returnCookieConnection(java.lang.String cookie) Release LDAP Connection with cookie argument
void	setMaxCacheSize(long cacheMaxSize) For JMX
void	setMaxIdleTime(long cacheIdleTime) For JMX
protected void	startCacheUpdater() Start listening for ldap 'dirty' messages, and remove effected dn's from the cache.
protected void	stopCacheUpdater()

Methods inherited from class java.lang.Object

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

Field Detail

USE_LDAP_SOAPPROCESSOR

public static final int USE_LDAP_SOAPPROCESSOR

Constant variables for setting context for LDAP Cache Key

See Also:

Constant Field Values

USE_LDAP_CONNECTION

public static final int USE_LDAP_CONNECTION

See Also:

Constant Field Values

USE_MULTI_CAST_SOCKET

public static final int USE_MULTI_CAST_SOCKET

See Also:

Constant Field Values

numFlushes

protected int numFlushes

cacheSearch

protected final LDAPSearchCache cacheSearch

All lock handling is synchronized on this cache object.

cacheupdate

protected boolean cacheupdate

Register for cache listeners

connection

protected LDAPConnection connection

Holds jldap connection object

constraints

protected LDAPSearchConstraints constraints

m_removeCounter

protected IEventOccurrenceCounter m_removeCounter

Statistics of LDAP Directory cache

m_lookupCounter

protected IEventOccurrenceCounter m_lookupCounter

ldapWrapper

protected LDAPControl ldapWrapper

m_accessDenied

protected IEventOccurrenceCounter m_accessDenied

Method Detail

createManagedComponent

public void createManagedComponent(IManagedComponent parentComponent)

setMaxCacheSize

public void setMaxCacheSize(long cacheMaxSize)

For JMX

Parameters:

cacheSize - maximum cache size set by the user.

setMaxIdleTime

public void setMaxIdleTime(long cacheIdleTime)

For JMX

Parameters:

cacheSize - maximum idle time for a cache item set by the user.

getManagedComponent

public IManagedComponent getManagedComponent()

Get a managed component for this LDAP Directory/

getAccessDeniedCounter

public IEventOccurrenceCounter getAccessDeniedCounter()

Get a event occurrence Counter for this LDAP Directory.

Returns:

registerCacheListener

public void registerCacheListener(CacheListener listener)

A CacheListener is notified of changes in the cache.

Parameters:

listener - CacheListener that listens for the changes in Cache

removeCacheListener

public void removeCacheListener(CacheListener listener)

Removes the Cache Listener from the pool

Parameters:

listener - listener that is to be removed

registerCacheListener

public void registerCacheListener(CacheListenerWithMetadata listener)

A CacheListenerWithMetadata is notified of changes in the cache.

Parameters:

listener -

removeCacheListener

public void removeCacheListener(CacheListenerWithMetadata listener)

Removes the Cache Listener from the pool

Parameters:

listener -

getTotalOperations

public int getTotalOperations()

statstics for LDAP Cache

Returns:

number of search operations from ldap directory object

getNumHits

public int getNumHits()

getNumMisses

public int getNumMisses()

Returns:

the number of misses

getNumFlushes

public int getNumFlushes()

getSize

public int getSize()

Returns:

the current size of the cache.

startCacheUpdater

protected void startCacheUpdater()

Start listening for ldap 'dirty' messages, and remove effected dn's from the cache.

stopCacheUpdater

protected void stopCacheUpdater()

returnCookieConnection

public void returnCookieConnection(java.lang.String cookie)

Release LDAP Connection with cookie argument

Parameters:

cookie -

clear

public void clear()

Clears the cache. All cached results will be removed.

removeSearch

public void removeSearch(java.lang.String dn,
                         int scope,
                         java.lang.String filter,
                         java.lang.String[] attributes,
                         boolean returnValues)

Removes the results of the search from the cache.

Parameters:

dn,filter - and scope

remove

public void remove(java.lang.String dnString,
                   java.util.Map<java.lang.String,java.lang.String> metadata)

Removes all search results from the cache in which extent the specified DN falls. The registered listeners are provided the much needed metadata

Parameters:

dnString - the invalidated DN

metadata - the metadata of the removed entry whic is passed to the listeners

optimizedRemove

public void optimizedRemove(java.lang.String dnString,
                            java.util.Map<java.lang.String,java.lang.String> metadata)

getComparator

public static java.util.Comparator<LDAPCacheKey> getComparator()

normalRemove

public void normalRemove(java.lang.String dnString,
                         java.util.Map<java.lang.String,java.lang.String> metadata)

close

public void close()

Stop all activities for this cache instance, e.g. listening for updates.

getLDAPSOAPNodeDN

public java.lang.String getLDAPSOAPNodeDN()

Returns:

Returns the ldapSOAPNodeDN.

refillBootstrapInformationFromFile

public void refillBootstrapInformationFromFile()