com.atlassian.confluence.user
Interface UserAccessor

All Superinterfaces:

EntityQueryParser, UserAccessor

All Known Implementing Classes:

DefaultUserAccessor

public interface UserAccessor

extends UserAccessor

Field Summary

static String	ANONYMOUS
static String	GROUP_CONFLUENCE_ADMINS
static String	GROUP_CONFLUENCE_USERS
static String	USER_GROUP_SUFFIX

Method Summary

Pager	filterUnaccessibleGroups(Pager groupPager, User user) Filters a pager of groups based on the passed User.
Pager	filterUnaccessibleUsers(Pager userPager, User user) Filters a pager of Users based on the groups of the passed User.
ConfluenceUserPreferences	getConfluenceUserPreferences(User user)
ProfilePictureInfo	getUserProfilePicture(String username) Retrieve the path to a user's personal picture
boolean	isReadOnly(Group group)
boolean	isReadOnly(User user)
void	setContentEntityManager(ContentEntityManager contentEntityManager)
void	setEventManager(EventManager eventManager)
void	setNotificationManager(NotificationManager notificationManager)
void	setPersonalInformationManager(PersonalInformationManager personalInformationManager)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpacePermissionManager(SpacePermissionManager permissionManager)

Methods inherited from interface bucket.user.UserAccessor

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

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

findGroups, findGroups, findUsers, init

Field Detail

ANONYMOUS

public static final String ANONYMOUS

See Also:

Constant Field Values

GROUP_CONFLUENCE_USERS

public static final String GROUP_CONFLUENCE_USERS

See Also:

Constant Field Values

USER_GROUP_SUFFIX

public static final String USER_GROUP_SUFFIX

See Also:

Constant Field Values

GROUP_CONFLUENCE_ADMINS

public static final String GROUP_CONFLUENCE_ADMINS

See Also:

Constant Field Values

Method Detail

setSpacePermissionManager

public void setSpacePermissionManager(SpacePermissionManager permissionManager)

setContentEntityManager

public void setContentEntityManager(ContentEntityManager contentEntityManager)

setNotificationManager

public void setNotificationManager(NotificationManager notificationManager)

setEventManager

public void setEventManager(EventManager eventManager)

setPersonalInformationManager

public void setPersonalInformationManager(PersonalInformationManager personalInformationManager)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

isReadOnly

public boolean isReadOnly(User user)

isReadOnly

public boolean isReadOnly(Group group)

filterUnaccessibleUsers

public Pager filterUnaccessibleUsers(Pager userPager,
                                     User user)

Filters a pager of Users based on the groups of the passed User. If in "shared" mode and the user isn't a global administrator, only users who are members of the same groups will be returned. Otherwise, the pager will be returned unmodified.

Parameters:

userPager - A Pager of User objects

user - The user to filter against

Returns:

a filtered Pager of User objects

filterUnaccessibleGroups

public Pager filterUnaccessibleGroups(Pager groupPager,
                                      User user)

Filters a pager of groups based on the passed User. If in "shared" mode and the user isn't a global administrator, only the groups of the user will be returned. Otherwise, the pager will be returned unmodified.

Parameters:

groupPager - The pager of groups

user - The user to filter against

Returns:

A filtered Pager of Group objects

getUserProfilePicture

public ProfilePictureInfo getUserProfilePicture(String username)

Retrieve the path to a user's personal picture

Parameters:

username - the user whose picture to look up.

Returns:

The path to a user's personal picture, or null if they don't have one set.

getConfluenceUserPreferences

public ConfluenceUserPreferences getConfluenceUserPreferences(User user)