info.magnolia.cms.security
Interface UserManager

All Known Implementing Classes:

DelegatingUserManager, ExternalUserManager, HierarchicalUserManager, MgnlUserManager, SystemUserManager

public interface UserManager

Manages users.

Version:

$Revision: 41137 $ ($Author: gjoseph $)

Field Summary

static String	ANONYMOUS_USER Anonymous user name.
static String	SYSTEM_PSWD Magnolia system default password.
static String	SYSTEM_USER Magnolia system user name.

Method Summary

void	changePassword(User user, String newPassword) Sets a new password.
User	createUser(String name, String pw) Creates a user without security restrictions.
Collection<User>	getAllUsers() Get all users.
User	getAnonymousUser() Get Anonymous user, this user must always exist in magnolia repository.
User	getSystemUser() Get system user, this user must always exist in magnolia repository.
User	getUser(String name) Find a specific user.
User	getUser(Subject subject) Initialize new user using JAAS authenticated/authorized subject.

Field Detail

SYSTEM_USER

static final String SYSTEM_USER

Magnolia system user name.

See Also:

Constant Field Values

SYSTEM_PSWD

static final String SYSTEM_PSWD

Magnolia system default password.

See Also:

Constant Field Values

ANONYMOUS_USER

static final String ANONYMOUS_USER

Anonymous user name.

See Also:

Constant Field Values

Method Detail

getUser

User getUser(String name)
             throws UnsupportedOperationException

Find a specific user. Not all implementations will support this method.

Parameters:

name - the name of the user

Returns:

the user object

Throws:

UnsupportedOperationException

getUser

User getUser(Subject subject)
             throws UnsupportedOperationException

Initialize new user using JAAS authenticated/authorized subject.

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation

getSystemUser

User getSystemUser()
                   throws UnsupportedOperationException

Get system user, this user must always exist in magnolia repository.

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation

getAnonymousUser

User getAnonymousUser()
                      throws UnsupportedOperationException

Get Anonymous user, this user must always exist in magnolia repository.

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation

getAllUsers

Collection<User> getAllUsers()
                             throws UnsupportedOperationException

Get all users.

Returns:

collection of User objects

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation

createUser

User createUser(String name,
                String pw)
                throws UnsupportedOperationException

Creates a user without security restrictions.

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation

changePassword

void changePassword(User user,
                    String newPassword)
                    throws UnsupportedOperationException

Sets a new password.

Throws:

UnsupportedOperationException - if the current implementation doesn't support this operation