com.atlassian.confluence.user
Class DefaultUserAccessor

java.lang.Object
  bucket.user.DefaultUserAccessor
      com.atlassian.confluence.user.DefaultUserAccessor

All Implemented Interfaces:

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

public class DefaultUserAccessor
extends DefaultUserAccessor
implements UserAccessor

This implementation of UserAccessor takes care of all the Confluence-related actions around user management: checking permissions, publishing events, and ensuring the integrity of data in Confluence related to users.

Field Summary

Fields inherited from class bucket.user.DefaultUserAccessor

DEFAULT_GROUP_NAME, defaultGroup

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

Constructor Summary

DefaultUserAccessor(com.atlassian.user.configuration.RepositoryAccessor repositoryAccessor, SpacePermissionManager spacePermissionManager, ContentEntityManager contentEntityManager, NotificationManager notificationManager, PersonalInformationManager personalInformationManager, UserChecker userChecker, AttachmentManager attachmentManager, SettingsManager settingsManager, com.atlassian.event.EventManager eventManager, ContentPermissionManager contentPermissionManager, PermissionManager permissionManager, UserStatusManager userStatusManager, FollowManager followManager, com.atlassian.crowd.embedded.api.CrowdService crowdService, DisabledUserManager disabledUserManager, HibernateSessionManager sessionManager)

Method Summary

com.atlassian.user.Group	addGroup(String groupname) Adds a group with the specified name.
void	addMembership(com.atlassian.user.Group group, com.atlassian.user.User user) Adds the specified user to this group.
com.atlassian.user.User	addUser(String username, String password, String email, String fullname, String[] groups) Adds a new user.
int	countUsersWithConfluenceAccess() Returns the number of users which have access to use Confluence.
com.atlassian.user.Group	createGroup(String groupname) Method was added for consistency.
com.atlassian.user.User	createUser(String username)
com.atlassian.user.User	createUser(com.atlassian.user.User userTemplate, com.atlassian.user.security.password.Credential credential)
void	deactivateUser(com.atlassian.user.User user) Deactivate the specified user, which prevents them logging in.
List<com.atlassian.user.Group>	filterUnaccessibleGroups(List<com.atlassian.user.Group> groupList, com.atlassian.user.User user)
com.atlassian.user.search.page.Pager<com.atlassian.user.Group>	filterUnaccessibleGroups(com.atlassian.user.search.page.Pager<com.atlassian.user.Group> groupPager, com.atlassian.user.User user) Filters a pager of groups based on the passed User.
List<com.atlassian.user.User>	filterUnaccessibleUsers(List<com.atlassian.user.User> userNameList, com.atlassian.user.User user) Filters out unaccessible users from the passed in list.
com.atlassian.user.search.page.Pager<com.atlassian.user.User>	filterUnaccessibleUsers(com.atlassian.user.search.page.Pager<com.atlassian.user.User> userPager, com.atlassian.user.User user) Deprecated. since 2.8, use filterUnaccessibleUsers(java.util.List, com.atlassian.user.User) instead
List<com.atlassian.user.User>	findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
ConfluenceUserPreferences	getConfluenceUserPreferences(com.atlassian.user.User user)
List<String>	getGroupNames(com.atlassian.user.User user) Gets the list of group names representing the groups the passed in user is a member of.
List<String>	getGroupNamesForUserName(String userName) Gets the list of group names representing the groups the passed in user is a member of.
List<com.atlassian.user.Group>	getGroupsAsList()
List<com.atlassian.user.Group>	getGroupsAsList(com.atlassian.user.User user)
ProfilePictureInfo	getLogoForUser(com.atlassian.user.User user)
List<String>	getMemberNamesAsList(com.atlassian.user.Group group) Same as UserAccessor.getMemberNames(com.atlassian.user.Group) but returns a List of user names as Strings rather than a Pager.
com.atlassian.user.User	getUserIfAvailable(String username) Get the User if visible to the currently authenticated user in shared mode.
List<String>	getUserNamesWithConfluenceAccess() Returns the names of all users with access to use Confluence.
ProfilePictureInfo	getUserProfilePicture(String username) Retrieve the path to a user's personal picture
ProfilePictureInfo	getUserProfilePicture(com.atlassian.user.User user) Retrieve the path to a user's personal picture
com.atlassian.user.search.page.Pager<com.atlassian.user.User>	getUsersWithConfluenceAccess() Returns all the users with access to use Confluence.
List<com.atlassian.user.User>	getUsersWithConfluenceAccessAsList() Returns all the users which have access to use Confluence.
List<com.atlassian.user.Group>	getWriteableGroups() Gets all editable groups.
boolean	isDeactivated(String username) Returns true if the user with the specified username exists and is unable to log in, otherwise false.
boolean	isDeactivated(com.atlassian.user.User user) Returns true if the user exists and is unable to log in, otherwise false.
boolean	isLicensedToAddMoreUsers()
boolean	isReadOnly(com.atlassian.user.Group group) Returns true if the group cannot be modified or removed.
boolean	isReadOnly(com.atlassian.user.User user) Returns true if the user cannot be modified or removed.
boolean	isSuperUser(com.atlassian.user.User user) Return true if the user is an all-powerful super-user (member of the confluence-administrators group).
void	reactivateUser(com.atlassian.user.User user) Marks the specified user as active, which allows them to log in.
void	removeGroup(com.atlassian.user.Group group) Removes the specified group.
boolean	removeMembership(com.atlassian.user.Group group, com.atlassian.user.User user) Removes the specified user from this group.
void	removeUser(com.atlassian.user.User user) Removes the specified user.
void	savePersonalInformation(PersonalInformation newInfo, PersonalInformation oldInfo)
void	setUserProfilePicture(com.atlassian.user.User user, Attachment attachment) Set the user profile picture to the given attachment.
void	setUserProfilePicture(com.atlassian.user.User user, String imagePath) Set the user profile picture to a built-in image.

