com.atlassian.crowd.directory

Class CachingDirectory

java.lang.Object

com.atlassian.crowd.directory.AbstractInternalDirectory

com.atlassian.crowd.directory.CachingDirectory

All Implemented Interfaces:

FastEntityCountProvider, InternalRemoteDirectory, MultiValuesQueriesSupport, RemoteDirectory, Attributes

public class CachingDirectory
extends AbstractInternalDirectory

This InternalDirectory is used for locally caching Users and Groups from an external Directory.

See Also:

InternalDirectory

Field Summary

Fields inherited from class com.atlassian.crowd.directory.AbstractInternalDirectory

ATTRIBUTE_PASSWORD_COMPLEXITY_MESSAGE, ATTRIBUTE_PASSWORD_EXPIRATION_NOTIFICATION_PERIODS, ATTRIBUTE_PASSWORD_HISTORY_COUNT, ATTRIBUTE_PASSWORD_MAX_ATTEMPTS, ATTRIBUTE_PASSWORD_MAX_CHANGE_TIME, ATTRIBUTE_PASSWORD_MINIMUM_LENGTH, ATTRIBUTE_PASSWORD_MINIMUM_SCORE, ATTRIBUTE_PASSWORD_REGEX, ATTRIBUTE_USER_ENCRYPTION_METHOD, attributes, DESCRIPTIVE_NAME, directoryDao, directoryId, groupDao, internalDirectoryUtils, membershipDao, passwordEncoderFactory, tombstoneDao, userDao

Constructor Summary

Constructors

Constructor and Description
CachingDirectory(InternalDirectoryUtils internalDirectoryUtils, PasswordEncoderFactory passwordEncoderFactory, DirectoryDao directoryDao, UserDao userDao, GroupDao groupDao, MembershipDao membershipDao, TombstoneDao tombstoneDao, PasswordConstraintsLoader passwordConstraints)

Method Summary

Modifier and Type	Method and Description
BatchResult<Group>	addAllGroups(Set<GroupTemplate> groups)
BatchResult<User>	addAllUsers(Set<UserTemplateWithCredentialAndAttributes> users)
BatchResult<String>	addAllUsersToGroup(Set<String> userNames, String groupName)
Group	addLocalGroup(GroupTemplate group)
User	addUser(UserTemplate user, PasswordCredential credential) Adds a user with no special added logic.
UserWithAttributes	addUser(UserTemplateWithAttributes user, PasswordCredential credential) Adds a user without modifying it, including storing its attributes.
boolean	isLocalUserStatusEnabled() Caching directories can be configured to support local user statuses.
BatchResult<String>	removeGroupsFromGroup(Collection<String> childGroupNames, String groupName)
BatchResult<String>	removeUsersFromGroup(Set<String> usernames, String groupName)
User	updateUser(UserTemplate user)

Methods inherited from class com.atlassian.crowd.directory.AbstractInternalDirectory

addAllGroupsToGroup, addGroup, addGroupToGroup, addUserToGroup, addUserToGroups, authenticate, calculatePostPasswordUpdateAttributes, countDirectMembersOfGroup, currentPrincipalInvalidPasswordAttempts, encryptedCredential, expireAllPasswords, findGroupByName, findGroupWithAttributesByName, findUserByExternalId, findUserByName, findUserWithAttributesByName, forceRenameUser, getAllUserExternalIds, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getEncoder, getGroupCount, getKeys, getMemberships, getPasswordConstraints, getUserAvatarByName, getUserCount, getValue, getValues, isEmpty, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeAllGroups, removeAllUsers, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, requiresPasswordChange, searchGroupRelationships, searchGroupRelationshipsGroupedByName, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, supportsPasswordExpiration, supportsSettingEncryptedCredential, testConnection, updateGroup, updateUserCredential, userAuthenticated

Methods inherited from class java.lang.Object

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

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

getLocallyFilteredGroupNames, updateUserFromRemoteDirectory

Constructor Detail

CachingDirectory

public CachingDirectory(InternalDirectoryUtils internalDirectoryUtils,
                        PasswordEncoderFactory passwordEncoderFactory,
                        DirectoryDao directoryDao,
                        UserDao userDao,
                        GroupDao groupDao,
                        MembershipDao membershipDao,
                        TombstoneDao tombstoneDao,
                        PasswordConstraintsLoader passwordConstraints)

Method Detail

addUser

public User addUser(UserTemplate user,
                    PasswordCredential credential)
             throws InvalidCredentialException,
                    InvalidUserException,
                    UserAlreadyExistsException,
                    OperationFailedException

Adds a user with no special added logic.

Parameters:

user - template of the user to add.

credential - password. May be null, since JIRA creates a user in two steps

Returns:

added user.

Throws:

InvalidCredentialException - the password does not match the regular expression standard defined by the directory.

InvalidUserException

UserAlreadyExistsException

OperationFailedException

addUser

public UserWithAttributes addUser(UserTemplateWithAttributes user,
                                  PasswordCredential credential)
                           throws InvalidCredentialException,
                                  InvalidUserException,
                                  UserAlreadyExistsException,
                                  OperationFailedException

Adds a user without modifying it, including storing its attributes.

Specified by:

addUser in interface RemoteDirectory

Specified by:

addUser in class AbstractInternalDirectory

Parameters:

user - template of the user to add.

credential - password. May be null, since JIRA creates a user in two steps

Returns:

added user.

Throws:

InvalidCredentialException - the password does not match the regular expression standard defined by the directory.

InvalidUserException

UserAlreadyExistsException

OperationFailedException

addLocalGroup

public Group addLocalGroup(GroupTemplate group)
                    throws InvalidGroupException,
                           OperationFailedException

Specified by:

addLocalGroup in interface InternalRemoteDirectory

Specified by:

addLocalGroup in class AbstractInternalDirectory

Throws:

InvalidGroupException

OperationFailedException

addAllUsers

public BatchResult<User> addAllUsers(Set<UserTemplateWithCredentialAndAttributes> users)

addAllGroups

public BatchResult<Group> addAllGroups(Set<GroupTemplate> groups)

addAllUsersToGroup

public BatchResult<String> addAllUsersToGroup(Set<String> userNames,
                                              String groupName)
                                       throws GroupNotFoundException

Throws:

GroupNotFoundException

removeUsersFromGroup

public BatchResult<String> removeUsersFromGroup(Set<String> usernames,
                                                String groupName)
                                         throws GroupNotFoundException

Specified by:

removeUsersFromGroup in interface InternalRemoteDirectory

Overrides:

removeUsersFromGroup in class AbstractInternalDirectory

Throws:

GroupNotFoundException

removeGroupsFromGroup

public BatchResult<String> removeGroupsFromGroup(Collection<String> childGroupNames,
                                                 String groupName)
                                          throws GroupNotFoundException

Specified by:

removeGroupsFromGroup in interface InternalRemoteDirectory

Overrides:

removeGroupsFromGroup in class AbstractInternalDirectory

Throws:

GroupNotFoundException

updateUser

public User updateUser(UserTemplate user)
                throws InvalidUserException,
                       UserNotFoundException

Throws:

InvalidUserException

UserNotFoundException

isLocalUserStatusEnabled

public boolean isLocalUserStatusEnabled()

Caching directories can be configured to support local user statuses. By default, local user statuses are disabled.

Returns:

true if the local user status configuration is enabled

See Also:

upgrade.tasks.UpgradeTask622