Enum AuthenticatorFailoverMode
- java.lang.Object
-
- java.lang.Enum<AuthenticatorFailoverMode>
-
- com.inductiveautomation.ignition.gateway.user.AuthenticatorFailoverMode
-
- All Implemented Interfaces:
Localized
,java.io.Serializable
,java.lang.Comparable<AuthenticatorFailoverMode>
public enum AuthenticatorFailoverMode extends java.lang.Enum<AuthenticatorFailoverMode> implements Localized
Failover mode for an authentication operation.HARD: The failover profile will be used when an error (such as an I/O error) occurs when authenticating
SOFT: The failover profile will be used either when there is an error or simply when authentication fails for the user.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString(java.util.Locale locale)
static AuthenticatorFailoverMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AuthenticatorFailoverMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
HARD
public static final AuthenticatorFailoverMode HARD
Fail-over only when an error occurs when trying to authenticate, but not if the credentials were invalid.
-
SOFT
public static final AuthenticatorFailoverMode SOFT
Fail-over when an error occurs or when the credentials you tried were invalid.
-
-
Method Detail
-
values
public static AuthenticatorFailoverMode[] 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 (AuthenticatorFailoverMode c : AuthenticatorFailoverMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuthenticatorFailoverMode 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 namejava.lang.NullPointerException
- if the argument is null
-
-