UserDetails

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> acegisecurity >> [ userdetails overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.acegisecurity.userdetails.UserDetails

SOURCE |

Download org.acegisecurity.userdetails.UserDetails

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.acegisecurity.userdetails
Interface UserDetails

All Superinterfaces:: java.io.Serializable

All Known Implementing Classes:: User

public interface UserDetails
extends java.io.Serializable

Provides core user information.

Implementations are not used directly by Acegi Security for security purposes. They simply store user information which is later encapsulated into org.acegisecurity.Authentication objects. This allows non-security related user information (such as email addresses, telephone numbers etc) to be stored in a convenient location.

Concrete implementations must take particular care to ensure the non-null contract detailed for each method is enforced. See org.acegisecurity.providers.dao.User for a reference implementation (which you might like to extend).

Version:: $Id: UserDetails.java,v 1.7 2005/11/29 13:10:10 benalex Exp $

Method Summary

GrantedAuthority[] getAuthorities()
          Returns the authorities granted to the user.

java.lang.String getPassword()
          Returns the password used to authenticate the user.

java.lang.String getUsername()
          Returns the username used to authenticate the user.

boolean isAccountNonExpired()
          Indicates whether the user's account has expired.

boolean isAccountNonLocked()
          Indicates whether the user is locked or unlocked.

boolean isCredentialsNonExpired()
          Indicates whether the user's credentials (password) has expired.

boolean isEnabled()
          Indicates whether the user is enabled or disabled.

Method Detail

isAccountNonExpired

public boolean isAccountNonExpired()

Indicates whether the user's account has expired. An expired account cannot be authenticated.

isAccountNonLocked

public boolean isAccountNonLocked()

Indicates whether the user is locked or unlocked. A locked user cannot be authenticated.

getAuthorities

public GrantedAuthority[] getAuthorities()

Returns the authorities granted to the user. Cannot return null.

isCredentialsNonExpired

public boolean isCredentialsNonExpired()

Indicates whether the user's credentials (password) has expired. Expired credentials prevent authentication.

isEnabled

public boolean isEnabled()

Indicates whether the user is enabled or disabled. A disabled user cannot be authenticated.

getPassword

public java.lang.String getPassword()

Returns the password used to authenticate the user. Cannot return null.

getUsername

public java.lang.String getUsername()

Returns the username used to authenticate the user. Cannot return null.