opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java

   1 /*
   2  * Copyright (c) 2014 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.dom.api;
   9
  10 import java.util.Collection;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  13 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  14
  15 /**
  16  * A {@link DOMService} which allows its users to subscribe to receive
  17  * {@link DOMNotification}s.
  18  */
  19 public interface DOMNotificationService {
  20     /**
  21      * Register a {@link DOMNotificationListener} to receive a set of notifications. As with
  22      * other ListenerRegistration-based interfaces, registering an instance multiple times
  23      * results in notifications being delivered for each registration.
  24      *
  25      * @param listener Notification instance to register
  26      * @param types Notification types which should be delivered to the listener. Duplicate
  27      *              entries are processed only once, null entries are ignored.
  28      * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()}
  29      *         will stop the delivery of notifications to the listener
  30      * @throws IllegalArgumentException if types is empty or contains an invalid element, such as
  31      *         null or a SchemaPath which does not represent a valid {@link DOMNotification} type.
  32      * @throws NullPointerException if either of the arguments is null
  33      */
  34     <T extends DOMNotificationListener> ListenerRegistration<T> registerNotificationListener(@Nonnull T listener, @Nonnull Collection<SchemaPath> types);
  35
  36     /**
  37      * Register a {@link DOMNotificationListener} to receive a set of notifications. As with
  38      * other ListenerRegistration-based interfaces, registering an instance multiple times
  39      * results in notifications being delivered for each registration.
  40      *
  41      * @param listener Notification instance to register
  42      * @param types Notification types which should be delivered to the listener. Duplicate
  43      *              entries are processed only once, null entries are ignored.
  44      * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()}
  45      *         will stop the delivery of notifications to the listener
  46      * @throws IllegalArgumentException if types is empty or contains an invalid element, such as
  47      *         null or a SchemaPath which does not represent a valid {@link DOMNotification} type.
  48      * @throws NullPointerException if listener is null
  49      */
  50     // FIXME: Java 8: provide a default implementation of this method.
  51     <T extends DOMNotificationListener> ListenerRegistration<T> registerNotificationListener(@Nonnull T listener, SchemaPath... types);
  52 }