opendaylight/md-sal/cds-dom-api/src/main/java/org/opendaylight/controller/cluster/dom/api/LeaderLocation.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.dom.api;
   9
  10 /**
  11  * Enumeration of possible shard leader locations relative to the local node.
  12  */
  13 public enum LeaderLocation {
  14     /**
  15      * The leader is co-located on this node.
  16      */
  17     LOCAL,
  18     /**
  19      * The leader is resident on a different node.
  20      */
  21     REMOTE,
  22     /**
  23      * The leader is residence is currently unknown. This is a transition state during a leader failure, which can be
  24      * caused by a network partition. This state is not observed during a leadership transfer vote initiated by
  25      * the leader shutting down.
  26      */
  27     UNKNOWN,
  28 }