DelegatedAuthenticationDirectory (Atlassian Crowd Persistence Module 2.8.8 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atlassian.crowd.directory
Class DelegatedAuthenticationDirectory

java.lang.Object
  com.atlassian.crowd.directory.DelegatedAuthenticationDirectory

All Implemented Interfaces:: RemoteDirectory, Attributes

public class DelegatedAuthenticationDirectory
extends Object
implements RemoteDirectory
extends Object
implements RemoteDirectory

This implementation of a RemoteDirectory provides delegated authentication to an underlying remote LDAP implementation.

In essence this means that a User's groups and roles are managed internally to Crowd and only authentication is delegated to the LDAP directory.

Users, group and memberships exist in an internal directory and all query and mutation operations execute on the internal directory.

For a user to successfully authenticate, they must exist in LDAP and must authenticate against LDAP. Passwords are not stored internally.

If the ATTRIBUTE_CREATE_USER_ON_AUTH attribute is enabled, the delegated authentication directory will automatically create the user in the internal portion of this directory, once they successfully authenticate against LDAP. The initial user details, in this case, will be obtained from LDAP.

If the ATTRIBUTE_UPDATE_USER_ON_AUTH attribute is enabled, the delegated authentication directory will also update the user's details from LDAP automatically whenever they authenticate. The same behaviour will happen if the attribute is not enabled and the user is deleted internally and then re-authenticates.

If the create-on-auth option is not enabled, then users must always be manually created in this directory, before they can authenticate against LDAP. In this scenario, the user details will never be retrieved from LDAP. This is OSUser's default LDAP behaviour.

Field Summary
`static String`	`ATTRIBUTE_CREATE_USER_ON_AUTH`
`static String`	`ATTRIBUTE_KEY_IMPORT_GROUPS`
`static String`	`ATTRIBUTE_LDAP_DIRECTORY_CLASS`
`static String`	`ATTRIBUTE_UPDATE_USER_ON_AUTH`

Constructor Summary
`DelegatedAuthenticationDirectory(RemoteDirectory ldapDirectory, InternalRemoteDirectory internalDirectory, com.atlassian.event.api.EventPublisher eventPublisher, DirectoryDao directoryDao)`

Method Summary

Group addGroup(GroupTemplate group)

void addGroupToGroup(String childGroup, String parentGroup)

User addOrUpdateLdapUser(String name)
Copies or updates a user in the internal directory from their counterpart in the LDAP directory.

User addUser(UserTemplate user, PasswordCredential credential)

void addUserToGroup(String username, String groupName)

User authenticate(String name, PasswordCredential credential)
In addition to the normal authentication behaviour, following a successful authentication the following may occur: If the user does not exist in the internal directory and ATTRIBUTE_CREATE_USER_ON_AUTH is enabled, the user's details will be added to the internal directory. If the user exists in the internal directory and ATTRIBUTE_UPDATE_USER_ON_AUTH is enabled, the user's details will be updated in the internal directory. If the user exists in the internal directory and ATTRIBUTE_UPDATE_USER_ON_AUTH is enabled and the username was changed in remote directory, the user's name will be updated in the internal directory. A user marked as inactive locally will not be authenticated, retrieved, renamed or updated from the LDAP server.

BoundedCount countDirectMembersOfGroup(String groupName, int querySizeHint)

void expireAllPasswords()

Group findGroupByName(String name)

GroupWithAttributes findGroupWithAttributesByName(String name)

User findUserByExternalId(String externalId)

User findUserByName(String name)

UserWithAttributes findUserWithAttributesByName(String name)

RemoteDirectory getAuthoritativeDirectory()

String getDescriptiveName()

long getDirectoryId()

Set<String> getKeys()

Iterable<Membership> getMemberships()

String getValue(String key)

Set<String> getValues(String key)

boolean isEmpty()

boolean isGroupDirectGroupMember(String childGroup, String parentGroup)

boolean isRolesDisabled()

boolean isUserDirectGroupMember(String username, String groupName)

void removeGroup(String name)

void removeGroupAttributes(String groupName, String attributeName)

void removeGroupFromGroup(String childGroup, String parentGroup)

void removeUser(String name)

void removeUserAttributes(String username, String attributeName)

void removeUserFromGroup(String username, String groupName)

Group renameGroup(String oldName, String newName)

User renameUser(String oldName, String newName)





<T> List<T>

searchGroupRelationships(MembershipQuery<T> query)





<T> List<T>

searchGroups(EntityQuery<T> query)





<T> List<T>

searchUsers(EntityQuery<T> query)

void setAttributes(Map<String,String> attributes)

void setDirectoryId(long directoryId)

void storeGroupAttributes(String groupName, Map<String,Set<String>> attributes)

void storeUserAttributes(String username, Map<String,Set<String>> attributes)

boolean supportsInactiveAccounts()

boolean supportsNestedGroups()

boolean supportsPasswordExpiration()

boolean supportsSettingEncryptedCredential()
Delegated authentication directories don't support setting non-hashed credentials, let alone hashed credentials.

void testConnection()

Group updateGroup(GroupTemplate group)

User updateUser(UserTemplate user)

void updateUserCredential(String username, PasswordCredential credential)

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ATTRIBUTE_CREATE_USER_ON_AUTH

public static final String ATTRIBUTE_CREATE_USER_ON_AUTH

See Also:: Constant Field Values

ATTRIBUTE_UPDATE_USER_ON_AUTH

public static final String ATTRIBUTE_UPDATE_USER_ON_AUTH

See Also:: Constant Field Values

ATTRIBUTE_LDAP_DIRECTORY_CLASS

public static final String ATTRIBUTE_LDAP_DIRECTORY_CLASS

See Also:: Constant Field Values

ATTRIBUTE_KEY_IMPORT_GROUPS

public static final String ATTRIBUTE_KEY_IMPORT_GROUPS

See Also:: Constant Field Values

Constructor Detail