Summary: Methods | [Expand All]
public interface

UserDetails

implements Serializable
org.springframework.security.core.userdetails.UserDetails
Known Indirect Subclasses

Class Overview

Provides core user information.

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).

See Also

Summary

Public Methods
abstract Collection<? extends GrantedAuthority> getAuthorities()
Returns the authorities granted to the user.
abstract String getPassword()
Returns the password used to authenticate the user.
abstract String getUsername()
Returns the username used to authenticate the user.
abstract boolean isAccountNonExpired()
Indicates whether the user's account has expired.
abstract boolean isAccountNonLocked()
Indicates whether the user is locked or unlocked.
abstract boolean isCredentialsNonExpired()
Indicates whether the user's credentials (password) has expired.
abstract boolean isEnabled()
Indicates whether the user is enabled or disabled.

Public Methods

public abstract Collection<? extends GrantedAuthority> getAuthorities ()

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

Returns
  • the authorities, sorted by natural key (never null)

public abstract String getPassword ()

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

Returns
  • the password (never null)

public abstract String getUsername ()

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

Returns
  • the username (never null)

public abstract boolean isAccountNonExpired ()

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

Returns
  • true if the user's account is valid (ie non-expired), false if no longer valid (ie expired)

public abstract boolean isAccountNonLocked ()

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

Returns
  • true if the user is not locked, false otherwise

public abstract boolean isCredentialsNonExpired ()

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

Returns
  • true if the user's credentials are valid (ie non-expired), false if no longer valid (ie expired)

public abstract boolean isEnabled ()

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

Returns
  • true if the user is enabled, false otherwise