|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.crowd.directory.RemoteCrowdDirectory
public class RemoteCrowdDirectory
A RemoteDirectory
that allows integration with a remote Crowd server.
Field Summary | |
---|---|
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 |
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 | |
---|---|
RemoteCrowdDirectory(CrowdClientFactory crowdClientFactory)
Creates a new RemoteCrowdDirectory using the given CrowdClientFactory. |
Method Summary | ||
---|---|---|
Group |
addGroup(GroupTemplate group)
Adds a group to the directory store. |
|
void |
addGroupToGroup(String childGroup,
String parentGroup)
Adds a group as a member of a parent group. |
|
User |
addUser(UserTemplate user,
PasswordCredential credential)
Adds a user to the directory store. |
|
void |
addUserToGroup(String username,
String groupName)
Adds a user as a member of a group. |
|
User |
authenticate(String username,
PasswordCredential credential)
Authenticates a user with the directory store. |
|
Group |
findGroupByName(String name)
Finds the group that matches the supplied name . |
|
GroupWithAttributes |
findGroupWithAttributesByName(String name)
Finds the group that matches the supplied name . |
|
User |
findUserByName(String name)
Finds the user that matches the supplied name . |
|
UserWithAttributes |
findUserWithAttributesByName(String name)
Finds the user that matches the supplied name . |
|
RemoteDirectory |
getAuthoritativeDirectory()
|
|
protected ClientProperties |
getClientProperties()
|
|
String |
getCurrentEventToken()
Returns a token that can be used for querying events that have happened after the token was generated. |
|
String |
getDescriptiveName()
Returns a descriptive name for the type of directory. |
|
long |
getDirectoryId()
Gets the internal unique directoryId of the directory store. |
|
Set<String> |
getKeys()
Gets all the keys of the attributes. |
|
Iterable<Membership> |
getMemberships()
Get an iterable view of the available group memberships. |
|
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)
Returns any value associated with the given key, returns null if there is no value. |
|
Set<String> |
getValues(String name)
Get all the values associated with a given key. |
|
boolean |
isEmpty()
|
|
boolean |
isGroupDirectGroupMember(String childGroup,
String parentGroup)
Determines if a group is a direct member of another group. |
|
boolean |
isRolesDisabled()
Expose whether the directory has roles disabled. |
|
boolean |
isUserDirectGroupMember(String username,
String groupName)
Determines if a user is a direct member of a group. |
|
void |
removeGroup(String groupname)
Removes the group that matches the supplied name . |
|
void |
removeGroupAttributes(String groupName,
String attributeName)
Removes all the values for a single attribute key for a group. |
|
void |
removeGroupFromGroup(String childGroup,
String parentGroup)
Removes a group as a member of a parent group. |
|
void |
removeUser(String username)
Removes the user that matches the supplied name . |
|
void |
removeUserAttributes(String username,
String attributeName)
Removes all the values for a single attribute key for a user. |
|
void |
removeUserFromGroup(String username,
String groupName)
Removes a user as a member of a group. |
|
Group |
renameGroup(String oldName,
String newName)
Renames a group . |
|
User |
renameUser(String oldName,
String newName)
Renames a user . |
|
|
searchGroupRelationships(MembershipQuery<T> query)
Searches for membership information. |
|
|
searchGroups(EntityQuery<T> query)
Searches for groups that match the supplied query criteria. |
|
|
searchUsers(EntityQuery<T> query)
Searches for users that match the supplied query criteria. |
|
void |
setAttributes(Map<String,String> attributes)
Called by the DirectoryInstanceLoader after
constructing an InternalDirectory. |
|
void |
setDirectoryId(long directoryId)
When a directory store is loaded, the directoryId will be set by the
crowd framework. |
|
void |
storeGroupAttributes(String groupName,
Map<String,Set<String>> attributes)
Adds or updates a group's attributes with the new Map of attribute values in the directory specified by the passed in directoryId . |
|
void |
storeUserAttributes(String username,
Map<String,Set<String>> attributes)
Adds or updates a user's attributes with the new Map of attribute values in the directory specified by the passed in directoryId . |
|
boolean |
supportsInactiveAccounts()
Remote crowd directories always support inactive accounts. |
|
boolean |
supportsNestedGroups()
Allows us to only display nested-group related UI for directories that support it. |
|
void |
testConnection()
Test if a connection to the directory server can be established. |
|
Group |
updateGroup(GroupTemplate group)
Updates the group . |
|
User |
updateUser(UserTemplate user)
Updates the user . |
|
void |
updateUserCredential(String username,
PasswordCredential credential)
Updates the password for a user . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DESCRIPTIVE_NAME
public static final String APPLICATION_NAME
public static final String APPLICATION_PASSWORD
public static final String CROWD_SERVER_URL
public static final String CROWD_HTTP_TIMEOUT
public static final String CROWD_HTTP_MAX_CONNECTIONS
public static final String CROWD_HTTP_PROXY_HOST
public static final String CROWD_HTTP_PROXY_PORT
public static final String CROWD_HTTP_PROXY_USERNAME
public static final String CROWD_HTTP_PROXY_PASSWORD
protected AttributeValuesHolder attributes
Constructor Detail |
---|
public RemoteCrowdDirectory(CrowdClientFactory crowdClientFactory)
crowdClientFactory
- factory for creating a CrowdClient
Method Detail |
---|
public long getDirectoryId()
RemoteDirectory
directoryId
of the directory store.
getDirectoryId
in interface RemoteDirectory
directoryId
.public void setDirectoryId(long directoryId)
RemoteDirectory
directoryId
will be set by the
crowd framework.
setDirectoryId
in interface RemoteDirectory
directoryId
- The unique directoryId
of the DirectoryImpl
stored in the database.public User findUserByName(String name) throws UserNotFoundException, OperationFailedException
RemoteDirectory
user
that matches the supplied name
.
findUserByName
in interface RemoteDirectory
name
- the name of the user (username).
UserNotFoundException
- a user with the supplied name does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public UserWithAttributes findUserWithAttributesByName(String name) throws UserNotFoundException, OperationFailedException
RemoteDirectory
user
that matches the supplied name
.
findUserWithAttributesByName
in interface RemoteDirectory
name
- the name of the user (username).
UserNotFoundException
- a user with the supplied name does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public User authenticate(String username, PasswordCredential credential) throws UserNotFoundException, InactiveAccountException, InvalidAuthenticationException, ExpiredCredentialException, OperationFailedException
RemoteDirectory
user
with the directory store.
authenticate
in interface RemoteDirectory
username
- The name of the user (username).credential
- The supplied credentials (password).
UserNotFoundException
- The user wth the supplied name does not exist.
InactiveAccountException
- The supplied user is inactive.
InvalidAuthenticationException
- Authentication with the provided credentials failed.
ExpiredCredentialException
- The user's credentials have expired. The user must change their credentials in order to successfully authenticate.
OperationFailedException
- underlying directory implementation failed to execute the operation.public User addUser(UserTemplate user, PasswordCredential credential) throws InvalidUserException, InvalidCredentialException, OperationFailedException
RemoteDirectory
user
to the directory store.
addUser
in interface RemoteDirectory
user
- template of the user to add.credential
- password. May be null, since JIRA creates a user in two steps (user THEN password)
InvalidUserException
- The supplied user is invalid.
InvalidCredentialException
- The supplied credential is invalid.
OperationFailedException
- underlying directory implementation failed to execute the operation.public User updateUser(UserTemplate user) throws InvalidUserException, UserNotFoundException, OperationFailedException
RemoteDirectory
user
.
updateUser
in interface RemoteDirectory
user
- The user to update.
InvalidUserException
- the supplied user is invalid.
UserNotFoundException
- the user does not exist in the directory store.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void updateUserCredential(String username, PasswordCredential credential) throws UserNotFoundException, InvalidCredentialException, OperationFailedException
RemoteDirectory
password
for a user
.
updateUserCredential
in interface RemoteDirectory
username
- The name of the user (username).credential
- The new credential (password).
UserNotFoundException
- The user does not exist.
InvalidCredentialException
- The supplied credential is invalid.
OperationFailedException
- underlying directory implementation failed to execute the operation.public User renameUser(String oldName, String newName) throws UserNotFoundException, InvalidUserException
RemoteDirectory
user
.
renameUser
in interface RemoteDirectory
oldName
- name of existing user.newName
- desired name of user.
UserNotFoundException
- if the user with the existing name does not exist.
InvalidUserException
- if the new username is invalid.public void storeUserAttributes(String username, Map<String,Set<String>> attributes) throws UserNotFoundException, OperationFailedException
RemoteDirectory
directoryId
.
The attributes map represents new or updated attributes and does not replace existing attributes unless the key of an attribute
matches the key of an existing
Attributes with values of empty sets are not added (these attributes are effectively removed).
storeUserAttributes
in interface RemoteDirectory
username
- name of user to update.attributes
- new or updated attributes (attributes that don't need changing should not appear in this Map).
UserNotFoundException
- user with supplied username does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeUserAttributes(String username, String attributeName) throws UserNotFoundException, OperationFailedException
RemoteDirectory
removeUserAttributes
in interface RemoteDirectory
username
- name of the user to update.attributeName
- name of attribute to remove.
UserNotFoundException
- user with supplied username does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeUser(String username) throws UserNotFoundException, OperationFailedException
RemoteDirectory
user
that matches the supplied name
.
removeUser
in interface RemoteDirectory
username
- The name of the user (username).
UserNotFoundException
- The user does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public <T> List<T> searchUsers(EntityQuery<T> query) throws OperationFailedException
RemoteDirectory
users
that match the supplied query criteria.
searchUsers
in interface RemoteDirectory
query
- EntityQuery for Entity.USER.
List<User
>
or List<String
>
of users/usernames
matching the search criteria. An empty List
will be returned
if no users matching the criteria are found.
OperationFailedException
- if the underlying directory implementation failed to execute the operationpublic Group findGroupByName(String name) throws GroupNotFoundException, OperationFailedException
RemoteDirectory
group
that matches the supplied name
.
findGroupByName
in interface RemoteDirectory
name
- the name of the group.
GroupNotFoundException
- a group with the supplied name does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public GroupWithAttributes findGroupWithAttributesByName(String name) throws GroupNotFoundException, OperationFailedException
RemoteDirectory
group
that matches the supplied name
.
findGroupWithAttributesByName
in interface RemoteDirectory
name
- the name of the group.
GroupNotFoundException
- a group with the supplied name does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public Group addGroup(GroupTemplate group) throws InvalidGroupException, OperationFailedException
RemoteDirectory
group
to the directory store.
addGroup
in interface RemoteDirectory
group
- template of the group to add.
InvalidGroupException
- The supplied group is invalid.
OperationFailedException
- underlying directory implementation failed to execute the operation.public Group updateGroup(GroupTemplate group) throws InvalidGroupException, GroupNotFoundException, OperationFailedException
RemoteDirectory
group
.
updateGroup
in interface RemoteDirectory
group
- The group to update.
InvalidGroupException
- the supplied group is invalid.
GroupNotFoundException
- the group does not exist in the directory store.
OperationFailedException
- underlying directory implementation failed to execute the operation.public Group renameGroup(String oldName, String newName) throws GroupNotFoundException, InvalidGroupException, OperationFailedException
RemoteDirectory
group
.
renameGroup
in interface RemoteDirectory
oldName
- name of existing group.newName
- desired name of group.
GroupNotFoundException
- if the group with the existing name does not exist.
InvalidGroupException
- if the new groupname is invalid or already exists in the directory.
OperationFailedException
- if the underlying directory implementation failed to execute the operation.public void storeGroupAttributes(String groupName, Map<String,Set<String>> attributes) throws GroupNotFoundException, OperationFailedException
RemoteDirectory
directoryId
.
The attributes map represents new or updated attributes and does not replace existing attributes unless the key of an attribute
matches the key of an existing
Attributes with values of empty sets are not added (these attributes are effectively removed).
storeGroupAttributes
in interface RemoteDirectory
groupName
- name of group to update.attributes
- new or updated attributes (attributes that don't need changing should not appear in this Map).
GroupNotFoundException
- group with supplied groupName does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeGroupAttributes(String groupName, String attributeName) throws GroupNotFoundException, OperationFailedException
RemoteDirectory
removeGroupAttributes
in interface RemoteDirectory
groupName
- name of the group to update.attributeName
- name of attribute to remove.
GroupNotFoundException
- group with supplied groupName does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeGroup(String groupname) throws GroupNotFoundException, OperationFailedException
RemoteDirectory
group
that matches the supplied name
.
removeGroup
in interface RemoteDirectory
groupname
- The name of the group.
GroupNotFoundException
- The group does not exist.
OperationFailedException
- underlying directory implementation failed to execute the operation.public <T> List<T> searchGroups(EntityQuery<T> query) throws OperationFailedException
RemoteDirectory
groups
that match the supplied query criteria.
searchGroups
in interface RemoteDirectory
query
- EntityQuery for Entity.GROUP.
List
or List
of groups/groupnames
matching the search criteria. An empty List
will be returned
if no groups matching the criteria are found.
OperationFailedException
- if the underlying directory implementation failed to execute the operationpublic boolean isUserDirectGroupMember(String username, String groupName) throws OperationFailedException
RemoteDirectory
isUserDirectGroupMember
in interface RemoteDirectory
username
- name of user.groupName
- name of group.
true
iff the user is a direct member of the group.
OperationFailedException
- underlying directory implementation failed to execute the operation.public boolean isGroupDirectGroupMember(String childGroup, String parentGroup) throws OperationFailedException
RemoteDirectory
isGroupDirectGroupMember
in interface RemoteDirectory
childGroup
- name of child group.parentGroup
- name of parent group.
true
iff the childGroup is a direct member of the parentGroup.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void addUserToGroup(String username, String groupName) throws GroupNotFoundException, UserNotFoundException, OperationFailedException
RemoteDirectory
childGroup
will
appear as members of parentGroup
to querying applications.
addUserToGroup
in interface RemoteDirectory
username
- The user that will become a member of groupName
groupName
- The group that will gain a new member.
GroupNotFoundException
- If the group cannot be found.
UserNotFoundException
- If the user cannot be found.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void addGroupToGroup(String childGroup, String parentGroup) throws GroupNotFoundException, InvalidMembershipException, OperationFailedException
RemoteDirectory
addGroupToGroup
in interface RemoteDirectory
childGroup
- The group that will become a member of parentGroup
parentGroup
- The group that will gain a new member
GroupNotFoundException
- One or both of the groups cannot be found.
InvalidMembershipException
- if the childGroup and parentGroup exist but are of different GroupTypes.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeUserFromGroup(String username, String groupName) throws GroupNotFoundException, UserNotFoundException, MembershipNotFoundException, OperationFailedException
RemoteDirectory
removeUserFromGroup
in interface RemoteDirectory
username
- The user that will be removed from parentGroup
groupName
- The group that will lose the member.
GroupNotFoundException
- If the group cannot be found.
UserNotFoundException
- If the user cannot be found.
MembershipNotFoundException
- if the user is not a direct member of the group.
OperationFailedException
- underlying directory implementation failed to execute the operation.public void removeGroupFromGroup(String childGroup, String parentGroup) throws GroupNotFoundException, InvalidMembershipException, MembershipNotFoundException, OperationFailedException
RemoteDirectory
removeGroupFromGroup
in interface RemoteDirectory
childGroup
- The group that will be removed from parentGroup
parentGroup
- The group that will lose the member.
GroupNotFoundException
- One or both of the groups cannot be found.
InvalidMembershipException
- if the childGroup and parentGroup exist but are of different GroupTypes.
MembershipNotFoundException
- if the childGroup is not a direct member of the parentGroup.
OperationFailedException
- underlying directory implementation failed to execute the operation.public <T> List<T> searchGroupRelationships(MembershipQuery<T> query) throws OperationFailedException
RemoteDirectory
searchGroupRelationships
in interface RemoteDirectory
query
- query for memberships.
OperationFailedException
- underlying directory implementation failed to execute the operation.public String getCurrentEventToken() throws OperationFailedException, IncrementalSynchronisationNotAvailableException
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 synchronisationpublic Events getNewEvents(String eventToken) throws EventTokenExpiredException, OperationFailedException
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.
eventToken
- event token that was retrieved by a call to getCurrentEventToken()
or getNewEvents(String)
eventToken
was generated
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 argumentspublic void testConnection() throws OperationFailedException
RemoteDirectory
testConnection
in interface RemoteDirectory
OperationFailedException
- underlying directory implementation failed to execute the operation.public boolean supportsInactiveAccounts()
supportsInactiveAccounts
in interface RemoteDirectory
public boolean supportsNestedGroups()
RemoteDirectory
supportsNestedGroups
in interface RemoteDirectory
public boolean isRolesDisabled()
RemoteDirectory
isRolesDisabled
in interface RemoteDirectory
public String getDescriptiveName()
RemoteDirectory
getDescriptiveName
in interface RemoteDirectory
public void setAttributes(Map<String,String> attributes)
DirectoryInstanceLoader
after
constructing an InternalDirectory.
setAttributes
in interface RemoteDirectory
attributes
- attributes map.public Set<String> getValues(String name)
Attributes
getValues
in interface Attributes
name
- the key to retrieve the values for
public String getValue(String name)
Attributes
null
if there is no value.
getValue
in interface Attributes
name
- the key to retrieve the value for
null
if there is no valuepublic Set<String> getKeys()
Attributes
getKeys
in interface Attributes
public boolean isEmpty()
isEmpty
in interface Attributes
true
if there are no attributespublic RemoteDirectory getAuthoritativeDirectory()
getAuthoritativeDirectory
in interface RemoteDirectory
protected ClientProperties getClientProperties()
public Iterable<Membership> getMemberships() throws OperationFailedException
RemoteDirectory
Get an iterable view of the available group memberships. This may be implemented as a single remote call or separate calls, depending on the directory.
If there is a failure in the underlying retrieval, the iterator may throw
Membership.MembershipIterationException
at runtime.
If the directory does not have a bulk call interface then a typical implementation would be:
return new DirectoryMembershipsIterable(this);
getMemberships
in interface RemoteDirectory
OperationFailedException
- if the underlying directory implementation failed to execute the operation
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |