Package org.apache.archiva.redback.common.ldap.user

Class LdapUser

java.lang.Object

org.apache.archiva.redback.common.ldap.user.LdapUser

All Implemented Interfaces:

Serializable, User

public class LdapUser
extends Object
implements User, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LdapUser()
LdapUser(String username)
LdapUser(String username, String fullName, String email)

Method Summary

Modifier and Type	Method	Description
void	addPreviousEncodedPassword(String encodedPassword)	Add encoded password to previously passwords in encoded format.
Date	getAccountCreationDate()	Get the Creation Date for this account.
int	getCountFailedLoginAttempts()	Get Count of Failed Login Attempts.
String	getDn()
String	getEmail()	Gets the email address for this user.
String	getEncodedPassword()	Gets the Encoded Password.
String	getFullName()	Gets the Full Name for this user.
String	getId()	This should return a global user id.
Date	getLastLoginDate()	Get the Last Successful Login Date for this account.
Date	getLastPasswordChange()	Gets the Date of the Last Password Change.
Attributes	getOriginalAttributes()
String	getPassword()	Gets the Raw (unencoded) Password.
List<String>	getPreviousEncodedPasswords()	Gets the list of previous password (in encoded format).
String	getUserManagerId()	as we can user multiple userManagers implementation we must track from which one this one comes.
String	getUsername()	Gets the User Name for this user.
boolean	isLocked()	Determines if this user account is locked from use or not.
boolean	isPasswordChangeRequired()	Determines if this user account must change their password on next login.
boolean	isPermanent()	Gets the flag indicating if this user is a permanent user or not.
boolean	isValidated()	Gets the flag indicating if this user has been validated (or not)
void	setAccountCreationDate(Date date)	Set the Creation Date for this account.
void	setCountFailedLoginAttempts(int count)	Set the count of failed login attempts.
void	setDn(String dn)
void	setEmail(String address)	Sets the email address for this user.
void	setEncodedPassword(String encodedPassword)	Sets the Encoded Password.
void	setFullName(String name)	Sets the Full Name for this user.
void	setLastLoginDate(Date date)	Sets the Last Successful Login Date for this account.
void	setLastPasswordChange(Date passwordChangeDate)	Sets the Last Password Change Date.
void	setLocked(boolean locked)	Sets the locked state of this account.
void	setOriginalAttributes(Attributes originalAttributes)
void	setPassword(String rawPassword)	Sets the raw (unencoded) password for this user.
void	setPasswordChangeRequired(boolean changeRequired)	Sets the flag to indicate if this user must change their password on next login.
void	setPermanent(boolean permanent)	Sets the permanent flag for this user.
void	setPreviousEncodedPasswords(List<String> encodedPasswordList)	Sets the list of previous passwords (in encoded format)
void	setUsername(String name)	Sets the User Name for this user.
void	setValidated(boolean valid)	Sets the flag indicating if this user has been validated (or not)

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapUser

public LdapUser(String username)

LdapUser

public LdapUser(String username,
                String fullName,
                String email)

LdapUser

public LdapUser()

Method Detail

addPreviousEncodedPassword

public void addPreviousEncodedPassword(String encodedPassword)

Description copied from interface: User

Add encoded password to previously passwords in encoded format.

Specified by:

addPreviousEncodedPassword in interface User

Parameters:

encodedPassword - the encoded password to add.

getAccountCreationDate

public Date getAccountCreationDate()

Description copied from interface: User

Get the Creation Date for this account.

Specified by:

getAccountCreationDate in interface User

Returns:

the date of creation for this account.

getCountFailedLoginAttempts

public int getCountFailedLoginAttempts()

Description copied from interface: User

Get Count of Failed Login Attempts.

Specified by:

getCountFailedLoginAttempts in interface User

Returns:

the count of failed login attempts.

getEmail

public String getEmail()

Description copied from interface: User

Gets the email address for this user. This field is required, and should never be empty.

Specified by:

getEmail in interface User

Returns:

the email address.

getEncodedPassword

public String getEncodedPassword()

Description copied from interface: User

Gets the Encoded Password.

Specified by:

getEncodedPassword in interface User

Returns:

the encoded password.

getFullName

public String getFullName()

Description copied from interface: User

Gets the Full Name for this user. This field is required, and should never be empty.

Specified by:

getFullName in interface User

Returns:

the full name.

getLastLoginDate

public Date getLastLoginDate()

Description copied from interface: User

Get the Last Successful Login Date for this account.

Specified by:

getLastLoginDate in interface User

Returns:

the date of the last successful login

getLastPasswordChange

public Date getLastPasswordChange()

Description copied from interface: User

Gets the Date of the Last Password Change. Used by password management policies to enforce password expiration rules.

Specified by:

getLastPasswordChange in interface User

Returns:

the date of the last password change.

getPassword

public String getPassword()

Description copied from interface: User

Gets the Raw (unencoded) Password. Used only on password change requests.

Notes for User Providers

1. Providers need to look for a value in here to indicate if the user is intending to change their password.
2. The providers of this interface need to use this field, encode the password, place it's value into the encodedPassword field, and clear out the raw unencoded password field.
3. This field should never be stored on disk.

Specified by:

getPassword in interface User

Returns:

the raw encoded password.

