com.atlassian.crowd.directory

Class RemoteCrowdDirectory

java.lang.Object

com.atlassian.crowd.directory.RemoteCrowdDirectory

All Implemented Interfaces:

RemoteDirectory, Attributes

public class RemoteCrowdDirectory
extends Object
implements RemoteDirectory

A RemoteDirectory that allows integration with a remote Crowd server.

This class performs all directory operations against a remote Crowd server. The remote Crowd server sees this class as an application.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_NAME Directory attribute key for application name
static String	APPLICATION_PASSWORD Directory attribute key for application password
protected AttributeValuesHolder	attributes
static String	AUTHENTICATION_METHOD_ATTRIBUTE Directory attribute key for the authentication method (AuthenticationMethod).
static String	CROWD_HTTP_MAX_CONNECTIONS Directory attribute key for max connections.
static String	CROWD_HTTP_PROXY_HOST Directory attribute key for http proxy host.
static String	CROWD_HTTP_PROXY_PASSWORD Directory attribute key for http proxy password.
static String	CROWD_HTTP_PROXY_PORT Directory attribute key for http proxy port.
static String	CROWD_HTTP_PROXY_USERNAME Directory attribute key for http proxy username.
static String	CROWD_HTTP_TIMEOUT Directory attribute key for http timeout.
static String	CROWD_SERVER_URL Directory attribute key for remote Crowd server URL
static String	DESCRIPTIVE_NAME

Constructor Summary

Constructors

Constructor and Description
RemoteCrowdDirectory(com.atlassian.crowd.service.factory.CrowdClientFactory crowdClientFactory) Creates a new RemoteCrowdDirectory using the given CrowdClientFactory.

Method Summary

Modifier and Type	Method and 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 username, 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 com.atlassian.crowd.service.client.ClientProperties	getClientProperties()
com.atlassian.crowd.service.client.CrowdClient	getCrowdClient() Access the Crowd client used for communication with the remote Crowd directory, intended for internal reuse only.
String	getCurrentEventToken() Returns a token that can be used for querying events that have happened after the token was generated.
String	getDescriptiveName()
long	getDirectoryId()
Set<String>	getKeys()
Iterable<Membership>	getMemberships()
Events	getNewEvents(String eventToken) Returns an events object which contains a new eventToken and events that happened after the given eventToken was generated.
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)
void	removeGroup(String groupname)
void	removeGroupAttributes(String groupName, String attributeName)
void	removeGroupFromGroup(String childGroup, String parentGroup)
void	removeUser(String username)
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) Called by the DirectoryInstanceLoader after constructing an InternalDirectory.
void	setDirectoryId(long directoryId)
void	storeGroupAttributes(String groupName, Map<String,Set<String>> attributes)
void	storeUserAttributes(String username, Map<String,Set<String>> attributes)
boolean	supportsInactiveAccounts() Remote crowd directories always support inactive accounts.
boolean	supportsNestedGroups()
boolean	supportsPasswordExpiration()
boolean	supportsSettingEncryptedCredential()
void	testConnection()
Group	updateGroup(GroupTemplate group)
User	updateUser(UserTemplate user)
void	updateUserCredential(String username, PasswordCredential credential)
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.RemoteDirectory

getLocallyFilteredGroupNames, getUserAvatarByName, updateUserFromRemoteDirectory

Field Detail

DESCRIPTIVE_NAME

public static final String DESCRIPTIVE_NAME

See Also:

Constant Field Values

APPLICATION_NAME

public static final String APPLICATION_NAME

Directory attribute key for application name

See Also:

Constant Field Values

APPLICATION_PASSWORD

public static final String APPLICATION_PASSWORD

Directory attribute key for application password

See Also:

Constant Field Values

CROWD_SERVER_URL

public static final String CROWD_SERVER_URL

Directory attribute key for remote Crowd server URL

See Also:

Constant Field Values

AUTHENTICATION_METHOD_ATTRIBUTE

