Package de.aservo.ldap.adapter.backend

Class CachedWithPersistenceDirectoryBackend

java.lang.Object

de.aservo.ldap.adapter.backend.ProxyDirectoryBackend

de.aservo.ldap.adapter.backend.CachedDirectoryBackend

de.aservo.ldap.adapter.backend.CachedWithPersistenceDirectoryBackend

All Implemented Interfaces:

DirectoryBackend, NestedDirectoryBackend

public class CachedWithPersistenceDirectoryBackend
extends CachedDirectoryBackend

A proxy for directory backends to cache entities via SQL based persistence strategy.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_APPLY_NATIVE_SQL	The constant CONFIG_APPLY_NATIVE_SQL.
static String	CONFIG_DB_DRIVER	The constant CONFIG_DB_DRIVER.
static String	CONFIG_DB_ISO_LEVEL	The constant CONFIG_DB_ISO_LEVEL.
static String	CONFIG_DB_MAX_IDLE	The constant CONFIG_DB_MAX_IDLE.
static String	CONFIG_DB_MAX_OPEN_STMT	The constant CONFIG_DB_MAX_OPEN_STMT.
static String	CONFIG_DB_MAX_TOTAL	The constant CONFIG_DB_MAX_TOTAL.
static String	CONFIG_DB_MIN_IDLE	The constant CONFIG_DB_MIN_IDLE.
static String	CONFIG_DB_PW	The constant CONFIG_DB_PW.
static String	CONFIG_DB_URL	The constant CONFIG_DB_URL.
static String	CONFIG_DB_USER	The constant CONFIG_DB_USER.
static String	CONFIG_PASS_ACTIVE_USERS_ONLY	The constant CONFIG_PASS_ACTIVE_USERS_ONLY.
static String	CONFIG_TRANSACTION_TIMEOUT	The constant CONFIG_TRANSACTION_TIMEOUT.
static String	CONFIG_USE_MATERIALIZED_VIEWS	The constant CONFIG_USE_MATERIALIZED_VIEWS.

Fields inherited from class de.aservo.ldap.adapter.backend.ProxyDirectoryBackend

config, directoryBackend

Constructor Summary

Constructors

Constructor	Description
CachedWithPersistenceDirectoryBackend(ServerConfiguration config, NestedDirectoryBackend directoryBackend)	Instantiates a new directory backend.

Method Summary

Modifier and Type	Method	Description
void	dropAllGroups()	To reset the cache all group entities are dropped.
void	dropAllUsers()	To reset the cache all user entities are dropped.
void	dropGroup(String id)	To keep the cache up-to-date a group entity is dropped.
void	dropMembership(MembershipEntity membership)	To keep the cache up-to-date a membership entity is dropped.
void	dropUser(String id)	To keep the cache up-to-date an user entity is dropped.
Set<GroupEntity>	getAllGroups()	Gets all groups.
Set<UserEntity>	getAllUsers()	Gets all users.
Set<GroupEntity>	getDirectChildGroupsOfGroup(String id)	Gets direct child groups of group.
Set<GroupEntity>	getDirectGroupsOfUser(String id)	Gets direct groups of user.
Set<GroupEntity>	getDirectParentGroupsOfGroup(String id)	Gets direct parent groups of group.
Set<UserEntity>	getDirectUsersOfGroup(String id)	Gets direct users of group.
GroupEntity	getGroup(String id)	Gets group info.
Set<GroupEntity>	getTransitiveChildGroupsOfGroup(String id)	Gets transitive child groups of group.
Set<GroupEntity>	getTransitiveGroupsOfUser(String id)	Gets transitive groups of user.
Set<GroupEntity>	getTransitiveParentGroupsOfGroup(String id)	Gets transitive parent groups of group.
Set<UserEntity>	getTransitiveUsersOfGroup(String id)	Gets transitive users of group.
UserEntity	getUser(String id)	Gets user info.
boolean	requireReset()	Check if the caches need a reset.
MappableCursor<Row>	runQueryExpression(String txId, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, QueryExpression expression, EntityType entityType)	Runs a query expression.
void	shutdown()	Shutdown method.
void	startup()	Startup method.
int	upsertAllGroups()	To keep the cache up-to-date all group entities are updated or inserted.
int	upsertAllGroups(int startIndex, int maxResults)	To keep the cache up-to-date all group entities are updated or inserted.
int	upsertAllUsers()	To keep the cache up-to-date all user entities are updated or inserted.
int	upsertAllUsers(int startIndex, int maxResults)	To keep the cache up-to-date all user entities are updated or inserted.
void	upsertGroup(String id)	To keep the cache up-to-date a group entity is updated or inserted.
void	upsertMembership(MembershipEntity membership)	To keep the cache up-to-date a membership entity is updated or inserted.
void	upsertUser(String id)	To keep the cache up-to-date an user entity is updated or inserted.
void	withReadAccess(Runnable block)	Check if the caches need a reset.
<T> T	withReadAccess(Supplier<T> block)	Check if the caches need a reset.
void	withWriteAccess(Runnable block)	Check if the caches need a reset.
<T> T	withWriteAccess(Supplier<T> block)	Check if the caches need a reset.

