Interface Authenticator

    • Method Detail

      • authenticate

        User authenticate​(String username,
                          String password)
                   throws AuthenticationException
        Authenticates the user using the given credentials, if successful, the corresponding user is returned.
        Parameters:
        username - the username
        password - the password
        Returns:
        The user, or null if the authentication was unsuccessful
        Throws:
        AuthenticationException
      • authenticate

        User authenticate​(String username,
                          String password,
                          String key)
                   throws AuthenticationException
        Authenticates the user using the given credentials, if successful, the corresponding user is returned.
        Parameters:
        username - the username
        password - the password
        key - Optional third authentication parameter
        Returns:
        The user, or null if the authentication was unsuccessful
        Throws:
        AuthenticationException
      • authenticate

        User authenticate​(String username,
                          String password,
                          String key,
                          Client client)
                   throws AuthenticationException
        Authenticates the user using the given credentials, if successful, the corresponding user is returned.
        Parameters:
        username - the username
        password - the password
        key - Optional third authentication parameter
        client - Client informations
        Returns:
        The user, or null if the authentication was unsuccessful
        Throws:
        AuthenticationException
      • canAuthenticateUser

        boolean canAuthenticateUser​(String user)
      • isEnabled

        boolean isEnabled()
        A provider can be in a disabled state
        Returns:
        if this authenticator is enabled