2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.md.sal.common.api.clustering;
11 import javax.annotation.Nonnull;
12 import org.opendaylight.yangtools.concepts.ObjectRegistration;
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.
19 public interface EntityOwnershipCandidateRegistration extends ObjectRegistration<EntityOwnershipCandidate> {
21 * Returns the entity that the listener was registered for
23 @Nonnull Entity getEntity();
26 * Unregister the listener