org.flowable.ldap

Class LDAPGroupCache

java.lang.Object

org.flowable.ldap.LDAPGroupCache

public class LDAPGroupCache
extends Object

Simple cache for groups a user belongs to, which avoid hitting the LDAP system too much. Groups are fetched internally by the engine for example when doing queries, eg when fetching tasks for a candidateUser. Configured through the LDAPConfiguration. Cached entries have an expiration time. For example when set to one hour, changes to the ldap system around the groups of a user will be visible after that hour. Experimental: can have a listener for cache events, and instance of LDAPGroupCache.LDAPGroupCacheListener.

Author:

Joram Barrez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LDAPGroupCache.LDAPGroupCacheListener

Field Summary

Fields

Modifier and Type	Field and Description
protected long	expirationTime
protected Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry>	groupCache
protected LDAPGroupCache.LDAPGroupCacheListener	ldapCacheListener

Constructor Summary

Constructors

Constructor and Description
LDAPGroupCache(int cacheSize, long expirationTime, org.flowable.common.engine.impl.runtime.ClockReader clockReader)
LDAPGroupCache(int cacheSize, long expirationTime, Supplier<org.flowable.common.engine.impl.runtime.ClockReader> clockReader)

Method Summary

Modifier and Type	Method and Description
void	add(String userId, List<Group> groups)
void	clear()
List<Group>	get(String userId)
long	getExpirationTime()
Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry>	getGroupCache()
LDAPGroupCache.LDAPGroupCacheListener	getLdapCacheListener()
void	setExpirationTime(long expirationTime)
void	setGroupCache(Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry> groupCache)
void	setLdapCacheListener(LDAPGroupCache.LDAPGroupCacheListener ldapCacheListener)

Methods inherited from class java.lang.Object

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

Field Detail

groupCache

protected Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry> groupCache

expirationTime

protected long expirationTime

ldapCacheListener

protected LDAPGroupCache.LDAPGroupCacheListener ldapCacheListener

Constructor Detail

LDAPGroupCache

public LDAPGroupCache(int cacheSize,
                      long expirationTime,
                      org.flowable.common.engine.impl.runtime.ClockReader clockReader)

LDAPGroupCache

public LDAPGroupCache(int cacheSize,
                      long expirationTime,
                      Supplier<org.flowable.common.engine.impl.runtime.ClockReader> clockReader)

Method Detail

add

public void add(String userId,
                List<Group> groups)

get

public List<Group> get(String userId)

clear

public void clear()

getGroupCache

public Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry> getGroupCache()

setGroupCache

public void setGroupCache(Map<String,org.flowable.ldap.LDAPGroupCache.LDAPGroupCacheEntry> groupCache)

getExpirationTime

public long getExpirationTime()

setExpirationTime

public void setExpirationTime(long expirationTime)

getLdapCacheListener

public LDAPGroupCache.LDAPGroupCacheListener getLdapCacheListener()

setLdapCacheListener

public void setLdapCacheListener(LDAPGroupCache.LDAPGroupCacheListener ldapCacheListener)