Methods inherited from class de.aservo.ldap.adapter.backend.ProxyDirectoryBackend

getAllGroups, getAllUsers, getAuthenticatedUser, getId, getMemberships

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_DB_DRIVER

public static final String CONFIG_DB_DRIVER

The constant CONFIG_DB_DRIVER.

See Also:

Constant Field Values

CONFIG_DB_URL

public static final String CONFIG_DB_URL

The constant CONFIG_DB_URL.

See Also:

Constant Field Values

CONFIG_DB_USER

public static final String CONFIG_DB_USER

The constant CONFIG_DB_USER.

See Also:

Constant Field Values

CONFIG_DB_PW

public static final String CONFIG_DB_PW

The constant CONFIG_DB_PW.

See Also:

Constant Field Values

CONFIG_DB_MIN_IDLE

public static final String CONFIG_DB_MIN_IDLE

The constant CONFIG_DB_MIN_IDLE.

See Also:

Constant Field Values

CONFIG_DB_MAX_IDLE

public static final String CONFIG_DB_MAX_IDLE

The constant CONFIG_DB_MAX_IDLE.

See Also:

Constant Field Values

CONFIG_DB_MAX_TOTAL

public static final String CONFIG_DB_MAX_TOTAL

The constant CONFIG_DB_MAX_TOTAL.

See Also:

Constant Field Values

CONFIG_DB_MAX_OPEN_STMT

public static final String CONFIG_DB_MAX_OPEN_STMT

The constant CONFIG_DB_MAX_OPEN_STMT.

See Also:

Constant Field Values

CONFIG_DB_ISO_LEVEL

public static final String CONFIG_DB_ISO_LEVEL

The constant CONFIG_DB_ISO_LEVEL.

See Also:

Constant Field Values

CONFIG_TRANSACTION_TIMEOUT

public static final String CONFIG_TRANSACTION_TIMEOUT

The constant CONFIG_TRANSACTION_TIMEOUT.

See Also:

Constant Field Values

CONFIG_APPLY_NATIVE_SQL

public static final String CONFIG_APPLY_NATIVE_SQL

The constant CONFIG_APPLY_NATIVE_SQL.

See Also:

Constant Field Values

CONFIG_USE_MATERIALIZED_VIEWS

public static final String CONFIG_USE_MATERIALIZED_VIEWS

The constant CONFIG_USE_MATERIALIZED_VIEWS.

See Also:

Constant Field Values

CONFIG_PASS_ACTIVE_USERS_ONLY

public static final String CONFIG_PASS_ACTIVE_USERS_ONLY

The constant CONFIG_PASS_ACTIVE_USERS_ONLY.

See Also:

Constant Field Values

Constructor Detail

CachedWithPersistenceDirectoryBackend

public CachedWithPersistenceDirectoryBackend(ServerConfiguration config,
                                             NestedDirectoryBackend directoryBackend)

Instantiates a new directory backend.

Parameters:

config - config the config instance of the server

directoryBackend - the directory backend

Method Detail

startup

public void startup()

Description copied from interface: DirectoryBackend

Startup method.

Specified by:

startup in interface DirectoryBackend

Overrides:

startup in class ProxyDirectoryBackend

shutdown

public void shutdown()

Description copied from interface: DirectoryBackend

Shutdown method.

Specified by:

shutdown in interface DirectoryBackend

Overrides:

shutdown in class ProxyDirectoryBackend

withReadAccess

public <T> T withReadAccess(Supplier<T> block)

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

withReadAccess in interface NestedDirectoryBackend

Overrides:

withReadAccess in class ProxyDirectoryBackend

Parameters:

block - the supplier object executed within the session

Returns:

the result of the supplier code block

withReadAccess

public void withReadAccess(Runnable block)

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

