2aa20b2352280300d993c98bb5df3064f5969254
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / clustering / EntityOwnershipListener.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 /**
12  * An EntityOwnershipListener is a component that represents a listener for entity ownership changes.
13  *
14  * @deprecated Use org.opendaylight.mdsal.binding.api.clustering.EntityOwnershipListener or
15  *             org.opendaylight.mdsal.dom.api.clustering.DOMEntityOwnershipListener instead
16  */
17 @Deprecated
18 public interface EntityOwnershipListener {
19
20     /**
21      * A notification that is generated when the ownership status of an entity changes.
22      *
23      * <p>
24      * The following outlines valid combinations of the ownership status flags in the EntityOwnershipChange
25      * parameter and their meanings:
26      * <ul>
27      * <li><b>wasOwner = false, isOwner = true, hasOwner = true</b> - this process has been granted ownership</li>
28      * <li><b>wasOwner = true, isOwner = false, hasOwner = true</b> - this process was the owner but ownership
29      *     transitioned to another process</li>
30      * <li><b>wasOwner = false, isOwner = false, hasOwner = true</b> - ownership transitioned to another process
31      *     and this process was not the previous owner</li>
32      * <li><b>wasOwner = false, isOwner = false, hasOwner = false</b> - the entity no longer has any candidates and
33      *     thus no owner and this process was not the previous owner</li>
34      * <li><b>wasOwner = true, isOwner = false, hasOwner = false</b> - the entity no longer has any candidates and
35      *     thus no owner and this process was the previous owner</li>
36      * </ul>
37      * @param ownershipChange contains the entity and its ownership status flags
38      */
39     void ownershipChanged(EntityOwnershipChange ownershipChange);
40 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.