Apache Curator · JSON Structure

Apache Curator Leader Latch State Structure

State of a LeaderLatch participant in Apache Curator leader election.

Type: object Properties: 5 Required: 2
ApacheDistributed CoordinationDistributed SystemsJavaMavenOpen SourceService DiscoveryZooKeeper

LeaderLatchState is a JSON Structure definition published by Apache Curator, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id isLeader state path participants

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apache-curator-leader-latch-state-structure.json Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-curator/refs/heads/main/json-structure/apache-curator-leader-latch-state-structure.json",
  "name": "LeaderLatchState",
  "description": "State of a LeaderLatch participant in Apache Curator leader election.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Participant ID used in the leader election.",
      "example": "node-01"
    },
    "isLeader": {
      "type": "boolean",
      "description": "Whether this participant is currently the leader.",
      "example": true
    },
    "state": {
      "type": "string",
      "description": "LeaderLatch lifecycle state.",
      "enum": [
        "LATENT",
        "STARTED",
        "CLOSED"
      ],
      "example": "STARTED"
    },
    "path": {
      "type": "string",
      "description": "ZooKeeper path used for leader election.",
      "example": "/services/leader"
    },
    "participants": {
      "type": "array",
      "description": "All participants in the election.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "node-01"
          },
          "isLeader": {
            "type": "boolean",
            "example": true
          }
        }
      }
    }
  },
  "required": [
    "id",
    "state"
  ]
}