Enum RealmPolicy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RealmPolicy>

    public enum RealmPolicy
    extends java.lang.Enum<RealmPolicy>
    Defines the plugin realm authentication policy
    Since:
    4.1.0
    Author:
    Shay Yaakov
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADDITIVE
      Executed additionally if at least one of the previous authentication provider has succeeded
      SUFFICIENT
      Executed in the start of the authentication chain before any other built-in authentication realms (Ldap, Internal etc.) When authentication succeeds, all other built-in realms are skipped.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static RealmPolicy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RealmPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SUFFICIENT

        public static final RealmPolicy SUFFICIENT
        Executed in the start of the authentication chain before any other built-in authentication realms (Ldap, Internal etc.) When authentication succeeds, all other built-in realms are skipped. This is the default behavior
      • ADDITIVE

        public static final RealmPolicy ADDITIVE
        Executed additionally if at least one of the previous authentication provider has succeeded
    • Method Detail

      • values

        public static RealmPolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (RealmPolicy c : RealmPolicy.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RealmPolicy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null