Bug 4105: Add general-entities yang model
[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 public interface EntityOwnershipListener {
15
16     /**
17      * A notification that is generated when the ownership status for a given entity changes in the current process.
18      *
19      * @param entity the entity whose ownership status has changed
20      * @param wasOwner true if this process was the owner of the given entity right before this notification
21      *                 was generated
22      * @param isOwner true if this process now owns the given entity
23      */
24     void ownershipChanged(Entity entity, boolean wasOwner, boolean isOwner);
25 }