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 org.opendaylight.yangtools.concepts.ObjectRegistration;
  12
  13 /**
  14  * An EntityOwnershipListenerRegistration records a request to register a ownership status change listener for a
  15  * given Entity. Calling close on the registration will unregister listeners and future ownership changes will not
  16  * be delivered to the listener.
  17  */
  18 public interface EntityOwnershipListenerRegistration extends ObjectRegistration<EntityOwnershipListener> {
  19
  20     /**
  21      *
  22      * @return the entity that the listener was registered for
  23      */
  24     Entity getEntity();
  25
  26     /**
  27      * Unregister the listener
  28      */
  29     void close();
  30 }