Package technology.openpool.ldap.adapter.backend

Class CrowdDirectoryBackend

java.lang.Object

technology.openpool.ldap.adapter.backend.CrowdDirectoryBackend

All Implemented Interfaces:

DirectoryBackend, NestedDirectoryBackend

public class CrowdDirectoryBackend
extends Object
implements NestedDirectoryBackend

The Crowd client API directory backend.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_READINESS_CHECK	The constant CONFIG_READINESS_CHECK.

Constructor Summary

Constructors

Constructor	Description
CrowdDirectoryBackend(ServerConfiguration config)	Instantiates a new Crowd directory backend.

Method Summary

Modifier and Type	Method	Description
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.
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.

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, dropAllGroups, dropAllUsers, dropGroup, dropMembership, dropUser, releaseDbLock, requireReset, upsertAllGroups, upsertAllGroups, upsertAllUsers, upsertAllUsers, upsertGroup, upsertMembership, upsertUser, upsertUser, withReadAccess, withReadAccess, withWriteAccess, withWriteAccess

Field Detail

CONFIG_READINESS_CHECK

public static final String CONFIG_READINESS_CHECK

The constant CONFIG_READINESS_CHECK.

See Also:

Constant Field Values

Constructor Detail

CrowdDirectoryBackend

public CrowdDirectoryBackend(ServerConfiguration config)

Instantiates a new Crowd directory backend.

Parameters:

config - the config instance of the server

Method Detail

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

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