withReadAccess in interface NestedDirectoryBackend

Overrides:

withReadAccess in class ProxyDirectoryBackend

Parameters:

block - the runnable object executed within the session

withWriteAccess

public <T> T withWriteAccess(Supplier<T> block)

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

withWriteAccess in interface NestedDirectoryBackend

Overrides:

withWriteAccess in class ProxyDirectoryBackend

Parameters:

block - the supplier object executed within the session

Returns:

the result of the supplier code block

withWriteAccess

public void withWriteAccess(Runnable block)

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

withWriteAccess in interface NestedDirectoryBackend

Overrides:

withWriteAccess in class ProxyDirectoryBackend

Parameters:

block - the runnable object executed within the session

requireReset

public boolean requireReset()

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

requireReset in interface NestedDirectoryBackend

Overrides:

requireReset in class ProxyDirectoryBackend

Returns:

the boolean

upsertGroup

public void upsertGroup(String id)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date a group entity is updated or inserted.

Specified by:

upsertGroup in interface NestedDirectoryBackend

Overrides:

upsertGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

upsertAllGroups

public int upsertAllGroups(int startIndex,
                           int maxResults)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date all group entities are updated or inserted.

Specified by:

upsertAllGroups in interface NestedDirectoryBackend

Overrides:

upsertAllGroups in class ProxyDirectoryBackend

Parameters:

startIndex - the start index for pagination

maxResults - the maximum number of results for pagination

Returns:

the number of handled entities

upsertAllGroups

public int upsertAllGroups()

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date all group entities are updated or inserted.

Specified by:

upsertAllGroups in interface NestedDirectoryBackend

Overrides:

upsertAllGroups in class ProxyDirectoryBackend

Returns:

the number of handled entities

upsertUser

public void upsertUser(String id)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date an user entity is updated or inserted.

Specified by:

upsertUser in interface NestedDirectoryBackend

Overrides:

upsertUser in class ProxyDirectoryBackend

Parameters:

id - the user ID

upsertAllUsers

public int upsertAllUsers(int startIndex,
                          int maxResults)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date all user entities are updated or inserted.

Specified by:

upsertAllUsers in interface NestedDirectoryBackend

Overrides:

upsertAllUsers in class ProxyDirectoryBackend

Parameters:

startIndex - the start index for pagination

maxResults - the maximum number of results for pagination

Returns:

the number of handled entities

upsertAllUsers

public int upsertAllUsers()

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date all user entities are updated or inserted.

Specified by:

upsertAllUsers in interface NestedDirectoryBackend

Overrides:

upsertAllUsers in class ProxyDirectoryBackend

Returns:

the number of handled entities

upsertMembership

public void upsertMembership(MembershipEntity membership)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date a membership entity is updated or inserted.

Specified by:

upsertMembership in interface NestedDirectoryBackend

Overrides:

upsertMembership in class ProxyDirectoryBackend

Parameters:

membership - the membership entity

dropGroup

public void dropGroup(String id)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date a group entity is dropped.

Specified by:

dropGroup in interface NestedDirectoryBackend

Overrides:

dropGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

dropAllGroups

public void dropAllGroups()

Description copied from interface: NestedDirectoryBackend

To reset the cache all group entities are dropped.

Specified by:

dropAllGroups in interface NestedDirectoryBackend

Overrides:

dropAllGroups in class ProxyDirectoryBackend

dropUser

public void dropUser(String id)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date an user entity is dropped.

Specified by:

dropUser in interface NestedDirectoryBackend

Overrides:

dropUser in class ProxyDirectoryBackend

Parameters:

id - the user ID

dropAllUsers

public void dropAllUsers()

Description copied from interface: NestedDirectoryBackend

To reset the cache all user entities are dropped.

Specified by:

dropAllUsers in interface NestedDirectoryBackend

Overrides:

dropAllUsers in class ProxyDirectoryBackend

dropMembership

public void dropMembership(MembershipEntity membership)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date a membership entity is dropped.

Specified by:

dropMembership in interface NestedDirectoryBackend

Overrides:

dropMembership in class ProxyDirectoryBackend

Parameters:

membership - the membership entity

runQueryExpression

public MappableCursor<Row> runQueryExpression(String txId,
                                              org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                              QueryExpression expression,
                                              EntityType entityType)

Description copied from interface: DirectoryBackend

Runs a query expression.

Specified by:

runQueryExpression in interface DirectoryBackend

Overrides:

