com.atlassian.crowd.directory

Class AbstractInternalDirectory

java.lang.Object

com.atlassian.crowd.directory.AbstractInternalDirectory

All Implemented Interfaces:

FastEntityCountProvider, InternalRemoteDirectory, MultiValuesQueriesSupport, RemoteDirectory, Attributes

Direct Known Subclasses:

CachingDirectory, InternalDirectory

public abstract class AbstractInternalDirectory
extends Object
implements InternalRemoteDirectory

This class holds methods that are common to both InternalDirectory and CachingDirectory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_PASSWORD_COMPLEXITY_MESSAGE
static String	ATTRIBUTE_PASSWORD_EXPIRATION_NOTIFICATION_PERIODS
static String	ATTRIBUTE_PASSWORD_HISTORY_COUNT
static String	ATTRIBUTE_PASSWORD_MAX_ATTEMPTS
static String	ATTRIBUTE_PASSWORD_MAX_CHANGE_TIME
static String	ATTRIBUTE_PASSWORD_MINIMUM_LENGTH The minimum length a password can have for users in this directory, stored as a non-negative integer
static String	ATTRIBUTE_PASSWORD_MINIMUM_SCORE The minimum password score allowed for new passwords for users in this directory, stored as PasswordScore.getRanking().
static String	ATTRIBUTE_PASSWORD_REGEX
static String	ATTRIBUTE_USER_ENCRYPTION_METHOD
protected AttributeValuesHolder	attributes
static String	DESCRIPTIVE_NAME
protected DirectoryDao	directoryDao
protected long	directoryId
protected GroupDao	groupDao
protected InternalDirectoryUtils	internalDirectoryUtils
protected MembershipDao	membershipDao
protected PasswordEncoderFactory	passwordEncoderFactory
protected TombstoneDao	tombstoneDao
protected UserDao	userDao

Constructor Summary

Constructors

