Interface LoginStore

All Known Subinterfaces:
BulkLoginStore
All Known Implementing Classes:
DelayedLoginStore, LoginStoreImpl, RecoveryLoginStore

public interface LoginStore
The store for saving user login information
Since:
v4.0.1
  • Method Details

    • getLoginInfo

      LoginInfo getLoginInfo(ApplicationUser user)
      Called to get the login information about a user
      Parameters:
      user - the user in play. This MUST not be null.
      Returns:
      a non null LoginInfo object
    • recordLoginAttempt

      LoginInfo recordLoginAttempt(ApplicationUser user, boolean authenticated)
      This will record that fact the user authenticated or not
      Parameters:
      user - the user in play. This MUST not be null.
      authenticated - set to true if they authenticated ok or false otherwise
      Returns:
      a non null LoginInfo object
    • updateLastLoginTime

      LoginInfo updateLastLoginTime(ApplicationUser user)
      This will update the last login time for the user without resetting the elevated security check
      Parameters:
      user - the user in play. This MUST not be null.
      Returns:
      a non null LoginInfo object
    • getMaxAuthenticationAttemptsAllowed

      long getMaxAuthenticationAttemptsAllowed()
      This returns the maximum failed authentications attempts that the user can perform after which they will be asked for extra elevated security information
      Returns:
      the maximum authentication attempts allowed.
    • resetFailedLoginCount

      void resetFailedLoginCount(ApplicationUser user)
      This can be called to reset the failed login count of a user
      Parameters:
      user - the user to authorise. This MUST not be null.