public static final String AUTHENTICATION_METHOD_ATTRIBUTE

Directory attribute key for the authentication method (AuthenticationMethod).

See Also:

Constant Field Values

CROWD_HTTP_TIMEOUT

public static final String CROWD_HTTP_TIMEOUT

Directory attribute key for http timeout.

See Also:

Constant Field Values

CROWD_HTTP_MAX_CONNECTIONS

public static final String CROWD_HTTP_MAX_CONNECTIONS

Directory attribute key for max connections.

See Also:

Constant Field Values

CROWD_HTTP_PROXY_HOST

public static final String CROWD_HTTP_PROXY_HOST

Directory attribute key for http proxy host.

See Also:

Constant Field Values

CROWD_HTTP_PROXY_PORT

public static final String CROWD_HTTP_PROXY_PORT

Directory attribute key for http proxy port.

See Also:

Constant Field Values

CROWD_HTTP_PROXY_USERNAME

public static final String CROWD_HTTP_PROXY_USERNAME

Directory attribute key for http proxy username.

See Also:

Constant Field Values

CROWD_HTTP_PROXY_PASSWORD

public static final String CROWD_HTTP_PROXY_PASSWORD

Directory attribute key for http proxy password.

See Also:

Constant Field Values

attributes

protected AttributeValuesHolder attributes

Constructor Detail

RemoteCrowdDirectory

public RemoteCrowdDirectory(com.atlassian.crowd.service.factory.CrowdClientFactory crowdClientFactory)

Creates a new RemoteCrowdDirectory using the given CrowdClientFactory.

Parameters:

crowdClientFactory - factory for creating a CrowdClient

Method Detail

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface RemoteDirectory

setDirectoryId

public void setDirectoryId(long directoryId)

Specified by:

setDirectoryId in interface RemoteDirectory

findUserByName

public User findUserByName(String name)
                    throws UserNotFoundException,
                           OperationFailedException

Specified by:

findUserByName in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

findUserWithAttributesByName

public UserWithAttributes findUserWithAttributesByName(String name)
                                                throws UserNotFoundException,
                                                       OperationFailedException

Specified by:

findUserWithAttributesByName in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

findUserByExternalId

public User findUserByExternalId(String externalId)
                          throws UserNotFoundException,
                                 OperationFailedException

Specified by:

findUserByExternalId in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

authenticate

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

Specified by:

authenticate in interface RemoteDirectory

Throws:

UserNotFoundException

InactiveAccountException

InvalidAuthenticationException

ExpiredCredentialException

OperationFailedException

addUser

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

Specified by:

addUser in interface RemoteDirectory

Throws:

InvalidUserException

InvalidCredentialException

OperationFailedException

addUser

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

Specified by:

addUser in interface RemoteDirectory

Throws:

InvalidUserException

InvalidCredentialException

OperationFailedException

expireAllPasswords

public void expireAllPasswords()
                        throws OperationFailedException

Specified by:

expireAllPasswords in interface RemoteDirectory

Throws:

OperationFailedException

updateUser

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

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

Specified by:

renameUser in interface RemoteDirectory

Throws:

UserNotFoundException

InvalidUserException

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 username)
                throws UserNotFoundException,
                       OperationFailedException

Specified by:

removeUser in interface RemoteDirectory

Throws:

UserNotFoundException

OperationFailedException

searchUsers

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

Specified by:

searchUsers in interface RemoteDirectory

Throws:

OperationFailedException

findGroupByName

public Group findGroupByName(String name)
                      throws GroupNotFoundException,
                             OperationFailedException

Specified by:

findGroupByName in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

findGroupWithAttributesByName

public GroupWithAttributes findGroupWithAttributesByName(String name)
                                                  throws GroupNotFoundException,
                                                         OperationFailedException

Specified by:

findGroupWithAttributesByName in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

addGroup

public Group addGroup(GroupTemplate group)
               throws InvalidGroupException,
                      OperationFailedException

Specified by:

