public interface InternalRemoteDirectory extends RemoteDirectory
RemoteDirectory
that is used by InternalDirectories.
In particular, the findUserByName(String)
and findGroupByName(String)
have been redefined to return
TimestampedUser
and InternalDirectoryGroup
. The InternalDirectoryGroup
allows clients to
determine whether the group is "local".
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 |
findUserByName(String name)
Finds the
user that matches the supplied name . |
void |
removeAllGroups(Set<String> groupNames)
Removes all groups from the directory.
|
void |
removeAllUsers(Set<String> usernames)
Removes all users from the directory.
|
addGroup, addGroupToGroup, addUser, addUserToGroup, authenticate, findGroupWithAttributesByName, findUserWithAttributesByName, getAuthoritativeDirectory, getDescriptiveName, getDirectoryId, getMemberships, isGroupDirectGroupMember, isRolesDisabled, isUserDirectGroupMember, removeGroup, removeGroupAttributes, removeGroupFromGroup, removeUser, removeUserAttributes, removeUserFromGroup, renameGroup, renameUser, searchGroupRelationships, searchGroups, searchUsers, setAttributes, setDirectoryId, storeGroupAttributes, storeUserAttributes, supportsInactiveAccounts, supportsNestedGroups, testConnection, updateGroup, updateUser, updateUserCredential
getKeys, getValue, getValues, isEmpty
TimestampedUser findUserByName(String name) throws UserNotFoundException
RemoteDirectory
user
that matches the supplied name
.findUserByName
in interface RemoteDirectory
name
- the name of the user (username).TimestampedUser
entity.UserNotFoundException
- a user with the supplied name does not exist.InternalDirectoryGroup findGroupByName(String name) throws GroupNotFoundException
RemoteDirectory
group
that matches the supplied name
.findGroupByName
in interface RemoteDirectory
name
- the name of the group.InternalDirectoryGroup
entity.GroupNotFoundException
- a group with the supplied name does not exist.Group addLocalGroup(GroupTemplate group) throws InvalidGroupException, OperationFailedException
group
- template of the group to add.InvalidGroupException
- The supplied group is invalid.OperationFailedException
- underlying directory implementation failed to execute the operation.BatchResult<User> addAllUsers(Set<UserTemplateWithCredentialAndAttributes> users)
users
- templates of users to add.IllegalArgumentException
- if any of the users' directory ID does not match the directory's ID.BatchResult<Group> addAllGroups(Set<GroupTemplate> groups)
groups
- templates of groups to add.IllegalArgumentException
- if any of the groups' directory ID does not match the directory's ID.BatchResult<String> addAllUsersToGroup(Set<String> userNames, String groupName) throws GroupNotFoundException
userNames
- names of users to add to group.groupName
- name of group to add users to.GroupNotFoundException
- group with supplied groupName
does not exist.void removeAllUsers(Set<String> usernames)
usernames
- usernames of users to remove.Copyright © 2013 Atlassian. All Rights Reserved.