org.alfresco.repo.security.authentication

Interface MutableAuthenticationDao

All Superinterfaces:

net.sf.acegisecurity.providers.dao.AuthenticationDao, net.sf.acegisecurity.providers.dao.SaltSource

All Known Implementing Classes:

DefaultMutableAuthenticationDao, NullMutableAuthenticationDao, RepositoryAuthenticationDao

public interface MutableAuthenticationDao
extends net.sf.acegisecurity.providers.dao.AuthenticationDao, net.sf.acegisecurity.providers.dao.SaltSource

A service provider interface to provide both acegi integration via AuthenticationDao and SaltSource and mutability support for user definitions.

Author:

Andy Hind

Method Summary

Modifier and Type	Method and Description
void	createUser(String userName, char[] rawPassword) Create a user with the given userName and password
void	createUser(String caseSensitiveUserName, String hashedPassword, char[] rawPassword) Create a user with the given userName and password hash If hashedPassword is passed in then this is used, otherwise it falls back to using the rawPassword.
void	deleteUser(String userName) Delete a user.
boolean	getAccountExpires(String userName) Does the account expire?
Date	getAccountExpiryDate(String userName) Get the date when this account expires.
boolean	getAccountHasExpired(String userName) Has the account expired?
boolean	getAccountlocked(String userName) Deprecated. Use getLocked(String)
boolean	getCredentialsExpire(String userName) Do the credentials for the user expire?
Date	getCredentialsExpiryDate(String userName) Get the date when the credentials/password expire.
boolean	getCredentialsHaveExpired(String userName) Have the credentials for the user expired?
boolean	getEnabled(String userName) Getter for user enabled
boolean	getLocked(String userName) Check if the account is locked
String	getMD4HashedPassword(String userName) Get the MD4 password hash
void	setAccountExpires(String userName, boolean expires) Set if the account should expire
void	setAccountExpiryDate(String userName, Date exipryDate) Set the date on which the account expires
void	setCredentialsExpire(String userName, boolean expires) Set if the password expires.
void	setCredentialsExpiryDate(String userName, Date exipryDate) Set the date when credentials expire.
void	setEnabled(String userName, boolean enabled) Enable/disable a user.
void	setLocked(String userName, boolean locked) Set if the account is locked.
void	updateUser(String userName, char[] rawPassword) Update a user's password.
boolean	userExists(String userName) Check is a user exists.

Methods inherited from interface net.sf.acegisecurity.providers.dao.AuthenticationDao

loadUserByUsername

Methods inherited from interface net.sf.acegisecurity.providers.dao.SaltSource

getSalt

Method Detail

createUser

void createUser(String userName,
                char[] rawPassword)
         throws org.alfresco.repo.security.authentication.AuthenticationException

Create a user with the given userName and password

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

createUser

void createUser(String caseSensitiveUserName,
                String hashedPassword,
                char[] rawPassword)
         throws org.alfresco.repo.security.authentication.AuthenticationException

Create a user with the given userName and password hash If hashedPassword is passed in then this is used, otherwise it falls back to using the rawPassword. It is assumed the hashed password has been encoded using system.preferred.password.encoding and doesn't use its own salt.

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

updateUser

void updateUser(String userName,
                char[] rawPassword)
         throws org.alfresco.repo.security.authentication.AuthenticationException

Update a user's password.

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

deleteUser

void deleteUser(String userName)
         throws org.alfresco.repo.security.authentication.AuthenticationException

Delete a user.

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

userExists

boolean userExists(String userName)

Check is a user exists.

setEnabled

void setEnabled(String userName,
                boolean enabled)

Enable/disable a user.

getEnabled

boolean getEnabled(String userName)

Getter for user enabled

setAccountExpires

void setAccountExpires(String userName,
                       boolean expires)

Set if the account should expire

getAccountExpires

boolean getAccountExpires(String userName)

Does the account expire?

getAccountHasExpired

boolean getAccountHasExpired(String userName)

Has the account expired?

setCredentialsExpire

void setCredentialsExpire(String userName,
                          boolean expires)

Set if the password expires.

getCredentialsExpire

boolean getCredentialsExpire(String userName)

Do the credentials for the user expire?

getCredentialsHaveExpired

boolean getCredentialsHaveExpired(String userName)

Have the credentials for the user expired?

setLocked

void setLocked(String userName,
               boolean locked)

Set if the account is locked.

getLocked

boolean getLocked(String userName)

Check if the account is locked

Parameters:

userName - the username

Since:

4.0

getAccountlocked

boolean getAccountlocked(String userName)

Deprecated. Use getLocked(String)

Is the account locked?

setAccountExpiryDate

void setAccountExpiryDate(String userName,
                          Date exipryDate)

Set the date on which the account expires

getAccountExpiryDate

Date getAccountExpiryDate(String userName)

Get the date when this account expires.

setCredentialsExpiryDate

void setCredentialsExpiryDate(String userName,
                              Date exipryDate)

Set the date when credentials expire.

getCredentialsExpiryDate

Date getCredentialsExpiryDate(String userName)

Get the date when the credentials/password expire.

getMD4HashedPassword

String getMD4HashedPassword(String userName)

Get the MD4 password hash