db246f847e96142210c4860dc2e137cde5b522a1
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / clustering / EntityOwnershipListenerRegistration.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 EntityOwnershipListenerRegistration records a request to register a ownership status change listener for a
16  * given Entity. Calling close on the registration will unregister listeners and future ownership changes will not
17  * be delivered to the listener.
18  *
19  * @deprecated Use org.opendaylight.mdsal.binding.api.clustering.EntityOwnershipListenerRegistration or
20  *             org.opendaylight.mdsal.dom.api.clustering.DOMEntityOwnershipListenerRegistration instead
21  */
22 @Deprecated
23 public interface EntityOwnershipListenerRegistration extends ObjectRegistration<EntityOwnershipListener> {
24
25     /**
26      * Return the entity type that the listener was registered for.
27      */
28     @Nonnull String getEntityType();
29
30     /**
31      * Unregister the listener.
32      */
33     @Override
34     void close();
35 }

©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.