Constructor and Description
AbstractInternalDirectory(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<String>	addAllGroupsToGroup(Collection<String> childGroupNames, String groupName)
Group	addGroup(GroupTemplate group)
void	addGroupToGroup(String childGroup, String parentGroup)
abstract Group	addLocalGroup(GroupTemplate group)
abstract UserWithAttributes	addUser(UserTemplateWithAttributes user, PasswordCredential credential)
void	addUserToGroup(String username, String groupName)
BatchResult<String>	addUserToGroups(String username, Set<String> groupNames)
User	authenticate(String name, PasswordCredential credential)
protected static Map<String,Set<String>>	calculatePostPasswordUpdateAttributes() Generate the list of default attributes and values relating to passwords, for use when creating or resetting a password
BoundedCount	countDirectMembersOfGroup(String groupName, int querySizeHint)
protected long	currentPrincipalInvalidPasswordAttempts(UserWithAttributes user)
protected PasswordCredential	encryptedCredential(PasswordCredential passwordCredential)
void	expireAllPasswords()
InternalDirectoryGroup	findGroupByName(String name)
GroupWithAttributes	findGroupWithAttributesByName(String name)
TimestampedUser	findUserByExternalId(String externalId)
TimestampedUser	findUserByName(String name)
UserWithAttributes	findUserWithAttributesByName(String name)
User	forceRenameUser(User oldUser, String newName)
Set<String>	getAllUserExternalIds()
RemoteDirectory	getAuthoritativeDirectory()
String	getDescriptiveName()
long	getDirectoryId()
protected PasswordEncoder	getEncoder()
long	getGroupCount()
Set<String>	getKeys()
Iterable<Membership>	getMemberships()
protected Set<PasswordConstraint>	getPasswordConstraints()
AvatarReference	getUserAvatarByName(String username, int sizeHint)
long	getUserCount()
String	getValue(String name)
Set<String>	getValues(String name)
boolean	isEmpty()
boolean	isGroupDirectGroupMember(String childGroup, String parentGroup)
boolean	isRolesDisabled()
boolean	isUserDirectGroupMember(String username, String groupName)
BatchResult<String>	removeAllGroups(Set<String> groupNames)
BatchResult<String>	removeAllUsers(Set<String> userNames)
void	removeGroup(String name)
void	removeGroupAttributes(String groupName, String attributeName)
void	removeGroupFromGroup(String childGroup, String parentGroup)
BatchResult<String>	removeGroupsFromGroup(Collection<String> childGroupNames, String groupName)
void	removeUser(String name)
void	removeUserAttributes(String username, String attributeName)
void	removeUserFromGroup(String username, String groupName)
BatchResult<String>	removeUsersFromGroup(Set<String> usernames, String groupName)
Group	renameGroup(String oldName, String newName)
User	renameUser(String oldName, String newName)
protected boolean	requiresPasswordChange(UserWithAttributes user)
<T> List<T>	searchGroupRelationships(MembershipQuery<T> query)
<T> com.google.common.collect.ListMultimap<String,T>	searchGroupRelationshipsGroupedByName(MembershipQuery<T> query)
<T> List<T>	searchGroups(EntityQuery<T> query)
<T> List<T>	searchUsers(EntityQuery<T> query)
void	setAttributes(Map<String,String> attributes) Called by the DirectoryInstanceLoader after constructing an InternalDirectory.
void	setDirectoryId(long id) Called by the DirectoryInstanceLoader after constructing an InternalDirectory.
void	storeGroupAttributes(String groupName, Map<String,Set<String>> attributes)
void	storeUserAttributes(String username, Map<String,Set<String>> attributes)
boolean	supportsInactiveAccounts() Internal directories always support inactive accounts.
boolean	supportsNestedGroups()
boolean	supportsPasswordExpiration() Internal Directories always support expiring passwords
boolean	supportsSettingEncryptedCredential() Internal directories always support setting passwords by hash.
void	testConnection() Does nothing, connection is determined by the ability to communicate with the database.
Group	updateGroup(GroupTemplate group)
void	updateUserCredential(String name, PasswordCredential newCredential)
User	userAuthenticated(String username)

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.InternalRemoteDirectory

addAllGroups, addAllUsers, addAllUsersToGroup, isLocalUserStatusEnabled

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

addUser, getLocallyFilteredGroupNames, updateUser, updateUserFromRemoteDirectory

Field Detail

DESCRIPTIVE_NAME

public static final String DESCRIPTIVE_NAME

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_REGEX

public static final String ATTRIBUTE_PASSWORD_REGEX

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_COMPLEXITY_MESSAGE

public static final String ATTRIBUTE_PASSWORD_COMPLEXITY_MESSAGE

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_MAX_ATTEMPTS

public static final String ATTRIBUTE_PASSWORD_MAX_ATTEMPTS

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_HISTORY_COUNT

public static final String ATTRIBUTE_PASSWORD_HISTORY_COUNT

See Also:

Constant Field Values

ATTRIBUTE_USER_ENCRYPTION_METHOD

public static final String ATTRIBUTE_USER_ENCRYPTION_METHOD

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_MAX_CHANGE_TIME

public static final String ATTRIBUTE_PASSWORD_MAX_CHANGE_TIME

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_EXPIRATION_NOTIFICATION_PERIODS

public static final String ATTRIBUTE_PASSWORD_EXPIRATION_NOTIFICATION_PERIODS

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_MINIMUM_LENGTH

public static final String ATTRIBUTE_PASSWORD_MINIMUM_LENGTH

The minimum length a password can have for users in this directory, stored as a non-negative integer

See Also:

Constant Field Values

ATTRIBUTE_PASSWORD_MINIMUM_SCORE

public static final String ATTRIBUTE_PASSWORD_MINIMUM_SCORE

The minimum password score allowed for new passwords for users in this directory, stored as PasswordScore.getRanking().

See Also:

Constant Field Values

directoryId

protected long directoryId

attributes

protected AttributeValuesHolder attributes

passwordEncoderFactory

protected final PasswordEncoderFactory passwordEncoderFactory

directoryDao

protected final DirectoryDao directoryDao

userDao

protected final UserDao userDao

groupDao

protected final GroupDao groupDao

membershipDao

protected final MembershipDao membershipDao

tombstoneDao

protected final TombstoneDao tombstoneDao

internalDirectoryUtils

protected final InternalDirectoryUtils internalDirectoryUtils

Constructor Detail

AbstractInternalDirectory

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

Method Detail

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface RemoteDirectory

setDirectoryId

public void setDirectoryId(long id)

Called by the DirectoryInstanceLoader after constructing an InternalDirectory.

Specified by:

setDirectoryId in interface RemoteDirectory

Parameters:

id - The unique id of the Directory stored in the database.

setAttributes

public void setAttributes(Map<String,String> attributes)

Called by the DirectoryInstanceLoader after constructing an InternalDirectory.

Specified by:

setAttributes in interface RemoteDirectory

Parameters:

attributes - attributes map.

getValues

public Set<String> getValues(String name)

Specified by:

getValues in interface Attributes

getValue

public String getValue(String name)

Specified by:

getValue in interface Attributes

getKeys

public Set<String> getKeys()

Specified by:

getKeys in interface Attributes

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Attributes

getDescriptiveName

public String getDescriptiveName()

Specified by:

getDescriptiveName in interface RemoteDirectory

findUserByName

public TimestampedUser findUserByName(String name)
                               throws UserNotFoundException

Specified by:

findUserByName in interface InternalRemoteDirectory

Specified by:

findUserByName in interface RemoteDirectory

Throws:

UserNotFoundException

findUserByExternalId

public TimestampedUser findUserByExternalId(String externalId)
                                     throws UserNotFoundException

Specified by:

findUserByExternalId in interface InternalRemoteDirectory

Specified by:

findUserByExternalId in interface RemoteDirectory

Throws:

UserNotFoundException

findUserWithAttributesByName

public UserWithAttributes findUserWithAttributesByName(String name)
                                                throws UserNotFoundException

Specified by:

findUserWithAttributesByName in interface RemoteDirectory

Throws:

UserNotFoundException

authenticate

public User authenticate(String name,
                         PasswordCredential credential)
                  throws InactiveAccountException,
                         InvalidAuthenticationException,
                         ExpiredCredentialException,
                         UserNotFoundException

Specified by:

authenticate in interface RemoteDirectory

Parameters:

name - The name of the user (username).

credential - The supplied credentials (password).

Returns:

user entity.

Throws:

InactiveAccountException - The supplied user is inactive.

InvalidAuthenticationException - Authentication with the provided credentials failed OR the user has exceeded the maximum number of failed authentication attempts.

UserNotFoundException - The user wth the supplied name does not exist.

ExpiredCredentialException - The user's credentials have expired. The user must change their credentials in order to successfully authenticate.

userAuthenticated

public User userAuthenticated(String username)
                       throws OperationFailedException,
                              UserNotFoundException,
                              InactiveAccountException

Specified by:

userAuthenticated in interface RemoteDirectory

Throws:

OperationFailedException

UserNotFoundException

InactiveAccountException

currentPrincipalInvalidPasswordAttempts

protected long currentPrincipalInvalidPasswordAttempts(UserWithAttributes user)

Parameters:

user - user with attributes.

Returns:

long value of the invalid password attempts attribute on the user.

requiresPasswordChange

protected boolean requiresPasswordChange(UserWithAttributes user)

Parameters:

user - user with attributes.

Returns:

true if the requires password change attribute on the user is set to true, or if the password last changed attribute on the user exceeds the password max change time attribute on the directory (ie. password timeout).

addUser

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

Specified by:

addUser in interface RemoteDirectory

Throws:

InvalidCredentialException

InvalidUserException

UserAlreadyExistsException

OperationFailedException

encryptedCredential

protected PasswordCredential encryptedCredential(PasswordCredential passwordCredential)

getEncoder

protected PasswordEncoder getEncoder()

updateUserCredential

public void updateUserCredential(String name,
                                 PasswordCredential newCredential)
                          throws InvalidCredentialException,
                                 UserNotFoundException

Specified by:

updateUserCredential in interface RemoteDirectory

Throws:

InvalidCredentialException

UserNotFoundException

calculatePostPasswordUpdateAttributes

protected static Map<String,Set<String>> calculatePostPasswordUpdateAttributes()

Generate the list of default attributes and values relating to passwords, for use when creating or resetting a password

Returns:

A map containing the values to then be stored

renameUser

public User renameUser(String oldName,
                       String newName)
                throws InvalidUserException,
                       UserNotFoundException,
                       UserAlreadyExistsException

Specified by:

renameUser in interface RemoteDirectory

Throws:

InvalidUserException

UserNotFoundException

UserAlreadyExistsException

forceRenameUser

public User forceRenameUser(@Nonnull
                            User oldUser,
                            @Nonnull
                            String newName)
                     throws UserNotFoundException

Specified by:

forceRenameUser in interface InternalRemoteDirectory

Throws:

UserNotFoundException

getPasswordConstraints

protected final Set<PasswordConstraint> getPasswordConstraints()

getAllUserExternalIds

@Nonnull
public Set<String> getAllUserExternalIds()
                                           throws OperationFailedException

Specified by:

getAllUserExternalIds in interface InternalRemoteDirectory

Throws:

OperationFailedException

getUserCount

public long getUserCount()
                  throws OperationFailedException

Specified by:

getUserCount in interface FastEntityCountProvider

Throws:

OperationFailedException

getGroupCount

public long getGroupCount()
                   throws OperationFailedException

Specified by:

getGroupCount in interface FastEntityCountProvider

Throws:

OperationFailedException

storeUserAttributes

public void storeUserAttributes(String username,
                                Map<String,Set<String>> attributes)
                         throws UserNotFoundException,
                                OperationFailedException

Specified by:

storeUserAttributes in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

removeUserAttributes

public void removeUserAttributes(String username,
                                 String attributeName)
                          throws UserNotFoundException

Specified by:

removeUserAttributes in interface RemoteDirectory

Throws:

UserNotFoundException

removeUser

public void removeUser(String name)
                throws UserNotFoundException

Specified by:

removeUser in interface RemoteDirectory

Throws:

UserNotFoundException

removeAllUsers

public BatchResult<String> removeAllUsers(Set<String> userNames)

Specified by:

removeAllUsers in interface InternalRemoteDirectory

removeAllGroups

public BatchResult<String> removeAllGroups(Set<String> groupNames)

Specified by:

removeAllGroups in interface InternalRemoteDirectory

searchUsers

public <T> List<T> searchUsers(EntityQuery<T> query)

Specified by:

searchUsers in interface RemoteDirectory

findGroupByName

public InternalDirectoryGroup findGroupByName(String name)
                                       throws GroupNotFoundException

Specified by:

findGroupByName in interface InternalRemoteDirectory

Specified by:

findGroupByName in interface RemoteDirectory

Throws:

GroupNotFoundException

findGroupWithAttributesByName

public GroupWithAttributes findGroupWithAttributesByName(String name)
                                                  throws GroupNotFoundException

Specified by:

findGroupWithAttributesByName in interface RemoteDirectory

Throws:

GroupNotFoundException

addGroup

public Group addGroup(GroupTemplate group)
               throws InvalidGroupException,
                      OperationFailedException

Specified by:

addGroup in interface RemoteDirectory

Throws:

InvalidGroupException

OperationFailedException

addLocalGroup

public abstract Group addLocalGroup(GroupTemplate group)
                             throws InvalidGroupException,
                                    OperationFailedException

Specified by:

addLocalGroup in interface InternalRemoteDirectory

Throws:

InvalidGroupException

OperationFailedException

updateGroup

public Group updateGroup(GroupTemplate group)
                  throws InvalidGroupException,
                         GroupNotFoundException

Specified by:

updateGroup in interface RemoteDirectory

Throws:

InvalidGroupException

GroupNotFoundException

renameGroup

public Group renameGroup(String oldName,
                         String newName)
                  throws InvalidGroupException,
                         GroupNotFoundException

Specified by:

renameGroup in interface RemoteDirectory

Throws:

InvalidGroupException

GroupNotFoundException

storeGroupAttributes

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

Specified by:

storeGroupAttributes in interface RemoteDirectory

Throws:

GroupNotFoundException

removeGroupAttributes

public void removeGroupAttributes(String groupName,
                                  String attributeName)
                           throws GroupNotFoundException

Specified by:

removeGroupAttributes in interface RemoteDirectory

Throws:

GroupNotFoundException

removeGroup

public void removeGroup(String name)
                 throws GroupNotFoundException

Specified by:

removeGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

searchGroups

public <T> List<T> searchGroups(EntityQuery<T> query)

Specified by:

searchGroups in interface RemoteDirectory

isUserDirectGroupMember

public boolean isUserDirectGroupMember(String username,
                                       String groupName)

Specified by:

isUserDirectGroupMember in interface RemoteDirectory

isGroupDirectGroupMember

public boolean isGroupDirectGroupMember(String childGroup,
                                        String parentGroup)

Specified by:

isGroupDirectGroupMember in interface RemoteDirectory

addUserToGroups

public BatchResult<String> addUserToGroups(String username,
                                           Set<String> groupNames)
                                    throws UserNotFoundException

Specified by:

addUserToGroups in interface InternalRemoteDirectory

Throws:

UserNotFoundException

addUserToGroup

public void addUserToGroup(String username,
                           String groupName)
                    throws UserNotFoundException,
                           GroupNotFoundException,
                           MembershipAlreadyExistsException

Specified by:

addUserToGroup in interface RemoteDirectory

Throws:

UserNotFoundException

GroupNotFoundException

MembershipAlreadyExistsException

addGroupToGroup

public void addGroupToGroup(String childGroup,
                            String parentGroup)
                     throws InvalidMembershipException,
                            GroupNotFoundException,
                            MembershipAlreadyExistsException

Specified by:

addGroupToGroup in interface RemoteDirectory

Throws:

InvalidMembershipException

GroupNotFoundException

MembershipAlreadyExistsException

addAllGroupsToGroup

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

Specified by:

addAllGroupsToGroup in interface InternalRemoteDirectory

Throws:

GroupNotFoundException

removeUserFromGroup

public void removeUserFromGroup(String username,
                                String groupName)
                         throws MembershipNotFoundException,
                                GroupNotFoundException,
                                UserNotFoundException

Specified by:

removeUserFromGroup in interface RemoteDirectory

Throws:

MembershipNotFoundException

GroupNotFoundException

UserNotFoundException

removeUsersFromGroup

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

Specified by:

removeUsersFromGroup in interface InternalRemoteDirectory

Throws:

GroupNotFoundException

removeGroupFromGroup

public void removeGroupFromGroup(String childGroup,
                                 String parentGroup)
                          throws InvalidMembershipException,
                                 MembershipNotFoundException,
                                 GroupNotFoundException

Specified by:

removeGroupFromGroup in interface RemoteDirectory

Throws:

InvalidMembershipException

MembershipNotFoundException

GroupNotFoundException

removeGroupsFromGroup

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

Specified by:

removeGroupsFromGroup in interface InternalRemoteDirectory

Throws:

GroupNotFoundException

countDirectMembersOfGroup

public BoundedCount countDirectMembersOfGroup(String groupName,
                                              int querySizeHint)

Specified by:

countDirectMembersOfGroup in interface RemoteDirectory

searchGroupRelationships

public <T> List<T> searchGroupRelationships(MembershipQuery<T> query)

Specified by:

searchGroupRelationships in interface MultiValuesQueriesSupport

Specified by:

searchGroupRelationships in interface RemoteDirectory

searchGroupRelationshipsGroupedByName

public <T> com.google.common.collect.ListMultimap<String,T> searchGroupRelationshipsGroupedByName(MembershipQuery<T> query)

Specified by:

searchGroupRelationshipsGroupedByName in interface MultiValuesQueriesSupport

testConnection

public void testConnection()
                    throws OperationFailedException

Does nothing, connection is determined by the ability to communicate with the database. Crowd wouldn't have started if the database connection failed.

Specified by:

testConnection in interface RemoteDirectory

Throws:

OperationFailedException

supportsInactiveAccounts

public boolean supportsInactiveAccounts()

Internal directories always support inactive accounts.

Specified by:

supportsInactiveAccounts in interface RemoteDirectory

Returns:

true, always

supportsNestedGroups

public boolean supportsNestedGroups()

Specified by:

supportsNestedGroups in interface RemoteDirectory

Returns:

true because Internal Directories support nested groups as of Crowd 2.0.

supportsPasswordExpiration

public boolean supportsPasswordExpiration()

Internal Directories always support expiring passwords

Specified by:

supportsPasswordExpiration in interface RemoteDirectory

Returns:

true, always.

supportsSettingEncryptedCredential

public boolean supportsSettingEncryptedCredential()

Internal directories always support setting passwords by hash.

Specified by:

supportsSettingEncryptedCredential in interface RemoteDirectory

Returns:

true, always.

isRolesDisabled

public boolean isRolesDisabled()

Specified by:

isRolesDisabled in interface RemoteDirectory

getMemberships

public Iterable<Membership> getMemberships()
                                    throws OperationFailedException

Specified by:

getMemberships in interface RemoteDirectory

Throws:

OperationFailedException

getAuthoritativeDirectory

public RemoteDirectory getAuthoritativeDirectory()

Specified by:

getAuthoritativeDirectory in interface RemoteDirectory

expireAllPasswords

public void expireAllPasswords()

Specified by:

expireAllPasswords in interface RemoteDirectory

getUserAvatarByName

public AvatarReference getUserAvatarByName(String username,
                                           int sizeHint)
                                    throws OperationFailedException

Specified by:

getUserAvatarByName in interface RemoteDirectory

Throws:

OperationFailedException