public interface UserDetails extends Serializable
Implementations are not used directly by Spring Security for security
purposes. They simply store user information which is later encapsulated
into 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
User for a
reference implementation (which you might like to extend or use in your code).
UserDetailsService,
UserCache| Modifier and Type | Method and Description |
|---|---|
Collection<? extends GrantedAuthority> |
getAuthorities()
Returns the authorities granted to the user.
|
String |
getPassword()
Returns the password used to authenticate the user.
|
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.
|
Collection<? extends GrantedAuthority> getAuthorities()
null.null)String getPassword()
String getUsername()
null.null)boolean isAccountNonExpired()
true if the user's account is valid (ie non-expired), false if no longer valid
(ie expired)boolean isAccountNonLocked()
true if the user is not locked, false otherwiseboolean isCredentialsNonExpired()
true if the user's credentials are valid (ie non-expired), false if no longer
valid (ie expired)boolean isEnabled()
true if the user is enabled, false otherwise