opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.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 package org.opendaylight.controller.md.sal.binding.api;
   9
  10 import javax.annotation.Nonnull;
  11 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  12 import org.opendaylight.yangtools.yang.binding.DataObject;
  13
  14 /**
  15  * A {@link BindingService} which allows users to register for changes to a
  16  * subtree.
  17  */
  18 public interface DataTreeChangeService extends BindingService {
  19     /**
  20      * Registers a {@link DataTreeChangeListener} to receive
  21      * notifications when data changes under a given path in the conceptual data
  22      * tree.
  23      *
  24      * <p>
  25      * You are able to register for notifications  for any node or subtree
  26      * which can be represented using {@link DataTreeIdentifier}.
  27      *
  28      * <p>
  29      * You are able to register for data change notifications for a subtree or leaf
  30      * even if it does not exist. You will receive notification once that node is
  31      * created.
  32      *
  33      * <p>
  34      * If there is any pre-existing data in the data tree for the path for which you are
  35      * registering, you will receive an initial data change event, which will
  36      * contain all pre-existing data, marked as created.
  37      *
  38      * <p>
  39      * This method returns a {@link ListenerRegistration} object. To
  40      * "unregister" your listener for changes call the {@link ListenerRegistration#close()}
  41      * method on the returned object.
  42      *
  43      * <p>
  44      * You MUST explicitly unregister your listener when you no longer want to receive
  45      * notifications. This is especially true in OSGi environments, where failure to
  46      * do so during bundle shutdown can lead to stale listeners being still registered.
  47      *
  48      * @param treeId
  49      *            Data tree identifier of the subtree which should be watched for
  50      *            changes.
  51      * @param listener
  52      *            Listener instance which is being registered
  53      * @return Listener registration object, which may be used to unregister
  54      *         your listener using {@link ListenerRegistration#close()} to stop
  55      *         delivery of change events.
  56      */
  57     @Nonnull <T extends DataObject,L extends DataTreeChangeListener<T>> ListenerRegistration<L>
  58             registerDataTreeChangeListener(@Nonnull DataTreeIdentifier<T> treeId, @Nonnull L listener);
  59 }