Methods inherited from class bucket.user.DefaultUserAccessor

addMembership, addUser, alterPassword, authenticate, findGroups, findGroups, findUsers, findUsers, getAuthenticator, getDefaultGroup, getDelegatingRepositories, getEntityQueryParser, getExternallMembers, getGroup, getGroupCreateIfNecessary, getGroupManager, getGroups, getGroups, getLocalMembers, getMemberNames, getPropertySet, getPropertySetFactory, getRepository, getUser, getUserManager, getUserNames, getUserPreferences, getUsers, getUsersByEmail, hasMembership, hasMembership, isUserRemovable, removeMembership, saveUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bucket.user.UserAccessor

addMembership, addUser, alterPassword, authenticate, findUsers, getDefaultGroup, getDelegatingRepositories, getExternallMembers, getGroup, getGroupCreateIfNecessary, getGroups, getGroups, getLocalMembers, getMemberNames, getPropertySet, getRepository, getUser, getUserNames, getUserPreferences, getUsers, getUsersByEmail, hasMembership, hasMembership, isUserRemovable, removeMembership, saveUser

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

findGroups, findGroups, findUsers

Constructor Detail

DefaultUserAccessor

public DefaultUserAccessor(com.atlassian.user.configuration.RepositoryAccessor repositoryAccessor,
                           SpacePermissionManager spacePermissionManager,
                           ContentEntityManager contentEntityManager,
                           NotificationManager notificationManager,
                           PersonalInformationManager personalInformationManager,
                           UserChecker userChecker,
                           AttachmentManager attachmentManager,
                           SettingsManager settingsManager,
                           com.atlassian.event.EventManager eventManager,
                           ContentPermissionManager contentPermissionManager,
                           PermissionManager permissionManager,
                           UserStatusManager userStatusManager,
                           FollowManager followManager,
                           com.atlassian.crowd.embedded.api.CrowdService crowdService,
                           DisabledUserManager disabledUserManager,
                           HibernateSessionManager sessionManager)

Method Detail

isLicensedToAddMoreUsers

public boolean isLicensedToAddMoreUsers()

Specified by:

isLicensedToAddMoreUsers in interface UserAccessor

Overrides:

isLicensedToAddMoreUsers in class DefaultUserAccessor

addMembership

public void addMembership(com.atlassian.user.Group group,
                          com.atlassian.user.User user)

Adds the specified user to this group.

Specified by:

addMembership in interface UserAccessor

Overrides:

addMembership in class DefaultUserAccessor

Throws:

InsufficientPrivilegeException - if the currently logged in user does not have the permissions to add this user to this group. Check permissions using Permission.EDIT on PermissionManager on the group first.

removeMembership

public boolean removeMembership(com.atlassian.user.Group group,
                                com.atlassian.user.User user)

Removes the specified user from this group.

Specified by:

removeMembership in interface UserAccessor

Overrides:

removeMembership in class DefaultUserAccessor

Throws:

InsufficientPrivilegeException - if the currently logged in user does not have the permissions to remove this user from this group. Check permissions using Permission.REMOVE and PermissionManager on the group first.

addUser

public com.atlassian.user.User addUser(String username,
                                       String password,
                                       String email,
                                       String fullname,
                                       String[] groups)

Adds a new user.

Specified by:

addUser in interface UserAccessor

Overrides:

addUser in class DefaultUserAccessor

Parameters:

groups - a string array of group names to add the new user to. if the groups don't exist they will be created.