getPreviousEncodedPasswords

public List<String> getPreviousEncodedPasswords()

Description copied from interface: User

Gets the list of previous password (in encoded format). Used by password management policies to enforce password reuse rules.

Specified by:

getPreviousEncodedPasswords in interface User

Returns:

the list of String objects. Represents previous passwords (in encoded format).

getUsername

public String getUsername()

Description copied from interface: User

Gets the User Name for this user. This field is required, and should never be empty.

Specified by:

getUsername in interface User

Returns:

the user name.

isLocked

public boolean isLocked()

Description copied from interface: User

Determines if this user account is locked from use or not. This state is set from an administrative point of view, or due to excessive failed login attempts.

Specified by:

isLocked in interface User

Returns:

true if account is locked.

isPasswordChangeRequired

public boolean isPasswordChangeRequired()

Description copied from interface: User

Determines if this user account must change their password on next login.

Specified by:

isPasswordChangeRequired in interface User

Returns:

true if user must change password on next login.

isPermanent

public boolean isPermanent()

Description copied from interface: User

Gets the flag indicating if this user is a permanent user or not. Usually Root / Admin / Guest users are flagged as such.

Specified by:

isPermanent in interface User

isValidated

public boolean isValidated()

Description copied from interface: User

Gets the flag indicating if this user has been validated (or not)

Specified by:

isValidated in interface User

Returns:

true if validated.

setCountFailedLoginAttempts

public void setCountFailedLoginAttempts(int count)

Description copied from interface: User

Set the count of failed login attempts.

Specified by:

setCountFailedLoginAttempts in interface User

Parameters:

count - the count of failed login attempts.

setEmail

public void setEmail(String address)

Description copied from interface: User

Sets the email address for this user. This field is required, and should never be empty.

Specified by:

setEmail in interface User

Parameters:

address - the email address.

setEncodedPassword

public void setEncodedPassword(String encodedPassword)

Description copied from interface: User

Sets the Encoded Password. This field is populated by the UserManager process.

Specified by:

setEncodedPassword in interface User

setFullName

public void setFullName(String name)

Description copied from interface: User

Sets the Full Name for this user. This field is required, and should never be empty.

Specified by:

setFullName in interface User

Parameters:

name - the full name.

setAccountCreationDate

public void setAccountCreationDate(Date date)

Description copied from interface: User

Set the Creation Date for this account.

Specified by:

setAccountCreationDate in interface User

setLastLoginDate

public void setLastLoginDate(Date date)

Description copied from interface: User

Sets the Last Successful Login Date for this account.

Specified by:

setLastLoginDate in interface User

setLastPasswordChange

public void setLastPasswordChange(Date passwordChangeDate)

Description copied from interface: User

Sets the Last Password Change Date. This field is populated by the UserManager process.

Specified by:

setLastPasswordChange in interface User

Parameters:

passwordChangeDate - the date that the last password change occured.

setLocked

public void setLocked(boolean locked)

Description copied from interface: User

Sets the locked state of this account.

Specified by:

setLocked in interface User

Parameters:

locked - true if account is to be locked.

setPassword

public void setPassword(String rawPassword)

Description copied from interface: User

Sets the raw (unencoded) password for this user.

Specified by:

setPassword in interface User

Parameters:

rawPassword - the raw unencoded password for this user.

See Also:

User.getPassword()

setPasswordChangeRequired

public void setPasswordChangeRequired(boolean changeRequired)

Description copied from interface: User

Sets the flag to indicate if this user must change their password on next login.

Specified by:

setPasswordChangeRequired in interface User

Parameters:

changeRequired - true if user must change password on next login.

setPermanent

public void setPermanent(boolean permanent)

Description copied from interface: User

Sets the permanent flag for this user. Users such as Root / Admin / Guest are typically flagged as permanent.

Specified by:

setPermanent in interface User

Parameters:

permanent - true if permanent.

setPreviousEncodedPasswords

public void setPreviousEncodedPasswords(List<String> encodedPasswordList)

Description copied from interface: User

Sets the list of previous passwords (in encoded format)

Specified by:

setPreviousEncodedPasswords in interface User

Parameters:

encodedPasswordList - (list of String objects.) the previously passwords in encoded format.

setUsername

public void setUsername(String name)

Description copied from interface: User

Sets the User Name for this user. This field is required, and should never be empty.

Specified by:

setUsername in interface User

Parameters:

name - the user name.

setValidated

public void setValidated(boolean valid)

Description copied from interface: User

Sets the flag indicating if this user has been validated (or not)

Specified by:

setValidated in interface User

Parameters:

valid - true if validated.

getOriginalAttributes

public Attributes getOriginalAttributes()

setOriginalAttributes

public void setOriginalAttributes(Attributes originalAttributes)

getUserManagerId

public String getUserManagerId()

Description copied from interface: User

as we can user multiple userManagers implementation we must track from which one this one comes.

Specified by:

getUserManagerId in interface User

Returns:

userManager id

getDn

public String getDn()

setDn

public void setDn(String dn)

getId

public String getId()

Description copied from interface: User

This should return a global user id. Global user ids are built MANAGER_ID:USER_IDENTIFIER User identifier must not be the username but must be unique, e.g. for LDAP it may be the DN.

Specified by:

getId in interface User

Returns: