Package eu.webtoolkit.jwt.auth.mfa

Class AuthenticationResult

java.lang.Object
eu.webtoolkit.jwt.auth.mfa.AuthenticationResult
public class AuthenticationResult extends Object
A class that holds an authentication result.

This class in essence is a record of an authentication attempt. The AuthenticationStatus will indicate whether the event was successful or not, and the optional string provides a way to customize a message. This can be used to display more detailed information to the user, or allow the developer to log some information.

By default this signal is used in TotpProcess.processEnvironment(). There it is fired upon successfully matching the TOTP code and finding a matching environment token (Http::Cookie) against the database respectively.

  • Constructor Details

    • AuthenticationResult

      public AuthenticationResult()
      Default constructor.

      Creates an invalid result.

    • AuthenticationResult

      public AuthenticationResult(AuthenticationStatus status, CharSequence message)
      Constructor.

      Creates a result with given status and message.

    • AuthenticationResult

      public AuthenticationResult(AuthenticationStatus status)
      Constructor.

      Creates a result with given status and an empty message.

  • Method Details

    • getStatus

      public AuthenticationStatus getStatus()
      Returns the authentication status.

    • getMessage

      public WString getMessage()
      Returns the authentication message.