info.magnolia.cms.security
Interface UserManager

All Known Implementing Classes:
DelegatingUserManager, ExternalUserManager, HierarchicalUserManager, MgnlUserManager, RescueSecuritySupport.RescueUserManager, SystemUserManager

public interface UserManager

Manages users.

Version:
$Revision: 48805 $ ($Author: ochytil $)

Field Summary
static java.lang.String ANONYMOUS_USER
          Anonymous user name.
static java.lang.String SYSTEM_PSWD
          Magnolia system default password.
static java.lang.String SYSTEM_USER
          Magnolia system user name.
 
Method Summary
 void changePassword(User user, java.lang.String newPassword)
          Sets a new password.
 User createUser(java.lang.String name, java.lang.String pw)
          Creates a user without security restrictions.
 java.util.Collection<User> getAllUsers()
          Get all users.
 User getAnonymousUser()
          Get Anonymous user, this user must always exist in magnolia repository.
 long getLockTimePeriod()
          Gets a time in minutes for which account will be locked out in case of reaching maximum count of failed login attempts.
 int getMaxFailedLoginAttempts()
          Gets a number of failed attempts before locking account.
 User getSystemUser()
          Get system user, this user must always exist in magnolia repository.
 User getUser(java.lang.String name)
          Find a specific user.
 User getUser(javax.security.auth.Subject subject)
          Initialize new user using JAAS authenticated/authorized subject.
 void setLockTimePeriod(long lockTimePeriod)
          Sets a time in minutes for which account will be locked out in case of reaching maximum count of failed login attempts.
 void setMaxFailedLoginAttempts(int maxFailedLoginAttempts)
          Sets a number of failed attempts before locking account.
 

Field Detail

SYSTEM_USER

static final java.lang.String SYSTEM_USER
Magnolia system user name.

See Also:
Constant Field Values

SYSTEM_PSWD

static final java.lang.String SYSTEM_PSWD
Magnolia system default password.

See Also:
Constant Field Values

ANONYMOUS_USER

static final java.lang.String ANONYMOUS_USER
Anonymous user name.

See Also:
Constant Field Values
Method Detail

getUser

User getUser(java.lang.String name)
             throws java.lang.UnsupportedOperationException
Find a specific user. Not all implementations will support this method.

Parameters:
name - the name of the user
Returns:
the user object
Throws:
java.lang.UnsupportedOperationException

getUser

User getUser(javax.security.auth.Subject subject)
             throws java.lang.UnsupportedOperationException
Initialize new user using JAAS authenticated/authorized subject.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

getSystemUser

User getSystemUser()
                   throws java.lang.UnsupportedOperationException
Get system user, this user must always exist in magnolia repository.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

getAnonymousUser

User getAnonymousUser()
                      throws java.lang.UnsupportedOperationException
Get Anonymous user, this user must always exist in magnolia repository.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

getAllUsers

java.util.Collection<User> getAllUsers()
                                       throws java.lang.UnsupportedOperationException
Get all users.

Returns:
collection of User objects
Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

createUser

User createUser(java.lang.String name,
                java.lang.String pw)
                throws java.lang.UnsupportedOperationException
Creates a user without security restrictions.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

changePassword

void changePassword(User user,
                    java.lang.String newPassword)
                    throws java.lang.UnsupportedOperationException
Sets a new password.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

setLockTimePeriod

void setLockTimePeriod(long lockTimePeriod)
                       throws java.lang.UnsupportedOperationException
Sets a time in minutes for which account will be locked out in case of reaching maximum count of failed login attempts.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

getLockTimePeriod

long getLockTimePeriod()
                       throws java.lang.UnsupportedOperationException
Gets a time in minutes for which account will be locked out in case of reaching maximum count of failed login attempts.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

setMaxFailedLoginAttempts

void setMaxFailedLoginAttempts(int maxFailedLoginAttempts)
                               throws java.lang.UnsupportedOperationException
Sets a number of failed attempts before locking account.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation

getMaxFailedLoginAttempts

int getMaxFailedLoginAttempts()
                              throws java.lang.UnsupportedOperationException
Gets a number of failed attempts before locking account.

Throws:
java.lang.UnsupportedOperationException - if the current implementation doesn't support this operation


Copyright © 2003-2011 Magnolia International Ltd.. All Rights Reserved.