runQueryExpression in class ProxyDirectoryBackend

Parameters:

txId - the transaction ID

schemaManager - the schema manager

expression - the query expression

entityType - the entity type

Returns:

the query generator

getGroup

public GroupEntity getGroup(String id)
                     throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets group info.

Specified by:

getGroup in interface DirectoryBackend

Overrides:

getGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the group

Throws:

EntityNotFoundException - the entry not found exception

getUser

public UserEntity getUser(String id)
                   throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets user info.

Specified by:

getUser in interface DirectoryBackend

Overrides:

getUser in class ProxyDirectoryBackend

Parameters:

id - the user ID

Returns:

the user

Throws:

EntityNotFoundException - the entry not found exception

getAllGroups

public Set<GroupEntity> getAllGroups()

Description copied from interface: DirectoryBackend

Gets all groups.

Specified by:

getAllGroups in interface DirectoryBackend

Overrides:

getAllGroups in class ProxyDirectoryBackend

Returns:

the groups

getAllUsers

public Set<UserEntity> getAllUsers()

Description copied from interface: DirectoryBackend

Gets all users.

Specified by:

getAllUsers in interface DirectoryBackend

Overrides:

getAllUsers in class ProxyDirectoryBackend

Returns:

the users

getDirectUsersOfGroup

public Set<UserEntity> getDirectUsersOfGroup(String id)
                                      throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets direct users of group.

Specified by:

getDirectUsersOfGroup in interface DirectoryBackend

Overrides:

getDirectUsersOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the direct users of group

Throws:

EntityNotFoundException - the entry not found exception

getDirectGroupsOfUser

public Set<GroupEntity> getDirectGroupsOfUser(String id)
                                       throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets direct groups of user.

Specified by:

getDirectGroupsOfUser in interface DirectoryBackend

Overrides:

getDirectGroupsOfUser in class ProxyDirectoryBackend

Parameters:

id - the user ID

Returns:

the direct groups of user

Throws:

EntityNotFoundException - the entry not found exception

getDirectChildGroupsOfGroup

public Set<GroupEntity> getDirectChildGroupsOfGroup(String id)
                                             throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets direct child groups of group.

Specified by:

getDirectChildGroupsOfGroup in interface DirectoryBackend

Overrides:

getDirectChildGroupsOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the direct child groups of group

Throws:

EntityNotFoundException - the entry not found exception

getDirectParentGroupsOfGroup

public Set<GroupEntity> getDirectParentGroupsOfGroup(String id)
                                              throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets direct parent groups of group.

Specified by:

getDirectParentGroupsOfGroup in interface DirectoryBackend

Overrides:

getDirectParentGroupsOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the direct parent groups of group

Throws:

EntityNotFoundException - the entry not found exception

getTransitiveUsersOfGroup

public Set<UserEntity> getTransitiveUsersOfGroup(String id)
                                          throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets transitive users of group.

Specified by:

getTransitiveUsersOfGroup in interface DirectoryBackend

Overrides:

getTransitiveUsersOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the transitive users of group

Throws:

EntityNotFoundException - the entry not found exception

getTransitiveGroupsOfUser

public Set<GroupEntity> getTransitiveGroupsOfUser(String id)
                                           throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets transitive groups of user.

Specified by:

getTransitiveGroupsOfUser in interface DirectoryBackend

Overrides:

getTransitiveGroupsOfUser in class ProxyDirectoryBackend

Parameters:

id - the user ID

Returns:

the transitive groups of user

Throws:

EntityNotFoundException - the entry not found exception

getTransitiveChildGroupsOfGroup

public Set<GroupEntity> getTransitiveChildGroupsOfGroup(String id)
                                                 throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets transitive child groups of group.

Specified by:

getTransitiveChildGroupsOfGroup in interface DirectoryBackend

Overrides:

getTransitiveChildGroupsOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the transitive child groups of group

Throws:

EntityNotFoundException - the entry not found exception

getTransitiveParentGroupsOfGroup

public Set<GroupEntity> getTransitiveParentGroupsOfGroup(String id)
                                                  throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets transitive parent groups of group.

Specified by:

getTransitiveParentGroupsOfGroup in interface DirectoryBackend

Overrides:

getTransitiveParentGroupsOfGroup in class ProxyDirectoryBackend

Parameters:

id - the group ID

Returns:

the transitive parent groups of group

Throws:

EntityNotFoundException - the entry not found exception