Package com.atlassian.crowd.directory

Class AbstractForwardingDirectory

java.lang.Object

com.atlassian.crowd.directory.AbstractForwardingDirectory

All Implemented Interfaces:

RemoteDirectory, Attributes

Direct Known Subclasses:

DelegatedAuthenticationDirectory

@ParametersAreNonnullByDefault
public abstract class AbstractForwardingDirectory
extends Object
implements RemoteDirectory

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

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

Since:

v2.9

Constructor Summary

Constructors

Constructor	Description
AbstractForwardingDirectory()

Method Summary

Modifier and Type	Method	Description
Group	addGroup(GroupTemplate group)
void	addGroupToGroup(String childGroup, String parentGroup)
User	addUser(UserTemplate user, PasswordCredential credential)
UserWithAttributes	addUser(UserTemplateWithAttributes user, PasswordCredential credential)
void	addUserToGroup(String username, String groupName)
User	authenticate(String name, PasswordCredential credential)
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()
protected abstract RemoteDirectory	getDelegate()
String	getDescriptiveName()
long	getDirectoryId()
Set<String>	getKeys()
Iterable<Membership>	getMemberships()
AvatarReference	getUserAvatarByName(String username, int sizeHint)
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()
void	testConnection()
Group	updateGroup(GroupTemplate group)
User	updateUser(UserTemplate user)
void	updateUserCredential(String username, PasswordCredential credential)
User	updateUserFromRemoteDirectory(User remoteUser)

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, userAuthenticated

Constructor Details

AbstractForwardingDirectory

public AbstractForwardingDirectory()

Method Details

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface RemoteDirectory

setDirectoryId

public void setDirectoryId(long directoryId)

Specified by:

setDirectoryId in interface RemoteDirectory

getDescriptiveName

@Nonnull
public String getDescriptiveName()

Specified by:

getDescriptiveName in interface RemoteDirectory

setAttributes

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

Specified by:

setAttributes in interface RemoteDirectory

findUserByName

@Nonnull
public User findUserByName(String name)
                    throws UserNotFoundException,
OperationFailedException

Specified by:

findUserByName in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

findUserWithAttributesByName

@Nonnull
public UserWithAttributes findUserWithAttributesByName(String name)
                                                throws UserNotFoundException,
OperationFailedException

Specified by:

findUserWithAttributesByName in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

findUserByExternalId

@Nonnull
public User findUserByExternalId(String externalId)
                          throws UserNotFoundException,
OperationFailedException

Specified by:

findUserByExternalId in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

authenticate

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

Specified by:

authenticate in interface RemoteDirectory

Throws:

UserNotFoundException

InactiveAccountException

InvalidAuthenticationException

ExpiredCredentialException

OperationFailedException

addUser

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

Specified by:

addUser in interface RemoteDirectory

Throws:

InvalidUserException

InvalidCredentialException

UserAlreadyExistsException

OperationFailedException

addUser

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

Specified by:

addUser in interface RemoteDirectory

Throws:

InvalidUserException

InvalidCredentialException

UserAlreadyExistsException

OperationFailedException

updateUser

@Nonnull
public User updateUser(UserTemplate user)
                throws InvalidUserException,
UserNotFoundException,
OperationFailedException

Specified by:

updateUser in interface RemoteDirectory

Throws:

InvalidUserException

UserNotFoundException

OperationFailedException

updateUserCredential

public void updateUserCredential(String username,
 PasswordCredential credential)
                          throws UserNotFoundException,
InvalidCredentialException,
OperationFailedException

Specified by:

updateUserCredential in interface RemoteDirectory

Throws:

UserNotFoundException

InvalidCredentialException

OperationFailedException

renameUser

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

Specified by:

renameUser in interface RemoteDirectory

Throws:

UserNotFoundException

InvalidUserException

UserAlreadyExistsException

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,
OperationFailedException

Specified by:

removeUserAttributes in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

removeUser

public void removeUser(String name)
                throws UserNotFoundException,
OperationFailedException

Specified by:

removeUser in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

searchUsers

@Nonnull
public <T> List<T> searchUsers(EntityQuery<T> query)
                        throws OperationFailedException

Specified by:

searchUsers in interface RemoteDirectory

Throws:

OperationFailedException

findGroupByName

@Nonnull
public Group findGroupByName(String name)
                      throws GroupNotFoundException,
OperationFailedException

Specified by:

findGroupByName in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

findGroupWithAttributesByName

@Nonnull
public GroupWithAttributes findGroupWithAttributesByName(String name)
                                                  throws GroupNotFoundException,
OperationFailedException

Specified by:

findGroupWithAttributesByName in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

addGroup

@Nonnull
public Group addGroup(GroupTemplate group)
               throws InvalidGroupException,
OperationFailedException

Specified by:

addGroup in interface RemoteDirectory

Throws:

