com.atlassian.crowd.integration.directory.connector
Interface LDAPDirectory

All Superinterfaces:

AttributeAware, RemoteDirectory

All Known Implementing Classes:

ApacheDS, ApacheDS15, AppleOpenDirectory, CachingLDAPDirectory, FedoraDS, GenericLDAP, MicrosoftActiveDirectory, NovelleDirectory, OpenDS, OpenLDAP, OpenLDAPRfc2307, Rfc2307, RFC2307Directory, RFC4519Directory, SpringLDAPConnector, SunONE

public interface LDAPDirectory
extends RemoteDirectory

Contains methods specific to LDAP direcotories.

Method Summary

<T extends LDAPDirectoryEntity> T

findEntityByDN(String dn, Class<T> entityClass) Finds a directory entity (principal, group or role) by their distinguished name.

Methods inherited from interface com.atlassian.crowd.integration.directory.RemoteDirectory

addGroup, addGroupToGroup, addUser, addUserToGroup, authenticate, findGroupByName, findGroupWithAttributesByName, findUserByName, findUserWithAttributesByName, getDescriptiveName, getDirectoryId, isGroupDirectGroupMember, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsNestedGroups, testConnection, updateGroup, updateUser, updateUserCredential

Methods inherited from interface com.atlassian.crowd.integration.model.AttributeAware

getAttribute, getAttributeNames, getAttributes, hasAttribute

Method Detail

findEntityByDN

<T extends LDAPDirectoryEntity> T findEntityByDN(String dn,
                                                 Class<T> entityClass)
                                             throws ObjectNotFoundException

Finds a directory entity (principal, group or role) by their distinguished name.

The object class of an entity is used to determine the entity type.

If an object represents both a group and role, then the object is mapped to a group.

No sub-tree restrictions are applied.

Parameters:

dn - standardised disinguished name.

entityClass - class of the entity to find (either LDAPUserWithAttributes or LDAPGroupWithAttributes).

Returns:

directory entity corresponding to DN.

Throws:

ObjectNotFoundException - if a user/group does not exist at the specified DN or the DN does not exist in the directory. This will also be thrown if the entity DOES exist but does not match the base DN or object filter for the entity type.