Enum Class ConnectionState

java.lang.Object
java.lang.Enum<ConnectionState>
org.apache.curator.framework.state.ConnectionState
All Implemented Interfaces:
Serializable, Comparable<ConnectionState>, Constable

public enum ConnectionState extends Enum<ConnectionState>
Represents state changes in the connection to ZK
  • Enum Constant Details

    • CONNECTED

      public static final ConnectionState CONNECTED
      Sent for the first successful connection to the server. NOTE: You will only get one of these messages for any CuratorFramework instance.
    • SUSPENDED

      public static final ConnectionState SUSPENDED
      There has been a loss of connection. Leaders, locks, etc. should suspend until the connection is re-established.
    • RECONNECTED

      public static final ConnectionState RECONNECTED
      A suspended, lost, or read-only connection has been re-established
    • LOST

      public static final ConnectionState LOST

      Curator will set the LOST state when it believes that the ZooKeeper session has expired. ZooKeeper connections have a session. When the session expires, clients must take appropriate action. In Curator, this is complicated by the fact that Curator internally manages the ZooKeeper connection. Curator will set the LOST state when any of the following occurs: a) ZooKeeper returns a Watcher.Event.KeeperState.Expired or KeeperException.Code.SESSIONEXPIRED; b) Curator closes the internally managed ZooKeeper instance; c) The session timeout elapses during a network partition.

    • READ_ONLY

      public static final ConnectionState READ_ONLY
      The connection has gone into read-only mode. This can only happen if you pass true for CuratorFrameworkFactory.Builder.canBeReadOnly(). See the ZooKeeper doc regarding read only connections: http://wiki.apache.org/hadoop/ZooKeeper/GSoCReadOnlyMode. The connection will remain in read only mode until another state change is sent.
  • Method Details

    • values

      public static ConnectionState[] 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 ConnectionState 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
    • isConnected

      public abstract boolean isConnected()
      Check if this state indicates that Curator has a connection to ZooKeeper
      Returns:
      True if connected, false otherwise