InvalidGroupException

OperationFailedException

updateGroup

@Nonnull
public Group updateGroup(GroupTemplate group)
                  throws InvalidGroupException,
GroupNotFoundException,
ReadOnlyGroupException,
OperationFailedException

Specified by:

updateGroup in interface RemoteDirectory

Throws:

InvalidGroupException

GroupNotFoundException

ReadOnlyGroupException

OperationFailedException

renameGroup

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

Specified by:

renameGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

InvalidGroupException

OperationFailedException

storeGroupAttributes

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

Specified by:

storeGroupAttributes in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

removeGroupAttributes

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

Specified by:

removeGroupAttributes in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

removeGroup

public void removeGroup(String name)
                 throws GroupNotFoundException,
ReadOnlyGroupException,
OperationFailedException

Specified by:

removeGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

ReadOnlyGroupException

OperationFailedException

searchGroups

@Nonnull
public <T> List<T> searchGroups(EntityQuery<T> query)
                         throws OperationFailedException

Specified by:

searchGroups in interface RemoteDirectory

Throws:

OperationFailedException

isUserDirectGroupMember

public boolean isUserDirectGroupMember(String username,
 String groupName)
                                throws OperationFailedException

Specified by:

isUserDirectGroupMember in interface RemoteDirectory

Throws:

OperationFailedException

isGroupDirectGroupMember

public boolean isGroupDirectGroupMember(String childGroup,
 String parentGroup)
                                 throws OperationFailedException

Specified by:

isGroupDirectGroupMember in interface RemoteDirectory

Throws:

OperationFailedException

countDirectMembersOfGroup

@Nonnull
public BoundedCount countDirectMembersOfGroup(String groupName,
 int querySizeHint)
                                       throws OperationFailedException

Specified by:

countDirectMembersOfGroup in interface RemoteDirectory

Throws:

OperationFailedException

addUserToGroup

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

Specified by:

addUserToGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

UserNotFoundException

ReadOnlyGroupException

OperationFailedException

MembershipAlreadyExistsException

addGroupToGroup

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

Specified by:

addGroupToGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

InvalidMembershipException

ReadOnlyGroupException

OperationFailedException

MembershipAlreadyExistsException

removeUserFromGroup

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

Specified by:

removeUserFromGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

UserNotFoundException

MembershipNotFoundException

ReadOnlyGroupException

OperationFailedException

removeGroupFromGroup

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

Specified by:

removeGroupFromGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

InvalidMembershipException

MembershipNotFoundException

ReadOnlyGroupException

OperationFailedException

searchGroupRelationships

@Nonnull
public <T> List<T> searchGroupRelationships(MembershipQuery<T> query)
                                     throws OperationFailedException

Specified by:

searchGroupRelationships in interface RemoteDirectory

Throws:

OperationFailedException

testConnection

public void testConnection()
                    throws OperationFailedException

Specified by:

testConnection in interface RemoteDirectory

Throws:

OperationFailedException

supportsInactiveAccounts

public boolean supportsInactiveAccounts()

Specified by:

supportsInactiveAccounts in interface RemoteDirectory

supportsNestedGroups

public boolean supportsNestedGroups()

Specified by:

supportsNestedGroups in interface RemoteDirectory

supportsPasswordExpiration

public boolean supportsPasswordExpiration()

Specified by:

supportsPasswordExpiration in interface RemoteDirectory

supportsSettingEncryptedCredential

public boolean supportsSettingEncryptedCredential()

Specified by:

supportsSettingEncryptedCredential in interface RemoteDirectory

isRolesDisabled

public boolean isRolesDisabled()

Specified by:

isRolesDisabled in interface RemoteDirectory

getMemberships

@Nonnull
public Iterable<Membership> getMemberships()
                                    throws OperationFailedException

Specified by:

getMemberships in interface RemoteDirectory

Throws:

OperationFailedException

getAuthoritativeDirectory

@Nonnull
public RemoteDirectory getAuthoritativeDirectory()

Specified by:

getAuthoritativeDirectory in interface RemoteDirectory

expireAllPasswords

public void expireAllPasswords()
                        throws OperationFailedException

Specified by:

expireAllPasswords in interface RemoteDirectory

Throws:

OperationFailedException

getValues

@Nullable
public Set<String> getValues(String key)

Specified by:

getValues in interface Attributes

getValue

public String getValue(String key)

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

getUserAvatarByName

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

Specified by:

getUserAvatarByName in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

updateUserFromRemoteDirectory

public User updateUserFromRemoteDirectory(User remoteUser)
                                   throws OperationFailedException,
UserNotFoundException

Specified by:

updateUserFromRemoteDirectory in interface RemoteDirectory

Throws:

OperationFailedException

UserNotFoundException

getDelegate

protected abstract RemoteDirectory getDelegate()

Returns:

the directory to delegate method calls to