org.apache.jetspeed.security
Interface UserCredential

All Superinterfaces:

Credential, java.io.Serializable

All Known Subinterfaces:

PasswordCredential

public interface UserCredential
extends Credential

The (readonly) UserCredential accessible through the Subject (private) credentials

Version:

$Id: UserCredential.java 707624 2008-10-24 13:05:16Z ddam $

Method Summary

int	getAuthenticationFailures() Getter for the current number of authentication failures in a row.
java.sql.Timestamp	getCreationDate()
java.sql.Date	getExpirationDate()
java.sql.Timestamp	getLastAuthenticationDate()
java.sql.Timestamp	getModifiedDate()
java.sql.Timestamp	getPreviousAuthenticationDate()
java.lang.String	getUserName()
boolean	isEnabled()
boolean	isExpired()
boolean	isUpdateAllowed()
boolean	isUpdateRequired()
void	synchronize(UserCredential pwc) Synchronize the internal read only UserCredential state when its underlying PasswordCredential is changed (by a user).

Method Detail

getUserName

java.lang.String getUserName()

Returns:

The user name.

synchronize

void synchronize(UserCredential pwc)

Synchronize the internal read only UserCredential state when its underlying PasswordCredential is changed (by a user).

If no update is allowed this method should not be called.

Note: A PasswordCredential implementation (extending UserCredential) probably will throw an UnsupportedOperationException

Parameters:

pwc - the underlying PasswordCredential for this UserCredential

isUpdateAllowed

boolean isUpdateAllowed()

isUpdateRequired

boolean isUpdateRequired()

Returns:

true if update required.

isEnabled

boolean isEnabled()

Returns:

true if enabled.

isExpired

boolean isExpired()

Returns:

true if expired.

getCreationDate

java.sql.Timestamp getCreationDate()

Returns:

when the credential is created.

getModifiedDate

java.sql.Timestamp getModifiedDate()

Returns:

when the credential was last modified.

getExpirationDate

java.sql.Date getExpirationDate()

Returns:

when the credential is (going to be) expired.

getPreviousAuthenticationDate

java.sql.Timestamp getPreviousAuthenticationDate()

Returns:

the previous time the user logged in

getLastAuthenticationDate

java.sql.Timestamp getLastAuthenticationDate()

Returns:

the last time the user logged in

getAuthenticationFailures

int getAuthenticationFailures()

Getter for the current number of authentication failures in a row.

• -1: never tried yet
• 0: none, or last attempt was successful
• >0: number of failures

Returns:

The number of authentication failures