com.inductiveautomation.ignition.common.datasource

Enum DatasourceFailoverMode

java.lang.Object

java.lang.Enum<DatasourceFailoverMode>

com.inductiveautomation.ignition.common.datasource.DatasourceFailoverMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DatasourceFailoverMode>

public enum DatasourceFailoverMode
extends java.lang.Enum<DatasourceFailoverMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
STANDARD Standard failover mode means that this datasource will fail over when a connection cannot be retrieved, but when connectivity is restored, connections will again come from this datasource
STICKY Sticky failover mode means that once this datasource fails over, connections will continue coming from the failover datasource until the failover datasource itself fails.

Method Summary

Modifier and Type	Method and Description
static DatasourceFailoverMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DatasourceFailoverMode[]	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

STANDARD

public static final DatasourceFailoverMode STANDARD

Standard failover mode means that this datasource will fail over when a connection cannot be retrieved, but when connectivity is restored, connections will again come from this datasource

STICKY

public static final DatasourceFailoverMode STICKY

Sticky failover mode means that once this datasource fails over, connections will continue coming from the failover datasource until the failover datasource itself fails.

Method Detail

values

public static DatasourceFailoverMode[] 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 (DatasourceFailoverMode c : DatasourceFailoverMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DatasourceFailoverMode 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