Package com.inductiveautomation.ignition.gateway.user

Enum Class AuthenticatorFailoverMode

java.lang.Object

java.lang.Enum<AuthenticatorFailoverMode>

com.inductiveautomation.ignition.gateway.user.AuthenticatorFailoverMode

All Implemented Interfaces:

Localized, Serializable, Comparable<AuthenticatorFailoverMode>, Constable

public enum AuthenticatorFailoverMode
extends 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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HARD	Fail-over only when an error occurs when trying to authenticate, but not if the credentials were invalid.
SOFT	Fail-over when an error occurs or when the credentials you tried were invalid.

Method Summary

Modifier and Type	Method	Description
String	toString(Locale locale)
static AuthenticatorFailoverMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthenticatorFailoverMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static AuthenticatorFailoverMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthenticatorFailoverMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString(Locale locale)

Specified by:

toString in interface Localized