Package eu.rarogsoftware.rarog.platform.api.security.mfa

Record Class MfaMethod

java.lang.Object
java.lang.Record
eu.rarogsoftware.rarog.platform.api.security.mfa.MfaMethod
Record Components:
condition - predicate which indicate if user can choose method for authentication
name - unique method name
nameKey - translation key for method
descriptionKey - translation key for method description
imageUrl - url of image used to represent method
order - positive number used to sort methods
resource - url to authentication flow JS react component exported as ES6+ module
configurationResource - url to configuration JS react component exported as ES6+ module
adminUrl - url to configuration page in admin panel. Used if adminResource not specified
adminResource - url to react component used to render configuration in admin panel
public record MfaMethod(String imageUrl, String name, String nameKey, String descriptionKey, String resource, Long order, Predicate<StandardUser> condition, String configurationResource, String adminUrl, String adminResource) extends Record
Record representing single MFA method that exists in system. This record contains all information needed to present MFA method to user.

  • Constructor Details

    • MfaMethod

      public MfaMethod(String imageUrl, String name, String nameKey, String descriptionKey, String resource, Long order, Predicate<StandardUser> condition, String configurationResource, String adminUrl, String adminResource)
      Creates an instance of a MfaMethod record class.
      Parameters:
      imageUrl - the value for the imageUrl record component
      name - the value for the name record component
      nameKey - the value for the nameKey record component
      descriptionKey - the value for the descriptionKey record component
      resource - the value for the resource record component
      order - the value for the order record component
      condition - the value for the condition record component
      configurationResource - the value for the configurationResource record component
      adminUrl - the value for the adminUrl record component
      adminResource - the value for the adminResource record component

  • Method Details

    • builder

      public static MfaMethod.Builder builder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • imageUrl

      public String imageUrl()
      Returns the value of the imageUrl record component.
      Returns:
      the value of the imageUrl record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • nameKey

      public String nameKey()
      Returns the value of the nameKey record component.
      Returns:
      the value of the nameKey record component

    • descriptionKey

      public String descriptionKey()
      Returns the value of the descriptionKey record component.
      Returns:
      the value of the descriptionKey record component

    • resource

      public String resource()
      Returns the value of the resource record component.
      Returns:
      the value of the resource record component

    • order

      public Long order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component

    • condition

      public Predicate<StandardUser> condition()
      Returns the value of the condition record component.
      Returns:
      the value of the condition record component

    • configurationResource

      public String configurationResource()
      Returns the value of the configurationResource record component.
      Returns:
      the value of the configurationResource record component

    • adminUrl

      public String adminUrl()
      Returns the value of the adminUrl record component.
      Returns:
      the value of the adminUrl record component

    • adminResource

      public String adminResource()
      Returns the value of the adminResource record component.
      Returns:
      the value of the adminResource record component