com.atlassian.crowd.directory

Class AbstractForwardingToInternalRemoteDirectory

java.lang.Object

com.atlassian.crowd.directory.AbstractForwardingToRemoteDirectory

com.atlassian.crowd.directory.AbstractForwardingToInternalRemoteDirectory

All Implemented Interfaces:

InternalRemoteDirectory, RemoteDirectory, Attributes

Direct Known Subclasses:

DbCachingRemoteDirectory, DelegatedAuthenticationDirectory

@ParametersAreNonnullByDefault
public abstract class AbstractForwardingToInternalRemoteDirectory
extends AbstractForwardingToRemoteDirectory
implements InternalRemoteDirectory

A utility class which delegates (i.e. forwards) its method calls to an underlying InternalRemoteDirectory.

Concrete implementations can override any method requiring custom logic to the underlying directory

Constructor Summary

Constructors

Constructor and Description
AbstractForwardingToInternalRemoteDirectory()

Method Summary

Modifier and Type	Method and Description
BatchResult<Group>	addAllGroups(Set<GroupTemplate> groups) Adds a collection of groups to the directory.
BatchResult<User>	addAllUsers(Set<UserTemplateWithCredentialAndAttributes> users) Adds a collection of users to the directory.
BatchResult<String>	addAllUsersToGroup(Set<String> userNames, String groupName) Adds a collection of users to a group.
Group	addLocalGroup(GroupTemplate group) Adds a "local" group to the directory.
InternalDirectoryGroup	findGroupByName(String name) Finds the group that matches the supplied name.
TimestampedUser	findUserByExternalId(String externalId) Finds the user that matches the supplied externalId.
TimestampedUser	findUserByName(String name) Finds the user that matches the supplied name.
User	forceRenameUser(User oldUser, String newName) Forces a rename on the given user in this directory.
Set<String>	getAllUserExternalIds() Retrieves all users externalIds found in this directory.
protected abstract InternalRemoteDirectory	getDelegate()
long	getGroupCount()
long	getUserCount()
boolean	isLocalUserStatusEnabled() Returns true if user active status is updated independently in the Crowd cache and the remote directory.
BatchResult<String>	removeAllGroups(Set<String> groupNames) Removes all groups from the directory.
BatchResult<String>	removeAllUsers(Set<String> usernames) Removes all users from the directory.

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

addGroup, addGroupToGroup, addUser, addUser, addUserToGroup, authenticate, countDirectMembersOfGroup, expireAllPasswords, findGroupWithAttributesByName, findUserWithAttributesByName, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getKeys, getMemberships, getUserAvatarByName, getValue, getValues, isEmpty, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, supportsPasswordExpiration, supportsSettingEncryptedCredential, testConnection, updateGroup, updateUser, updateUserCredential, updateUserFromRemoteDirectory

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

addGroup, addGroupToGroup, addUser, addUser, addUserToGroup, authenticate, countDirectMembersOfGroup, expireAllPasswords, findGroupWithAttributesByName, findUserWithAttributesByName, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getMemberships, getUserAvatarByName, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, supportsPasswordExpiration, supportsSettingEncryptedCredential, testConnection, updateGroup, updateUser, updateUserCredential, updateUserFromRemoteDirectory, userAuthenticated

Methods inherited from interface com.atlassian.crowd.embedded.api.Attributes

getKeys, getValue, getValues, isEmpty

Constructor Detail

AbstractForwardingToInternalRemoteDirectory

public AbstractForwardingToInternalRemoteDirectory()

Method Detail

addLocalGroup

public Group addLocalGroup(GroupTemplate group)
                    throws InvalidGroupException,
                           OperationFailedException

Description copied from interface: InternalRemoteDirectory

Adds a "local" group to the directory.

This method can be used to store groups that aren't clones of "external" groups. For example, if an LDAP directory is cloned in an internal directory, it's possible to define "local" groups that exist internally but not in LDAP.

This functionality was added to meet the functionality that Confluence provided.

Specified by:

addLocalGroup in interface InternalRemoteDirectory

Parameters:

group - template of the group to add.

Returns:

the added group retrieved from the underlying store.

Throws:

InvalidGroupException - The supplied group is invalid.

OperationFailedException - underlying directory implementation failed to execute the operation.

addAllUsers

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

Description copied from interface: InternalRemoteDirectory

Adds a collection of users to the directory.

The bulk adding of users may be significantly faster than adding users one-by-one for large collections.

Caller must ensure that the users don't already exist.

Specified by:

addAllUsers in interface InternalRemoteDirectory

Parameters:

users - templates of users to add.

Returns:

result containing both successful and failed users

addAllGroups

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

Description copied from interface: InternalRemoteDirectory

Adds a collection of groups to the directory.

The bulk adding of groups may be significantly faster than adding groups one-by-one for large collections.

Caller must ensure that the users don't already exist.

Specified by:

addAllGroups in interface InternalRemoteDirectory

Parameters:

groups - templates of groups to add.

