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

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.controller.md.sal.common.api.clustering;
  10
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  13
  14 /**
  15  * An EntityOwnershipCandidateRegistration records a request to register a Candidate for a given Entity. Calling
  16  * close on the EntityOwnershipCandidateRegistration will remove the Candidate from any future ownership considerations
  17  * for that Entity and will also remove it as a Listener for ownership status changes.
  18  */
  19 public interface EntityOwnershipCandidateRegistration extends ObjectRegistration<EntityOwnershipCandidate> {
  20    /**
  21     * Returns the entity that the listener was registered for
  22     */
  23     @Nonnull Entity getEntity();
  24
  25    /**
  26     * Unregister the listener
  27     */
  28    @Override
  29    void close();
  30 }