com.atlassian.confluence.internal.user

Interface UserAccessorInternal

All Superinterfaces:

com.atlassian.user.search.query.EntityQueryParser, UserAccessor

All Known Implementing Classes:

DefaultUserAccessor

public interface UserAccessorInternal
extends UserAccessor

Internal version of the UserAccessor interface; see the package-info.java for rationale.

Field Summary

Fields inherited from interface com.atlassian.confluence.user.UserAccessor

ANONYMOUS, DEFAULT_GROUP_NAMES, GROUP_CONFLUENCE_ADMINS, GROUP_CONFLUENCE_USERS, PROFILE_PICTURE_BUILTIN_PATH, USER_GROUP_SUFFIX

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Option<ConfluenceUser>	getExistingByApiUser(User user) Retrieve the corresponding ConfluenceUser (if any) for a user, by user key or username
ConfluenceUser	getExistingUserByPerson(Person person) Retrieve the corresponding ConfluenceUser (if any) for a Person, by username, or user key

Methods inherited from interface com.atlassian.confluence.user.UserAccessor

countLicenseConsumingUsers, countUsersWithConfluenceAccess, createUser, exists, filterUnaccessibleGroups, filterUnaccessibleGroups, filterUnaccessibleUsers, filterUnaccessibleUsers, findUsersAsList, getAllDefaultGroupNames, getConfluenceUserPreferences, getExistingUserByKey, getGroupNames, getGroupNamesForUserName, getGroupsAsList, getGroupsAsList, getMemberNamesAsList, getMembers, getNewUserDefaultGroupName, getPropertySet, getPropertySet, getUser, getUserByKey, getUserByName, getUserIfAvailable, getUserNamesWithConfluenceAccess, getUserProfilePicture, getUserProfilePicture, getUsersWithConfluenceAccessAsList, getWriteableGroups, isReadOnly, isReadOnly, isSuperUser, renameUser, setUserProfilePicture, setUserProfilePicture

Methods inherited from interface bucket.user.UserAccessor

addGroup, addMembership, addMembership, addUser, addUser, alterPassword, authenticate, createGroup, createUser, deactivateUser, findUsers, getDelegatingRepositories, getExternallMembers, getGroup, getGroupCreateIfNecessary, getGroups, getGroups, getLocalMembers, getMemberNames, getRepository, getUserNames, getUserPreferences, getUsers, getUsersByEmail, getUsersWithConfluenceAccess, hasMembership, hasMembership, isDeactivated, isDeactivated, isLicensedToAddMoreUsers, isUserRemovable, reactivateUser, removeGroup, removeMembership, removeMembership, removeUser, saveUser

Methods inherited from interface com.atlassian.user.search.query.EntityQueryParser

findGroups, findGroups, findUsers

Method Detail

getExistingUserByPerson

@Nullable
ConfluenceUser getExistingUserByPerson(Person person)

Retrieve the corresponding ConfluenceUser (if any) for a Person, by username, or user key

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

com.atlassian.fugue.Option<ConfluenceUser> getExistingByApiUser(User user)

Retrieve the corresponding ConfluenceUser (if any) for a user, by user key or username

One 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.

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