com.opensymphony.user
Class UserManager

java.lang.Object
  com.opensymphony.user.UserManager

All Implemented Interfaces:

Serializable

Deprecated. JIRA now uses "Embedded Crowd" for User Management. See other javadoc for alternatives. Since v4.3

@Deprecated
public class UserManager
extends Object
implements Serializable

The UserManager is the OLD entry point to user-management in JIRA.

UserManager is a singleton and retrieved with getInstance();

All OSUser classes are deprecated since v4.3 and will be removed in v4.5. Developers should use one of the following User Management components for new work and convert existing code ASAP:

• UserService
  User operations with i18n, security and other validation.
• GroupService
  Group operations with i18n, security and other validation.
• UserManager
  Low level simple User operations without validation.
• GroupManager
  Low level Group operations without validation.
• UserUtil
  Low level User and Group operations without validation, including interactions with other Objects like Projects and Project Components
• CrowdService
  Low level User and Group operations without validation.

Also note that the OSUser User and Group classes are deprecated and should be replaced with Crowd Embedded User and Group interfaces.

See Also:

Serialized Form

Nested Class Summary

class

UserManager.Accessor Deprecated. UserManager.Accessor is a gateway that can be passed from the UserManager to any other object that allows priveleged callbacks.

Constructor Summary

UserManager()
Deprecated. Don't use this constructor most of the time.

Method Summary

Group	createGroup(String name) Deprecated. Create a new Group with given name.
User	createUser(String name) Deprecated. Create a new User with given name.
void	flushCaches() Deprecated. This method will flush all of the provider caches (if they are caching).
UserManager.Accessor	getAccessor() Deprecated.
Collection<AccessProvider>	getAccessProviders() Deprecated. Get the current AccessProviders
Collection<CredentialsProvider>	getCredentialsProviders() Deprecated. Get the current CredentialsProviders
Group	getGroup(String name) Deprecated. Return Group with given name.
List<Group>	getGroups() Deprecated. Return all known Groups from all AccessProviders that allow listing.
static UserManager	getInstance() Deprecated. Entry-point to Singleton instance
Collection<ProfileProvider>	getProfileProviders() Deprecated. Get the current ProfileProviders
User	getUser(String name) Deprecated. Return user with given name.
List<User>	getUsers() Deprecated. Return all known Users from all CredentialProviders that allow listing.
static void	reset() Deprecated. For testing only

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManager

public UserManager()

Deprecated.

Don't use this constructor most of the time. To use OSUser as a singleton, use getInstance() .

Method Detail

reset

public static void reset()

Deprecated.

For testing only

getInstance

public static UserManager getInstance()

Deprecated.

Entry-point to Singleton instance

getAccessor

public UserManager.Accessor getAccessor()

Deprecated.

getAccessProviders

public Collection<AccessProvider> getAccessProviders()

Deprecated.

Get the current AccessProviders

getCredentialsProviders

public Collection<CredentialsProvider> getCredentialsProviders()

Deprecated.

Get the current CredentialsProviders

getProfileProviders

public Collection<ProfileProvider> getProfileProviders()

Deprecated.

Get the current ProfileProviders

getGroups

public List<Group> getGroups()

Deprecated.

Return all known Groups from all AccessProviders that allow listing.

getUsers

public List<User> getUsers()

Deprecated.

Return all known Users from all CredentialProviders that allow listing.

getGroup

public Group getGroup(String name)
               throws EntityNotFoundException

Deprecated.

Return Group with given name. If Group is not found, an EntityNotFoundException is thrown.

Throws:

EntityNotFoundException

getUser

public User getUser(String name)
             throws EntityNotFoundException

Deprecated.

Return user with given name. If User is not found, an EntityNotFoundException is thrown.

Throws:

EntityNotFoundException

createGroup

public Group createGroup(String name)
                  throws DuplicateEntityException,
                         ImmutableException

Deprecated.

Create a new Group with given name.

• Firstly, all providers will be asked if a Group with the given name exists - if it does, DuplicateEntityException is thrown.
• The providers shall be iterated through until one of them states that it can create the Group.
• If no provider can create the Group, ImmutableException shall be thrown.

Throws:

DuplicateEntityException

ImmutableException

createUser

public User createUser(String name)
                throws DuplicateEntityException,
                       ImmutableException

Deprecated.

Create a new User with given name.

• Firstly, all providers will be asked if a User with the given name exists - if it does, DuplicateEntityException is thrown.
• The providers shall be iterated through until one of them states that it can create the User.
• If no provider can create the User, ImmutableException shall be thrown.

Throws:

DuplicateEntityException

ImmutableException

flushCaches

public void flushCaches()

Deprecated.

This method will flush all of the provider caches (if they are caching).