Enum DataSourceStatusProvider.State

java.lang.Object
java.lang.Enum<DataSourceStatusProvider.State>
com.launchdarkly.sdk.server.interfaces.DataSourceStatusProvider.State
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DataSourceStatusProvider.State>, java.lang.constant.Constable
Enclosing interface:
DataSourceStatusProvider

public static enum DataSourceStatusProvider.State
extends java.lang.Enum<DataSourceStatusProvider.State>
An enumeration of possible values for DataSourceStatusProvider.Status.getState().
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    INITIALIZING
    The initial state of the data source when the SDK is being initialized.
    INTERRUPTED
    Indicates that the data source encountered an error that it will attempt to recover from.
    OFF
    Indicates that the data source has been permanently shut down.
    VALID
    Indicates that the data source is currently operational and has not had any problems since the last time it received data.
  • Method Summary

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

    • INITIALIZING

      public static final DataSourceStatusProvider.State INITIALIZING
      The initial state of the data source when the SDK is being initialized.

      If it encounters an error that requires it to retry initialization, the state will remain at INITIALIZING until it either succeeds and becomes VALID, or permanently fails and becomes OFF.

    • VALID

      public static final DataSourceStatusProvider.State VALID
      Indicates that the data source is currently operational and has not had any problems since the last time it received data.

      In streaming mode, this means that there is currently an open stream connection and that at least one initial message has been received on the stream. In polling mode, it means that the last poll request succeeded.

    • INTERRUPTED

      public static final DataSourceStatusProvider.State INTERRUPTED
      Indicates that the data source encountered an error that it will attempt to recover from.

      In streaming mode, this means that the stream connection failed, or had to be dropped due to some other error, and will be retried after a backoff delay. In polling mode, it means that the last poll request failed, and a new poll request will be made after the configured polling interval.

    • OFF

      public static final DataSourceStatusProvider.State OFF
      Indicates that the data source has been permanently shut down.

      This could be because it encountered an unrecoverable error (for instance, the LaunchDarkly service rejected the SDK key; an invalid SDK key will never become valid), or because the SDK client was explicitly shut down.

  • Method Details

    • values

      public static DataSourceStatusProvider.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static DataSourceStatusProvider.State 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