Interface UserAccessorInternal
-
- All Superinterfaces:
ConfluenceUserResolver
,com.atlassian.user.search.query.EntityQueryParser
,GroupMembershipAccessor
,GroupResolver
,UserAccessor
,UserAccessor
,UserExistenceChecker
,UserPreferencesAccessor
,UserProfilePictureAccessor
- All Known Implementing Classes:
DefaultUserAccessor
,ReadOnlyUserAccessor
public interface UserAccessorInternal extends UserAccessor
Internal version of theUserAccessor
interface; see the package-info.java for rationale.
-
-
Field Summary
-
Fields inherited from interface com.atlassian.confluence.user.UserAccessor
DEFAULT_GROUP_NAMES, GROUP_CONFLUENCE_ADMINS, GROUP_CONFLUENCE_USERS, PROFILE_PICTURE_BUILTIN_PATH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Optional<ConfluenceUser>
getExistingByApiUser(User user)
Retrieve the corresponding ConfluenceUser (if any) for a user, by user key or username@Nullable ConfluenceUser
getExistingUserByPerson(Person person)
Retrieve the corresponding ConfluenceUser (if any) for a Person, by username, or user keyboolean
isCrowdManaged(ConfluenceUser user)
Checks whether or not embedded Crowd manages/has knowledge of a given userboolean
isDeletedUser(ConfluenceUser user)
Checks whether or not a user has been deleted from the applicationboolean
isUnsyncedUser(ConfluenceUser user)
Checks whether or not a user is unsyncedcom.atlassian.user.search.page.Pager<ConfluenceUser>
searchUnsyncedUsers(String searchParam)
Returns a list of all users for the given username search parameter that are unsynced: a user whose account has been disconnected from an external directory, i.e.-
Methods inherited from interface com.atlassian.confluence.user.ConfluenceUserResolver
getUsers
-
Methods inherited from interface com.atlassian.user.search.query.EntityQueryParser
findGroups, findGroups, findUsers
-
Methods inherited from interface com.atlassian.confluence.user.GroupMembershipAccessor
getMemberNames
-
Methods inherited from interface com.atlassian.confluence.user.GroupResolver
getGroup
-
Methods inherited from interface bucket.user.UserAccessor
addGroup, addMembership, addMembership, addUser, addUser, alterPassword, authenticate, createGroup, deactivateUser, findUsers, getGroup, getGroupCreateIfNecessary, getGroups, getGroups, getMemberNames, getUserNames, getUserPreferences, getUsers, getUsersByEmail, hasMembership, hasMembership, isUserRemovable, reactivateUser, removeGroup, removeMembership, removeMembership, removeUser, saveUser
-
Methods inherited from interface com.atlassian.confluence.user.UserAccessor
alterPassword, countLicenseConsumingUsers, countUnsyncedUsers, createUser, exists, findUsersAsList, getAllDefaultGroupNames, getConfluenceUserPreferences, getExistingUserByKey, getGroupNames, getGroupNamesForUserName, getGroupsAsList, getGroupsByGroupNames, getMemberNamesAsList, getMembers, getNewUserDefaultGroupName, getPropertySet, getPropertySet, getUser, getUserByKey, getUserByName, getUserNamesWithConfluenceAccess, getUserProfilePicture, getUsersByUserKeys, getWriteableGroups, isDeactivated, isDeactivated, isLicensedToAddMoreUsers, isReadOnly, isReadOnly, isSuperUser, renameUser, setUserProfilePicture, setUserProfilePicture
-
-
-
-
Method Detail
-
getExistingUserByPerson
@Nullable ConfluenceUser getExistingUserByPerson(Person person)
Retrieve the corresponding ConfluenceUser (if any) for a Person, by username, or user key- Specified by:
getExistingUserByPerson
in interfaceConfluenceUserResolver
- Parameters:
person
- the person whose corresponding ConfluenceUser should be retrieved- Returns:
- Person as a confluence user, or null if user doesn't exist or if person is Anonymous
- Throws:
IllegalArgumentException
- if person has neither username nor user key- Since:
- 5.8
-
getExistingByApiUser
Optional<ConfluenceUser> getExistingByApiUser(User user)
Retrieve the corresponding ConfluenceUser (if any) for a user, by user key or usernameOne of username or userkey must be set on the user object.
This method differs from
getExistingUserByPerson(com.atlassian.confluence.api.model.people.Person)
in its handling of anonymous, it is not possible to retrieve an anonymous user from this method. When a Option.none() is returned from this method it indicates that the user was not found in the user repository.- Specified by:
getExistingByApiUser
in interfaceConfluenceUserResolver
- Parameters:
user
- the user whose corresponding ConfluenceUser should be retrieved- Returns:
- an optional confluence user if the user is found by userkey or username
- Throws:
IllegalArgumentException
- if user parameter has neither username nor user key- Since:
- 7.0.1
-
isDeletedUser
boolean isDeletedUser(ConfluenceUser user)
Checks whether or not a user has been deleted from the application- Parameters:
user
- the user to check- Returns:
- true if the user has been deleted from the application, false otherwise (even if the user doesn't exist)
- Since:
- 6.13.0
-
isUnsyncedUser
boolean isUnsyncedUser(ConfluenceUser user)
Checks whether or not a user is unsynced- Parameters:
user
- the user to check- Returns:
- true if the user is unsynced, false otherwise (even if the user doesn't exist)
- Since:
- 6.13.0
-
isCrowdManaged
boolean isCrowdManaged(ConfluenceUser user)
Checks whether or not embedded Crowd manages/has knowledge of a given user- Returns:
- true if the user is managed by embedded Crowd, false otherwise (even if the user doesn't exist)
- Since:
- 6.13.0
-
searchUnsyncedUsers
com.atlassian.user.search.page.Pager<ConfluenceUser> searchUnsyncedUsers(String searchParam)
Returns a list of all users for the given username search parameter that are unsynced: a user whose account has been disconnected from an external directory, i.e. a user who has a known mapping but no backing user, but who has not yet been deleted from the application.- Parameters:
searchParam
- the username parameter to search by- Returns:
- a pager of all unknown / unsynced users
- Since:
- 6.13.0
-
-