Initial opendaylight infrastructure commit!!

[controller.git] / opendaylight / sal / yang-prototype / sal / sal-core-api / src / main / java / org / opendaylight / controller / sal / core / api / notify / NotificationService.java

diff --git a/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationService.java b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationService.java
new file mode 100644 (file)
index 0000000..98a4925
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationService.java
@@ -0,0 +1,54 @@
+/*\r
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
+package org.opendaylight.controller.sal.core.api.notify;\r
+\r
+import org.opendaylight.controller.sal.core.api.BrokerService;\r
+import org.opendaylight.controller.sal.core.api.Provider;\r
+import org.opendaylight.controller.sal.core.api.RpcImplementation;\r
+import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;\r
+import org.opendaylight.controller.yang.common.QName;\r
+\r
+\r
+/**\r
+ * NotificationService provides access to the notification functionality of the\r
+ * SAL.\r
+ * \r
+ * NotificationService allows for consumption of notifications by registering\r
+ * implementations of NotificationListener.\r
+ * \r
+ * The registration of notification listeners could be done by:\r
+ * <ul>\r
+ * <li>returning an instance of implementation in the return value of\r
+ * {@link Provider#getProviderFunctionality()}\r
+ * <li>passing an instance of implementation and {@link QName} of rpc as an\r
+ * arguments to the\r
+ * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)}\r
+ * </ul>\r
+ * \r
+ * \r
+ */\r
+public interface NotificationService extends BrokerService {\r
+\r
+    /**\r
+     * Registers a notification listener for supplied notification type.\r
+     * \r
+     * @param notification\r
+     * @param listener\r
+     */\r
+    void addNotificationListener(QName notification,\r
+            NotificationListener listener);\r
+\r
+    /**\r
+     * Removes a notification listener for supplied notification type.\r
+     * \r
+     * @param notification\r
+     * @param listener\r
+     */\r
+    void removeNotificationListener(QName notification,\r
+            NotificationListener listener);\r
+}\r