Interface UserDetails

All Superinterfaces:
Serializable
All Known Subinterfaces:
ServiceUserDetails, TokenUserDetails
All Known Implementing Classes:
Service, Token, User

public interface UserDetails extends Serializable
User details to store user information accessed by the UserManager and SecurityManager.

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.

Concrete implementations should be immutable (value object semantics, like a String). This is because the UserDetails will be stored in caches and as such multiple threads may use the same instance.

Since:
7.0.1
Author:
Moran Avigdor
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the granted authorities granted to the user.
    Returns the password used to authenticate the user.
    Returns the username used to authenticate the user.
  • Method Details

    • getAuthorities

      Authority[] getAuthorities()
      Returns the granted authorities granted to the user. Cannot return null.
      Returns:
      the authorities (never null)
    • getPassword

      String getPassword()
      Returns the password used to authenticate the user. Cannot return null.
      Returns:
      the password (never null)
    • getUsername

      String getUsername()
      Returns the username used to authenticate the user. Cannot return null.
      Returns:
      the username (never null)