Returns:

the newly created user

Throws:

InsufficientPrivilegeException - if the current user does not have permission to add a user to any of the specified groups

LicensingException - if you are not licensed to add any more users

createUser

public com.atlassian.user.User createUser(com.atlassian.user.User userTemplate,
                                          com.atlassian.user.security.password.Credential credential)

Specified by:

createUser in interface UserAccessor

Overrides:

createUser in class DefaultUserAccessor

createUser

public com.atlassian.user.User createUser(String username)

Specified by:

createUser in interface UserAccessor

Overrides:

createUser in class DefaultUserAccessor

addGroup

public com.atlassian.user.Group addGroup(String groupname)

Adds a group with the specified name.

Specified by:

addGroup in interface UserAccessor

Overrides:

addGroup in class DefaultUserAccessor

Returns:

the group created

Throws:

InsufficientPrivilegeException - if the current user does not have permission to add this group

createGroup

public com.atlassian.user.Group createGroup(String groupname)

Method was added for consistency. We will need to decide whether we want to lowercase all group names upon creation. Currently createGroup() preserves the casing of the name and addGroup() will lowercase the name. Both methods were in use by Confluence, but only one overwritten to publish an event.

Specified by:

createGroup in interface UserAccessor

Overrides:

createGroup in class DefaultUserAccessor

removeGroup

public void removeGroup(com.atlassian.user.Group group)

Description copied from interface: UserAccessor

Removes the specified group. Does nothing if the group does not exist.

Specified by:

removeGroup in interface UserAccessor

Overrides:

removeGroup in class DefaultUserAccessor

Throws:

InsufficientPrivilegeException - if you do not have sufficient permissions to remove this group. Check permissions using Permission.REMOVE and PermissionManager on the group first.

removeUser

public void removeUser(com.atlassian.user.User user)

Removes the specified user.

Specified by:

removeUser in interface UserAccessor

Overrides:

removeUser in class DefaultUserAccessor

Throws:

IllegalArgumentException - if the specified user is null

InsufficientPrivilegeException - if the currently logged in user does not permissions to remove this user. Check permissions using Permission.REMOVE and PermissionManager on the user first.

getUserNamesWithConfluenceAccess

public List<String> getUserNamesWithConfluenceAccess()

Description copied from interface: UserAccessor

Returns the names of all users with access to use Confluence.

countUsersWithConfluenceAccess

public int countUsersWithConfluenceAccess()

Description copied from interface: UserAccessor

Returns the number of users which have access to use Confluence.

getUsersWithConfluenceAccess

public com.atlassian.user.search.page.Pager<com.atlassian.user.User> getUsersWithConfluenceAccess()

Returns all the users with access to use Confluence.

Specified by:

getUsersWithConfluenceAccess in interface UserAccessor

isDeactivated

public boolean isDeactivated(String username)

Description copied from interface: UserAccessor

Returns true if the user with the specified username exists and is unable to log in, otherwise false. Returns false if the username is null.

Specified by:

isDeactivated in interface UserAccessor

Returns:

true if the user with the specified username exists and is unable to log in, otherwise false.

isDeactivated