Returns:

result containing both successful and failed groups

addAllUsersToGroup

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

Description copied from interface: InternalRemoteDirectory

Adds a collection of users to a group.

Caller must ensure that the memberships don't already exist.

Specified by:

addAllUsersToGroup in interface InternalRemoteDirectory

Parameters:

userNames - names of users to add to group.

groupName - name of group to add users to.

Returns:

result containing both successful and failed users

Throws:

GroupNotFoundException - group with supplied groupName does not exist.

removeAllUsers

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

Description copied from interface: InternalRemoteDirectory

Removes all users from the directory.

If a user with the supplied username does not exist in the directory, the username will be ignored.

Specified by:

removeAllUsers in interface InternalRemoteDirectory

Parameters:

usernames - usernames of users to remove.

Returns:

batch result containing successes (removed users) and failures (users which were not removed)

removeAllGroups

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

Description copied from interface: InternalRemoteDirectory

Removes all groups from the directory.

If a group with the supplied group name does not exist in the directory, the group name will be ignored.

Specified by:

removeAllGroups in interface InternalRemoteDirectory

Parameters:

groupNames - names of groups to remove.

Returns:

batch result containing successes (removed groups) and failures (groups which were not removed)

isLocalUserStatusEnabled

public boolean isLocalUserStatusEnabled()

Description copied from interface: InternalRemoteDirectory

Returns true if user active status is updated independently in the Crowd cache and the remote directory. Otherwise, user status is synchronised between the cache and the remote directory.

Specified by:

isLocalUserStatusEnabled in interface InternalRemoteDirectory

Returns:

true if user status in the cache is updated independently of the remote directory.

forceRenameUser

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

Description copied from interface: InternalRemoteDirectory

Forces a rename on the given user in this directory. This works like RemoteDirectory.renameUser(String, String), except it will still do the rename even if there is an existing user under the newName. In this case, it will first rename that existing user to a name that is known not to exist in this directory.

Specified by:

forceRenameUser in interface InternalRemoteDirectory

Parameters:

oldUser - the existing user.

newName - desired name of user.

Returns:

renamed user.

Throws:

UserNotFoundException - if the "oldUser" does not exist.

See Also:

RemoteDirectory.renameUser(String, String)

getAllUserExternalIds

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

Description copied from interface: InternalRemoteDirectory

Retrieves all users externalIds found in this directory.

Specified by:

getAllUserExternalIds in interface InternalRemoteDirectory

Returns:

set of all users externalIds

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

getUserCount

public long getUserCount()
                  throws OperationFailedException

Specified by:

getUserCount in interface InternalRemoteDirectory

Returns:

number of users found in this directory.

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

getGroupCount

public long getGroupCount()
                   throws OperationFailedException

Specified by:

getGroupCount in interface InternalRemoteDirectory

Returns:

number of groups found in this directory.

Throws:

OperationFailedException - underlying directory implementation failed to execute the operation.

findUserByExternalId

@Nonnull
public TimestampedUser findUserByExternalId(String externalId)
                                              throws UserNotFoundException

Description copied from interface: RemoteDirectory

Finds the user that matches the supplied externalId. This is an optional method that may not be implemented on all directory types. Currently it is implemented for LDAP and Internal directories but not Crowd directories.

Specified by:

findUserByExternalId in interface InternalRemoteDirectory

Specified by:

findUserByExternalId in interface RemoteDirectory

Overrides:

findUserByExternalId in class AbstractForwardingToRemoteDirectory

Parameters:

externalId - the externalId of the user

Returns:

the user that matches the supplied externalId.

Throws:

UserNotFoundException - a user with the supplied externalId does not exist.

See Also:

RemoteDirectory.findUserByName(String)

findUserByName

@Nonnull
public TimestampedUser findUserByName(String name)
                                        throws UserNotFoundException

Description copied from interface: RemoteDirectory

Finds the user that matches the supplied name.

Specified by:

findUserByName in interface InternalRemoteDirectory

Specified by:

findUserByName in interface RemoteDirectory

Overrides:

findUserByName in class AbstractForwardingToRemoteDirectory

Parameters:

name - the name of the user (username).

Returns:

user entity.

Throws:

UserNotFoundException - a user with the supplied name does not exist.

findGroupByName

@Nonnull
public InternalDirectoryGroup findGroupByName(String name)
                                                throws GroupNotFoundException

Description copied from interface: RemoteDirectory

Finds the group that matches the supplied name.

Specified by:

findGroupByName in interface InternalRemoteDirectory

Specified by:

findGroupByName in interface RemoteDirectory

Overrides:

findGroupByName in class AbstractForwardingToRemoteDirectory

Parameters:

name - the name of the group.

Returns:

group entity.

Throws:

GroupNotFoundException - a group with the supplied name does not exist.

getDelegate

protected abstract InternalRemoteDirectory getDelegate()

Specified by:

getDelegate in class AbstractForwardingToRemoteDirectory

Returns:

the directory to delegate method calls to