bucket.user
Interface UserAccessor

All Superinterfaces:

com.atlassian.user.search.query.EntityQueryParser

All Known Subinterfaces:

UserAccessor

All Known Implementing Classes:

DefaultUserAccessor, DefaultUserAccessor

public interface UserAccessor
extends com.atlassian.user.search.query.EntityQueryParser

Facade which controls calls relating to User, Group, or membership. It is also capable of relaying Query objects to underlying components which can generate SearchResult objects in reply.

Method Summary

com.atlassian.user.Group	addGroup(java.lang.String name)
void	addMembership(com.atlassian.user.Group group, com.atlassian.user.User user)
void	addMembership(java.lang.String groupname, java.lang.String username)
com.atlassian.user.User	addUser(java.lang.String username, java.lang.String password, java.lang.String email, java.lang.String fullname) Deprecated. since 3.5 use createUser(User, Credential)
com.atlassian.user.User	addUser(java.lang.String username, java.lang.String password, java.lang.String email, java.lang.String fullname, java.lang.String[] groups) Deprecated. since 3.5 use createUser(User, Credential) and addMembership(Group, User)
void	alterPassword(com.atlassian.user.User user, java.lang.String plainTextPassword)
boolean	authenticate(java.lang.String username, java.lang.String password)
com.atlassian.user.Group	createGroup(java.lang.String groupname)
com.atlassian.user.User	createUser(java.lang.String username) Deprecated. since 3.5 use createUser(User, Credential) instead
com.atlassian.user.User	createUser(com.atlassian.user.User userTemplate, com.atlassian.user.security.password.Credential password)
void	deactivateUser(com.atlassian.user.User user) Deactivate the specified user, which prevents them logging in.
com.atlassian.user.search.SearchResult<com.atlassian.user.User>	findUsers(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
com.atlassian.user.Group	getDefaultGroup() Deprecated. since 3.5 not used anywhere
java.util.List<com.atlassian.user.repository.RepositoryIdentifier>	getDelegatingRepositories() Deprecated. since 3.5 not used anywhere
com.atlassian.user.search.page.Pager<java.lang.String>	getExternallMembers(com.atlassian.user.Group group)
com.atlassian.user.Group	getGroup(java.lang.String name)
com.atlassian.user.Group	getGroupCreateIfNecessary(java.lang.String name)
com.atlassian.user.search.page.Pager<com.atlassian.user.Group>	getGroups()
com.atlassian.user.search.page.Pager<com.atlassian.user.Group>	getGroups(com.atlassian.user.User user)
com.atlassian.user.search.page.Pager<java.lang.String>	getLocalMembers(com.atlassian.user.Group group)
com.atlassian.user.search.page.Pager<java.lang.String>	getMemberNames(com.atlassian.user.Group group)
com.opensymphony.module.propertyset.PropertySet	getPropertySet(com.atlassian.user.User user)
com.atlassian.user.repository.RepositoryIdentifier	getRepository(com.atlassian.user.Entity entity)
com.atlassian.user.User	getUser(java.lang.String name)
com.atlassian.user.search.page.Pager<java.lang.String>	getUserNames()
com.atlassian.core.user.preferences.UserPreferences	getUserPreferences(com.atlassian.user.User user)
com.atlassian.user.search.page.Pager<com.atlassian.user.User>	getUsers()
com.atlassian.user.search.SearchResult	getUsersByEmail(java.lang.String email)
com.atlassian.user.search.page.Pager<com.atlassian.user.User>	getUsersWithConfluenceAccess()
boolean	hasMembership(com.atlassian.user.Group group, com.atlassian.user.User user)
boolean	hasMembership(java.lang.String groupname, java.lang.String username)
boolean	isDeactivated(java.lang.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	isUserRemovable(com.atlassian.user.User user)
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)
boolean	removeMembership(com.atlassian.user.Group group, com.atlassian.user.User user)
boolean	removeMembership(java.lang.String groupname, java.lang.String username)
void	removeUser(com.atlassian.user.User user) Removes the specified user.
void	saveUser(com.atlassian.user.User user)

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

findGroups, findGroups, findUsers

Method Detail

getRepository

com.atlassian.user.repository.RepositoryIdentifier getRepository(com.atlassian.user.Entity entity)
                                                                 throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException

addUser

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

Deprecated. since 3.5 use createUser(User, Credential) and addMembership(Group, User)

addUser

com.atlassian.user.User addUser(java.lang.String username,
                                java.lang.String password,
                                java.lang.String email,
                                java.lang.String fullname)

Deprecated. since 3.5 use createUser(User, Credential)

getUser

com.atlassian.user.User getUser(java.lang.String name)

getUserNames

com.atlassian.user.search.page.Pager<java.lang.String> getUserNames()

getUsers

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

getGroup

com.atlassian.user.Group getGroup(java.lang.String name)

getGroups

com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups()

addGroup

com.atlassian.user.Group addGroup(java.lang.String name)

removeGroup

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

removeUser

void removeUser(com.atlassian.user.User user)
                throws com.atlassian.core.exception.InfrastructureException

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

Throws:

com.atlassian.core.exception.InfrastructureException - if the user could not be removed

getGroupCreateIfNecessary

com.atlassian.user.Group getGroupCreateIfNecessary(java.lang.String name)

getUserPreferences

com.atlassian.core.user.preferences.UserPreferences getUserPreferences(com.atlassian.user.User user)

saveUser

void saveUser(com.atlassian.user.User user)

getUsersByEmail

com.atlassian.user.search.SearchResult getUsersByEmail(java.lang.String email)

deactivateUser

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

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

reactivateUser

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

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

getUsersWithConfluenceAccess

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

isLicensedToAddMoreUsers

boolean isLicensedToAddMoreUsers()

isUserRemovable

boolean isUserRemovable(com.atlassian.user.User user)
                        throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException

getGroups

com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups(com.atlassian.user.User user)

hasMembership

boolean hasMembership(com.atlassian.user.Group group,
                      com.atlassian.user.User user)

hasMembership

boolean hasMembership(java.lang.String groupname,
                      java.lang.String username)

addMembership

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

addMembership

void addMembership(java.lang.String groupname,
                   java.lang.String username)

removeMembership

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

getPropertySet

com.opensymphony.module.propertyset.PropertySet getPropertySet(com.atlassian.user.User user)

getMemberNames

com.atlassian.user.search.page.Pager<java.lang.String> getMemberNames(com.atlassian.user.Group group)

getLocalMembers

com.atlassian.user.search.page.Pager<java.lang.String> getLocalMembers(com.atlassian.user.Group group)

getExternallMembers

com.atlassian.user.search.page.Pager<java.lang.String> getExternallMembers(com.atlassian.user.Group group)

createUser

com.atlassian.user.User createUser(java.lang.String username)

Deprecated. since 3.5 use createUser(User, Credential) instead

createUser

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

createGroup

com.atlassian.user.Group createGroup(java.lang.String groupname)

isDeactivated

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

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

Returns:

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

isDeactivated

boolean isDeactivated(java.lang.String username)

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.

Returns:

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

authenticate

boolean authenticate(java.lang.String username,
                     java.lang.String password)

findUsers

com.atlassian.user.search.SearchResult<com.atlassian.user.User> findUsers(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
                                                                          throws com.atlassian.user.EntityException

Specified by:

findUsers in interface com.atlassian.user.search.query.EntityQueryParser

Throws:

com.atlassian.user.EntityException

getDefaultGroup

com.atlassian.user.Group getDefaultGroup()

Deprecated. since 3.5 not used anywhere

alterPassword

void alterPassword(com.atlassian.user.User user,
                   java.lang.String plainTextPassword)
                   throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException

getDelegatingRepositories

java.util.List<com.atlassian.user.repository.RepositoryIdentifier> getDelegatingRepositories()

Deprecated. since 3.5 not used anywhere

removeMembership

boolean removeMembership(java.lang.String groupname,
                         java.lang.String username)