opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/EntityOwnershipChange.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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.md.sal.common.api.clustering;
   9
  10 import com.google.common.base.Preconditions;
  11 import javax.annotation.Nonnull;
  12
  13 /**
  14  * A DTO that encapsulates an ownership change for an entity.
  15  *
  16  * @author Thomas Pantelis
  17  */
  18 public class EntityOwnershipChange {
  19     private final Entity entity;
  20     private final boolean wasOwner;
  21     private final boolean isOwner;
  22     private final boolean hasOwner;
  23     private final boolean inJeopardy;
  24
  25     public EntityOwnershipChange(@Nonnull Entity entity, boolean wasOwner, boolean isOwner, boolean hasOwner) {
  26         this(entity, wasOwner, isOwner, hasOwner, false);
  27     }
  28
  29     public EntityOwnershipChange(@Nonnull Entity entity, boolean wasOwner, boolean isOwner, boolean hasOwner,
  30             boolean inJeopardy) {
  31         this.entity = Preconditions.checkNotNull(entity, "entity can't be null");
  32         this.wasOwner = wasOwner;
  33         this.isOwner = isOwner;
  34         this.hasOwner = hasOwner;
  35         this.inJeopardy = inJeopardy;
  36     }
  37
  38     /**
  39      * Returns the entity whose ownership status changed.
  40      * @return the entity
  41      */
  42     @Nonnull public Entity getEntity() {
  43         return entity;
  44     }
  45
  46     /**
  47      * Returns the previous ownership status of the entity for this process instance.
  48      * @return true if this process was the owner of the entity at the time this notification was generated
  49      */
  50     public boolean wasOwner() {
  51         return wasOwner;
  52     }
  53
  54     /**
  55      * Returns the current ownership status of the entity for this process instance.
  56      * @return true if this process is now the owner of the entity
  57      */
  58     public boolean isOwner() {
  59         return isOwner;
  60     }
  61
  62     /**
  63      * Returns the current ownership status of the entity across all process instances.
  64      * @return true if the entity has an owner which may or may not be this process. If false, then
  65      *         the entity has no candidates and thus no owner.
  66      */
  67     public boolean hasOwner() {
  68         return hasOwner;
  69     }
  70
  71     /**
  72      * Returns the current jeopardy state. When in a jeopardy state, the values from other methods may potentially
  73      * be out of date.
  74      *
  75      * @return true if the local node is in a jeopardy state. If false, the reported information is accurate.
  76      */
  77     public boolean inJeopardy() {
  78         return inJeopardy;
  79     }
  80
  81     @Override
  82     public String toString() {
  83         return "EntityOwnershipChanged [entity=" + entity + ", wasOwner=" + wasOwner + ", isOwner=" + isOwner
  84                 + ", hasOwner=" + hasOwner + ", inJeopardy=" + inJeopardy + "]";
  85     }
  86 }