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 org.opendaylight.yangtools.concepts.ObjectRegistration;
  12
  13 /**
  14  * An EntityOwnershipCandidateRegistration records a request to register a Candidate for a given Entity. Calling
  15  * close on the EntityOwnershipCandidateRegistration will remove the Candidate from any future ownership considerations
  16  * for that Entity.
  17  */
  18 public interface EntityOwnershipCandidateRegistration extends ObjectRegistration<Entity> {
  19    /**
  20     * Unregister the candidate
  21     */
  22    @Override
  23    void close();
  24 }