org.apache.james.user.lib.model

Class DefaultUser

java.lang.Object

org.apache.james.user.lib.model.DefaultUser

All Implemented Interfaces:

Serializable, User

Direct Known Subclasses:

DefaultJamesUser

public class DefaultUser
extends Object
implements User, Serializable

Implementation of User Interface. Instances of this class do not allow the the user name to be reset.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultUser(String name, String hashAlg) Standard constructor.
DefaultUser(String name, String passwordHash, String hashAlg) Constructor for repositories that are construcing user objects from separate fields, e.g.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHashAlgorithm() Method to access the hashing algorithm of the password.
String	getHashedPassword() Method to access hash of password
String	getUserName() Return the user name of this user
boolean	setPassword(String newPass) Sets new password from String.
boolean	verifyPassword(String pass) Return true if pass matches password of this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUser

public DefaultUser(String name,
           String hashAlg)

Standard constructor.

Parameters:

name - the String name of this user

hashAlg - the algorithm used to generate the hash of the password

DefaultUser

public DefaultUser(String name,
           String passwordHash,
           String hashAlg)

Constructor for repositories that are construcing user objects from separate fields, e.g. databases.

Parameters:

name - the String name of this user

passwordHash - the String hash of this users current password

hashAlg - the String algorithm used to generate the hash of the password

Method Detail

getUserName

public String getUserName()

Description copied from interface: User

Return the user name of this user

Specified by:

getUserName in interface User

Returns:

the user name for this user

See Also:

User.getUserName()

verifyPassword

public boolean verifyPassword(String pass)

Description copied from interface: User

Return true if pass matches password of this user.

Specified by:

verifyPassword in interface User

Parameters:

pass - the password to test

Returns:

whether the password being tested is valid

See Also:

User.verifyPassword(java.lang.String)

setPassword

public boolean setPassword(String newPass)

Description copied from interface: User

Sets new password from String. No checks made on guessability of password.

Specified by:

setPassword in interface User

Parameters:

newPass - the String that is the new password.

Returns:

true if newPass successfully added

See Also:

User.setPassword(java.lang.String)

getHashedPassword

public String getHashedPassword()

Method to access hash of password

Returns:

the String of the hashed Password

getHashAlgorithm

public String getHashAlgorithm()

Method to access the hashing algorithm of the password.

Returns:

the name of the hashing algorithm used for this user's password