addGroup in interface RemoteDirectory

Throws:

InvalidGroupException

OperationFailedException

updateGroup

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

Specified by:

updateGroup in interface RemoteDirectory

Throws:

InvalidGroupException

GroupNotFoundException

OperationFailedException

renameGroup

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 groupname)
                 throws GroupNotFoundException,
                        OperationFailedException

Specified by:

removeGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

OperationFailedException

searchGroups

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

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

Specified by:

addUserToGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

UserNotFoundException

OperationFailedException

MembershipAlreadyExistsException

addGroupToGroup

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

Specified by:

addGroupToGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

InvalidMembershipException

OperationFailedException

MembershipAlreadyExistsException

removeUserFromGroup

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

Specified by:

removeUserFromGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

UserNotFoundException

MembershipNotFoundException

OperationFailedException

removeGroupFromGroup

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

Specified by:

removeGroupFromGroup in interface RemoteDirectory

Throws:

GroupNotFoundException

InvalidMembershipException

MembershipNotFoundException

OperationFailedException

searchGroupRelationships

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

Specified by:

searchGroupRelationships in interface RemoteDirectory

Throws:

OperationFailedException

getCurrentEventToken

public String getCurrentEventToken()
                            throws OperationFailedException,
                                   IncrementalSynchronisationNotAvailableException

Returns a token that can be used for querying events that have happened after the token was generated.

If the event token has not changed since the last call to this method, it is guaranteed that no new events have been received.

The format of event token is implementation specific and can change without a warning.

Returns:

token that can be used for querying events that have happened after the token was generated

Throws:

UnsupportedCrowdApiException - if the remote server does not support this operation

OperationFailedException - if the operation has failed for any other reason, including invalid arguments

IncrementalSynchronisationNotAvailableException - if the application cannot provide incremental synchronisation

getNewEvents

public Events getNewEvents(String eventToken)
                    throws EventTokenExpiredException,
                           OperationFailedException

Returns an events object which contains a new eventToken and events that happened after the given eventToken was generated.

If for any reason event store is unable to retrieve events that happened after the event token was generated, an EventTokenExpiredException will be thrown. The caller is then expected to call getCurrentEventToken() again before asking for new events.

Parameters:

eventToken - event token that was retrieved by a call to getCurrentEventToken() or getNewEvents(String)

Returns:

events object which contains a new eventToken and events that happened after the given eventToken was generated

Throws:

EventTokenExpiredException - if events that happened after the event token was generated can not be retrieved

UnsupportedCrowdApiException - if the remote server does not support this operation

OperationFailedException - if the operation has failed for any other reason, including invalid arguments

testConnection

public void testConnection()
                    throws OperationFailedException

Specified by:

testConnection in interface RemoteDirectory

Throws:

OperationFailedException

supportsInactiveAccounts

public boolean supportsInactiveAccounts()

Remote crowd directories always support inactive accounts.

Specified by:

supportsInactiveAccounts in interface RemoteDirectory

Returns:

true

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

getDescriptiveName

public String getDescriptiveName()

Specified by:

getDescriptiveName in interface RemoteDirectory

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

getAuthoritativeDirectory

public RemoteDirectory getAuthoritativeDirectory()

Specified by:

getAuthoritativeDirectory in interface RemoteDirectory

getClientProperties

protected com.atlassian.crowd.service.client.ClientProperties getClientProperties()

getCrowdClient

public com.atlassian.crowd.service.client.CrowdClient getCrowdClient()
                                                              throws OperationFailedException

Access the Crowd client used for communication with the remote Crowd directory, intended for internal reuse only.

Throws:

OperationFailedException

getMemberships

public Iterable<Membership> getMemberships()
                                    throws OperationFailedException

Specified by:

getMemberships in interface RemoteDirectory

Throws:

OperationFailedException

userAuthenticated

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

Specified by:

userAuthenticated in interface RemoteDirectory

Throws:

OperationFailedException

UserNotFoundException

InactiveAccountException