public boolean isDeactivated(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Returns true if the user exists and is unable to log in, otherwise false. Returns false if the user is null.

Specified by:

isDeactivated in interface UserAccessor

Returns:

true if the user exists and is unable to log in, otherwise false.

savePersonalInformation

public void savePersonalInformation(PersonalInformation newInfo,
                                    PersonalInformation oldInfo)

deactivateUser

public void deactivateUser(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Deactivate the specified user, which prevents them logging in. Does nothing if the user is already deactivated.

Specified by:

deactivateUser in interface UserAccessor

reactivateUser

public void reactivateUser(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Marks the specified user as active, which allows them to log in. Does nothing if the user is already active.

Specified by:

reactivateUser in interface UserAccessor

isReadOnly

public boolean isReadOnly(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Returns true if the user cannot be modified or removed. However, returning false does necessarily confirm that the user can be modified or removed. Depending on the user management configuration, it is not always possible for Confluence to determine whether a user is read-only.

In an internal-only user management configuration, this method always returns false.

isReadOnly

public boolean isReadOnly(com.atlassian.user.Group group)

Description copied from interface: UserAccessor

Returns true if the group cannot be modified or removed. However, returning false does necessarily confirm that the group can be modified or removed. Depending on the user management configuration, it is not always possible for Confluence to determine whether a group is read-only. Indeed, groups can span across multiple directories with different access control mechanisms, so it may be possible to modify certain memberships of a group but not others.

In an internal-only user management configuration, this method always returns false.

filterUnaccessibleUsers

@Deprecated
public com.atlassian.user.search.page.Pager<com.atlassian.user.User> filterUnaccessibleUsers(com.atlassian.user.search.page.Pager<com.atlassian.user.User> userPager,
                                                                                                        com.atlassian.user.User user)

Deprecated. since 2.8, use filterUnaccessibleUsers(java.util.List, com.atlassian.user.User) instead

Description copied from interface: UserAccessor

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 com.atlassian.user.search.page.Pager<com.atlassian.user.Group> filterUnaccessibleGroups(com.atlassian.user.search.page.Pager<com.atlassian.user.Group> groupPager,
                                                                                               com.atlassian.user.User user)

Description copied from interface: UserAccessor

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)

Description copied from interface: UserAccessor

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.

getLogoForUser

public ProfilePictureInfo getLogoForUser(com.atlassian.user.User user)

getUserProfilePicture

public ProfilePictureInfo getUserProfilePicture(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Retrieve the path to a user's personal picture

Parameters:

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

setUserProfilePicture

public void setUserProfilePicture(com.atlassian.user.User user,
                                  Attachment attachment)

Description copied from interface: UserAccessor

Set the user profile picture to the given attachment. The attachment should be an image attached to that user's personal information, of size 48x48. No check is performed in this method that the image is valid or the right size.

Parameters:

user - the user to set a profile picture for

attachment - the attachment containing the user's profile picture

setUserProfilePicture

public void setUserProfilePicture(com.atlassian.user.User user,
                                  String imagePath)

Description copied from interface: UserAccessor

Set the user profile picture to a built-in image. The path should be the web-application-root-relative path to the image to be used as the user's profile picture and should be size 48x48. Neither are checked by the implementation

Parameters:

user - the user to set a profile picture for

imagePath - the image path to that picture.

isSuperUser

public boolean isSuperUser(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Return true if the user is an all-powerful super-user (member of the confluence-administrators group).

Parameters:

user - the user to check for (the null user will always return false

Returns:

true if the user is a super-user, false otherwise.

getConfluenceUserPreferences

public ConfluenceUserPreferences getConfluenceUserPreferences(com.atlassian.user.User user)

filterUnaccessibleUsers

public List<com.atlassian.user.User> filterUnaccessibleUsers(List<com.atlassian.user.User> userNameList,
                                                             com.atlassian.user.User user)

Filters out unaccessible users from the passed in list. Users are inaccessible if they shared mode is turned on and they do not share a group with the user.

Parameters:

userNameList - list of user names as Strings to be filtered.

user - the user whose permission to view the list of users is being checked.

Returns:

userNameList with some stuff removed.

filterUnaccessibleGroups

public List<com.atlassian.user.Group> filterUnaccessibleGroups(List<com.atlassian.user.Group> groupList,
                                                               com.atlassian.user.User user)

getGroupNames

public List<String> getGroupNames(com.atlassian.user.User user)

Description copied from interface: UserAccessor

Gets the list of group names representing the groups the passed in user is a member of.

Parameters:

user - the user to perform the membership check for

Returns:

a list of group names

getGroupNamesForUserName

public List<String> getGroupNamesForUserName(String userName)

Description copied from interface: UserAccessor

Gets the list of group names representing the groups the passed in user is a member of.

Parameters:

userName - the name of the user to perform the membership check for

Returns:

a list of group names

getGroupsAsList

public List<com.atlassian.user.Group> getGroupsAsList()

getMemberNamesAsList

public List<String> getMemberNamesAsList(com.atlassian.user.Group group)

Description copied from interface: UserAccessor

Same as UserAccessor.getMemberNames(com.atlassian.user.Group) but returns a List of user names as Strings rather than a Pager.

Parameters:

group - to retrieve the member names from

Returns:

a list of Strings

getWriteableGroups

public List<com.atlassian.user.Group> getWriteableGroups()

Description copied from interface: UserAccessor

Gets all editable groups. That is, returns any groups that belong to read/write repositories. Groups in readonly repositories that are ReadOnly are not returned.

Returns:

list of Groups that can be edited.

getUsersWithConfluenceAccessAsList

public List<com.atlassian.user.User> getUsersWithConfluenceAccessAsList()

Returns all the users which have access to use Confluence.

See Also:

UserAccessor.countUsersWithConfluenceAccess()

getUserIfAvailable

public com.atlassian.user.User getUserIfAvailable(String username)

Description copied from interface: UserAccessor

Get the User if visible to the currently authenticated user in shared mode. If not in shared mode, the User will be returned if not null.

getGroupsAsList

public List<com.atlassian.user.Group> getGroupsAsList(com.atlassian.user.User user)

findUsersAsList

public List<com.atlassian.user.User> findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
                                              throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException