org.apache.jetspeed.security

Interface PasswordCredential

All Superinterfaces:

Credential, Serializable, UserCredential

public interface PasswordCredential
extends UserCredential

PasswordCredential

Version:

$Id: PasswordCredential.java 698325 2008-09-23 20:06:06Z ate $

Author:

Ate Douma

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD_CREDENTIAL_DAYS_VALID_REQUEST_ATTR_KEY
static Short	TYPE_CURRENT
static Short	TYPE_HISTORICAL

Method Summary

Methods

Modifier and Type	Method and Description
void	clearNewPasswordSet()
String	getNewPassword()
String	getOldPassword()
String	getPassword()
Short	getType()
User	getUser()
boolean	isEncoded()
boolean	isNew()
boolean	isNewPasswordSet()
boolean	isStateReadOnly()
void	revertNewPasswordSet()
void	setAuthenticationFailures(int authenticationFailures)
void	setEnabled(boolean enabled)
void	setEncoded(boolean encoded)
void	setExpirationDate(Date expirationDate)
void	setExpired(boolean expired)
void	setLastAuthenticationDate(Timestamp date)
void	setPassword(String password, boolean encoded) Set a new raw (possibly encoded) password
void	setPassword(String oldPassword, String newPassword) Set a new unencoded password and providing the old (unencoded) password for validation
void	setPreviousAuthenticationDate(Timestamp date)
void	setUpdateRequired(boolean updateRequired)

Methods inherited from interface org.apache.jetspeed.security.UserCredential

getAuthenticationFailures, getCreationDate, getExpirationDate, getLastAuthenticationDate, getModifiedDate, getPreviousAuthenticationDate, getUserName, isEnabled, isExpired, isUpdateAllowed, isUpdateRequired, synchronize

Field Detail

PASSWORD_CREDENTIAL_DAYS_VALID_REQUEST_ATTR_KEY

static final String PASSWORD_CREDENTIAL_DAYS_VALID_REQUEST_ATTR_KEY

TYPE_CURRENT

static final Short TYPE_CURRENT

TYPE_HISTORICAL

static final Short TYPE_HISTORICAL

Method Detail

isNew

boolean isNew()

getUser

User getUser()

Returns:

The user the PasswordCredential belongs to

getType

Short getType()

getPassword

String getPassword()

Returns:

raw (possibly encoded) password.

getOldPassword

String getOldPassword()

Returns:

the temporary old (plain text) password provided when a new password is set

getNewPassword

String getNewPassword()

Returns:

the temporary new (plain text) password provided when a new password is set

setPassword

void setPassword(String password,
               boolean encoded)

Set a new raw (possibly encoded) password

Parameters:

password -

encoded -

setPassword

void setPassword(String oldPassword,
               String newPassword)

Set a new unencoded password and providing the old (unencoded) password for validation

Depending on the implementation one or more pluggable validation and processing handlers might be invoked when the PasswordCredential is stored.

A User changing its own password should be required to provide an oldPassword to validate against and might trigger different processing than when a null value is provided for the oldPassword

Parameters:

oldPassword -

newPassword -

isNewPasswordSet

boolean isNewPasswordSet()

clearNewPasswordSet

void clearNewPasswordSet()

revertNewPasswordSet

void revertNewPasswordSet()

isEncoded

boolean isEncoded()

setEncoded

void setEncoded(boolean encoded)

setUpdateRequired

void setUpdateRequired(boolean updateRequired)

isStateReadOnly

boolean isStateReadOnly()

setEnabled

void setEnabled(boolean enabled)

setExpired

void setExpired(boolean expired)

setExpirationDate

void setExpirationDate(Date expirationDate)

setPreviousAuthenticationDate

void setPreviousAuthenticationDate(Timestamp date)

setLastAuthenticationDate

void setLastAuthenticationDate(Timestamp date)

setAuthenticationFailures

void setAuthenticationFailures(int authenticationFailures)