public interface CrowdService
User.getDirectoryId()
is ignored in all methods having User
in the parameter list. Null parameters
for methods may throw NullPointerException
or IllegalArgumentException
.CrowdDirectoryService
Modifier and Type | Method and Description |
---|---|
Group |
addGroup(Group group)
Adds a
group to the directory store. |
boolean |
addGroupToGroup(Group childGroup,
Group parentGroup)
Adds a group as a member of a parent group.
|
User |
addUser(User user,
String credential)
Deprecated.
Use
addUser(UserWithAttributes, String) instead. Since v2.9 |
UserWithAttributes |
addUser(UserWithAttributes user,
String credential)
Adds a
user to the directory store. |
boolean |
addUserToGroup(User user,
Group group)
Adds a user as a member of a group.
|
User |
authenticate(String name,
String credential)
Authenticates a
user with the given credential. |
UserCapabilities |
getCapabilitiesForNewUsers()
Gets details of the possible operations that can be performed on
new users . |
Group |
getGroup(String name)
Finds the
group that matches the supplied name . |
GroupWithAttributes |
getGroupWithAttributes(String name)
Finds the
group that matches the supplied name . |
User |
getRemoteUser(String name)
Returns the
user that matches the supplied name from a remote directory. |
User |
getUser(String name)
Returns the
user that matches the supplied name . |
UserWithAttributes |
getUserWithAttributes(String name)
Returns the
user that matches the supplied name . |
boolean |
isGroupDirectGroupMember(Group childGroup,
Group parentGroup)
Determines if a group is a direct member of another group.
|
boolean |
isGroupMemberOfGroup(Group childGroup,
Group parentGroup)
Returns
true if the childGroup is a direct or indirect (nested) member of the parentGroup . |
boolean |
isGroupMemberOfGroup(String childGroupName,
String parentGroupName)
Returns
true if childGroupName is a direct or indirect (nested) member of parentGroupName . |
boolean |
isUserDirectGroupMember(User user,
Group group)
Determines if a user is a direct member of a group.
|
boolean |
isUserMemberOfGroup(String userName,
String groupName)
Returns
true if the user is a direct or indirect (nested) member of the group. |
boolean |
isUserMemberOfGroup(User user,
Group group)
Returns
true if the user is a direct or indirect (nested) member of the group. |
void |
removeAllGroupAttributes(Group group)
Removes all group attributes.
|
void |
removeAllUserAttributes(User user)
Remove all attributes for a user.
|
boolean |
removeGroup(Group group)
Removes the
group that matches the supplied name . |
void |
removeGroupAttribute(Group group,
String attributeName)
Removes all the values for a single attribute key for a group.
|
boolean |
removeGroupFromGroup(Group childGroup,
Group parentGroup)
Removes a group as a member of a parent group.
|
boolean |
removeUser(User user)
Removes the
user that matches the supplied name . |
void |
removeUserAttribute(User user,
String attributeName)
Removes all the values for a single attribute key for a user.
|
boolean |
removeUserFromGroup(User user,
Group group)
Removes a user as a member of a group.
|
User |
renameUser(User user,
String newUsername)
Renames the
User . |
<T> Iterable<T> |
search(Query<T> query)
Searches for entities (e.g.
|
void |
setGroupAttribute(Group group,
String attributeName,
Set<String> attributeValues)
Adds or updates a group's attributes with the new
attributes . |
void |
setGroupAttribute(Group group,
String attributeName,
String attributeValue)
Adds or updates a group's attributes with the new attributes.
|
void |
setUserAttribute(User user,
String attributeName,
Set<String> attributeValues)
Adds or updates a user's attribute with the new attribute values.
|
void |
setUserAttribute(User user,
String attributeName,
String attributeValue)
Adds or updates a user's attribute with the new attribute value.
|
Group |
updateGroup(Group group)
Updates the
group . |
User |
updateUser(User user)
Updates the
User . |
void |
updateUserCredential(User user,
String credential)
|
User |
userAuthenticated(String name)
Acts as if the user has just authenticated.
|
User authenticate(String name, String credential) throws FailedAuthenticationException, OperationFailedException
user
with the given credential.name
- The name of the user (username).credential
- The supplied credential to authenticate withFailedAuthenticationException
- Authentication with the provided credentials failed. It may indicate that
the user does not exist or the user's account is inactive or the credentials are incorrectInactiveAccountException
- The supplied user is inactive.ExpiredCredentialException
- The user's credentials have expired. The user must change their credentials in order to successfully authenticate.AccountNotFoundException
- User with the given name could not be foundOperationFailedException
- underlying directory implementation failed to execute the operation.User getUser(String name)
user
that matches the supplied name
.name
- the name of the user (username). Does not allow null, blank or empty strings.null
if the user is not foundUser getRemoteUser(String name)
user
that matches the supplied name
from a remote directory.
Note that this may potentially cause a remote call to a authentication service.name
- the name of the user (username). Does not allow null, blank or empty strings.null
if the user is not found@ExperimentalApi User userAuthenticated(String name) throws UserNotFoundException, OperationFailedException, InactiveAccountException
authenticate(String, String)
, but this could be called if the user
was authenticated in a different way.name
- the username for the authenticated userUserNotFoundException
- when the user doesn't existInactiveAccountException
- when the user account is inactiveOperationFailedException
- when one of the post-authentication operation failsUserWithAttributes getUserWithAttributes(String name)
user
that matches the supplied name
.name
- the name of the user (username).null
if the user is not foundGroup getGroup(String name)
group
that matches the supplied name
.name
- the name of the group.null
if not found.GroupWithAttributes getGroupWithAttributes(String name)
group
that matches the supplied name
.name
- the name of the group.null
if not found.boolean isUserMemberOfGroup(String userName, String groupName)
true
if the user is a direct or indirect (nested) member of the group.userName
- user to inspect.groupName
- group to inspect.true
if and only if the user is a direct or indirect (nested) member of the group.
If the user or group cannot found, then false
is returned.isUserMemberOfGroup(User, Group)
boolean isUserMemberOfGroup(User user, Group group)
true
if the user is a direct or indirect (nested) member of the group.user
- user to inspect.group
- group to inspect.true
if and only if the user is a direct or indirect (nested) member of the group, otherwise false.
If the user or group cannot found, then false
is returned.isUserMemberOfGroup(String, String)
boolean isGroupMemberOfGroup(String childGroupName, String parentGroupName)
true
if childGroupName
is a direct or indirect (nested) member of parentGroupName
.childGroupName
- name of child group to inspect.parentGroupName
- name of parent group to inspect.true
if and only if the childGroupName
is a direct or indirect (nested) member of the parentGroupName
.
If any of the groups cannot found, then false
is returned.boolean isGroupMemberOfGroup(Group childGroup, Group parentGroup)
true
if the childGroup
is a direct or indirect (nested) member of the parentGroup
.childGroup
- group to inspect.parentGroup
- group to inspect.true
if and only if the childGroup
is a direct or indirect (nested) member of the parentGroup
.
If any of the groups cannot found, then false
is returned.@Deprecated User addUser(User user, String credential) throws InvalidUserException, InvalidCredentialException, OperationNotPermittedException, OperationFailedException
addUser(UserWithAttributes, String)
instead. Since v2.9user
to the directory store. The user must have non-null names and email address.user
- template of the user to add.credential
- password. May not be null or blank.InvalidUserException
- The supplied user's details are invalid and/or incomplete.InvalidCredentialException
- The supplied credential is invalid, this may be due the credential not matching required directory constraints.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- if the operation failed for any other reasonUserWithAttributes addUser(UserWithAttributes user, String credential) throws InvalidUserException, InvalidCredentialException, OperationNotPermittedException, OperationFailedException
user
to the directory store. The user must have non-null names and email address.user
- template of the user to add.credential
- password. May not be null or blank.InvalidUserException
- The supplied user's details are invalid and/or incomplete.InvalidCredentialException
- The supplied credential is invalid, this may be due the credential not matching required directory constraints.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- if the operation failed for any other reasonUser updateUser(User user) throws UserNotFoundException, InvalidUserException, OperationNotPermittedException, OperationFailedException
User
. The user must have non-null names and email address.user
- The user to update.Directory
UserNotFoundException
- if the supplied user does not exist in the directory
.InvalidUserException
- The supplied user's details are invalid and/or incomplete.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.User renameUser(User user, String newUsername) throws UserNotFoundException, InvalidUserException, OperationNotPermittedException, OperationFailedException
User
.user
- user to rename.newUsername
- new username of the renamed user.UserNotFoundException
- if the supplied user does not exist.InvalidUserException
- if the new username does not meet the username requirements for an associated directory.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performed.OperationFailedException
- underlying directory implementation failed to execute the operation.UnsupportedOperationException
- underlying directory implementation does not support user renaming.void updateUserCredential(User user, String credential) throws UserNotFoundException, InvalidCredentialException, OperationNotPermittedException, OperationFailedException
user
- The name of the user (username).credential
- The new credential (password). May not be null or blank.InvalidCredentialException
- The supplied credential is invalid, this may be due the credential not matching required directory constraints.UserNotFoundException
- if the supplied user does not exist in the directory
.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void setUserAttribute(User user, String attributeName, String attributeValue) throws UserNotFoundException, OperationNotPermittedException, OperationFailedException
user
- user to update.attributeName
- the name of the attributeattributeValue
- the new value of the attribute; any existing values will be replacedUserNotFoundException
- the supplied user does not exist.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void setUserAttribute(User user, String attributeName, Set<String> attributeValues) throws UserNotFoundException, OperationNotPermittedException, OperationFailedException
user
- user to update.attributeName
- the name of the attributeattributeValues
- the new set of values; any existing values will be replacedUserNotFoundException
- the supplied user does not exist.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void removeUserAttribute(User user, String attributeName) throws UserNotFoundException, OperationNotPermittedException, OperationFailedException
user
- user to update.attributeName
- name of attribute to remove.UserNotFoundException
- user with supplied username does not exist.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void removeAllUserAttributes(User user) throws UserNotFoundException, OperationNotPermittedException, OperationFailedException
user
- user to update.UserNotFoundException
- user with supplied username does not exist.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.boolean removeUser(User user) throws OperationNotPermittedException, OperationFailedException
user
that matches the supplied name
.user
- user to remove.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.Group addGroup(Group group) throws InvalidGroupException, OperationNotPermittedException, OperationFailedException
group
to the directory store.group
- template of the group to add.InvalidGroupException
- if the group already exists in ANY associated directory or the group template does not have the required properties populated.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.Group updateGroup(Group group) throws GroupNotFoundException, InvalidGroupException, OperationNotPermittedException, OperationFailedException
group
.group
- The group to update.GroupNotFoundException
- if group with given name does not exist in ANY assigned directory.InvalidGroupException
- the supplied group is invalid.OperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void setGroupAttribute(Group group, String attributeName, String attributeValue) throws GroupNotFoundException, OperationNotPermittedException, OperationFailedException
group
- name of group to update.attributeName
- the name up the attribute to add or updateattributeValue
- the value of the attributeGroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void setGroupAttribute(Group group, String attributeName, Set<String> attributeValues) throws GroupNotFoundException, OperationNotPermittedException, OperationFailedException
attributes
. The attributes represents new or
updated attributes and does not replace existing attributes unless the key of an attribute matches the key of an
existing. This will not remove any attributes.group
- name of group to update.attributeName
- the name up the attribute to add or updateattributeValues
- a set of values to updateGroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void removeGroupAttribute(Group group, String attributeName) throws GroupNotFoundException, OperationNotPermittedException, OperationFailedException
group
- to update.attributeName
- name of attribute to remove.GroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.void removeAllGroupAttributes(Group group) throws GroupNotFoundException, OperationNotPermittedException, OperationFailedException
group
- to update.GroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.boolean removeGroup(Group group) throws OperationNotPermittedException, OperationFailedException
group
that matches the supplied name
.group
- to removeOperationNotPermittedException
- if the directory does not allow removal of this groupOperationFailedException
- underlying directory implementation failed to execute the operation.boolean addUserToGroup(User user, Group group) throws GroupNotFoundException, UserNotFoundException, OperationNotPermittedException, OperationFailedException
childGroup
will
appear as members of parentGroup
to querying applications.user
- The user that will become a member of the group
group
- The group that will gain a new member.UserNotFoundException
- if the user
could not be foundGroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- underlying directory implementation failed to execute the operation.boolean addGroupToGroup(Group childGroup, Group parentGroup) throws GroupNotFoundException, OperationNotPermittedException, InvalidMembershipException, OperationFailedException
childGroup
- The group that will become a member of parentGroup
parentGroup
- The group that will gain a new memberGroupNotFoundException
- if any of the group could not be found. Use GroupNotFoundException.getGroupName()
to find out which group wasn't foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedInvalidMembershipException
- If the relationship would cause a circular reference.OperationFailedException
- underlying directory implementation failed to execute the operation.boolean removeUserFromGroup(User user, Group group) throws GroupNotFoundException, UserNotFoundException, OperationNotPermittedException, OperationFailedException
group
- The group that will lose the member.user
- The user that will be removed from the group
UserNotFoundException
- if the user
could not be foundGroupNotFoundException
- if the group
could not be foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- if the operation failed for any other reasonboolean removeGroupFromGroup(Group childGroup, Group parentGroup) throws GroupNotFoundException, OperationNotPermittedException, OperationFailedException
childGroup
- The group that will be removed from parentGroup
parentGroup
- The group that will lose the member.GroupNotFoundException
- if any of the groups could not be found. Use GroupNotFoundException.getGroupName()
to find out which group wasn't foundOperationNotPermittedException
- if the directory has been configured to not allow the operation to be performedOperationFailedException
- if the operation failed for any other reasonboolean isUserDirectGroupMember(User user, Group group) throws OperationFailedException
user
- the user for whom to check the group membershipgroup
- the group the user
is believed to belong totrue
if the user is a direct member of the group, false
otherwise
(including if the user and/or group could not be found)OperationFailedException
- underlying directory implementation failed to execute the operation.boolean isGroupDirectGroupMember(Group childGroup, Group parentGroup) throws OperationFailedException
childGroup
- the group for which to check the parentGroup
membershipparentGroup
- the group the childGroup
is believed to belong totrue
if the childGroup
is a direct member of the parentGroup
, false
otherwise
(including if neither group could be found)OperationFailedException
- underlying directory implementation failed to execute the operation.UserCapabilities getCapabilitiesForNewUsers()
new users
.
Those capabilities reflects a specific moment in time and are subject to change if any user directory is added, removed or re-ordered.
addUser(User, String)
Copyright © 2021 Atlassian. All rights reserved.