Package technology.openpool.ldap.adapter.backend

Class ProxyDirectoryBackend

java.lang.Object

technology.openpool.ldap.adapter.backend.ProxyDirectoryBackend

All Implemented Interfaces:

DirectoryBackend, NestedDirectoryBackend

Direct Known Subclasses:

CachedDirectoryBackend, LockingDirectoryBackend, MirroredCrowdDirectoryBackend

public abstract class ProxyDirectoryBackend
extends Object
implements NestedDirectoryBackend

Field Summary

Fields

Modifier and Type	Field	Description
protected ServerConfiguration	config
protected NestedDirectoryBackend	directoryBackend

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProxyDirectoryBackend(ServerConfiguration config, NestedDirectoryBackend directoryBackend)

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<GroupEntity>	getAllGroups(int startIndex, int maxResults)	Gets all groups.
Set<UserEntity>	getAllUsers()	Gets all users.
Set<UserEntity>	getAllUsers(int startIndex, int maxResults)	Gets all users.
UserEntity	getAuthenticatedUser(String id, String password)	Gets info from authenticated user.
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.
String	getId()	Gets backend ID.
MappableCursor<MembershipEntity>	getMemberships()	Returns a cursor for membership entities.
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	upsertUser(String id, String idOther)	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 java.lang.Object

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

Methods inherited from interface technology.openpool.ldap.adapter.api.directory.NestedDirectoryBackend

acquireDbLock, releaseDbLock

Field Detail

config

protected final ServerConfiguration config

directoryBackend

protected final NestedDirectoryBackend directoryBackend

Constructor Detail

ProxyDirectoryBackend

protected ProxyDirectoryBackend(ServerConfiguration config,
                                NestedDirectoryBackend directoryBackend)

Method Detail

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

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

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

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

Parameters:

block - the runnable object executed within the session

getId

public String getId()

Description copied from interface: DirectoryBackend

Gets backend ID.

Specified by:

getId in interface DirectoryBackend

Returns:

the backend ID

startup

public void startup()

Description copied from interface: DirectoryBackend

Startup method.

Specified by:

startup in interface DirectoryBackend

shutdown

public void shutdown()

Description copied from interface: DirectoryBackend

Shutdown method.

Specified by:

shutdown in interface DirectoryBackend

requireReset

public boolean requireReset()

Description copied from interface: NestedDirectoryBackend

Check if the caches need a reset.

Specified by:

requireReset in interface NestedDirectoryBackend

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

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

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

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

Parameters:

id - the user ID

upsertUser

public void upsertUser(String id,
                       String idOther)

Description copied from interface: NestedDirectoryBackend

To keep the cache up-to-date an user entity is updated or inserted. The user inherits the groups of another user

Specified by:

upsertUser in interface NestedDirectoryBackend

Parameters:

id - the user ID

idOther - the user ID of an existing user

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

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

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

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

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

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

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

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

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

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

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

Parameters:

id - the user ID

Returns:

the user

Throws:

EntityNotFoundException - the entry not found exception

getAuthenticatedUser

public UserEntity getAuthenticatedUser(String id,
                                       String password)
                                throws EntityNotFoundException

Description copied from interface: DirectoryBackend

Gets info from authenticated user.

Specified by:

getAuthenticatedUser in interface DirectoryBackend

Parameters:

id - the user ID

password - the password

Returns:

the authenticated 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

Returns:

the groups

getAllGroups

public Set<GroupEntity> getAllGroups(int startIndex,
                                     int maxResults)

Description copied from interface: DirectoryBackend

Gets all groups.

Specified by:

getAllGroups in interface DirectoryBackend

Returns:

the groups

getAllUsers

public Set<UserEntity> getAllUsers()

Description copied from interface: DirectoryBackend

Gets all users.

Specified by:

getAllUsers in interface DirectoryBackend

Returns:

the users

getAllUsers

public Set<UserEntity> getAllUsers(int startIndex,
                                   int maxResults)

Description copied from interface: DirectoryBackend

Gets all users.

Specified by:

getAllUsers in interface DirectoryBackend

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

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

Parameters:

id - the user ID

Returns:

the direct groups of user

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

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

Parameters:

id - the user ID

Returns:

the transitive 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

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

Parameters:

id - the group ID

Returns:

the direct parent groups of group

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

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

Parameters:

id - the group ID

Returns:

the transitive parent groups of group

Throws:

EntityNotFoundException - the entry not found exception

getMemberships

public MappableCursor<MembershipEntity> getMemberships()

Description copied from interface: NestedDirectoryBackend

Returns a cursor for membership entities.

Specified by:

getMemberships in interface NestedDirectoryBackend

Returns:

the cursor with membership elements