Initial opendaylight infrastructure commit!!

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

diff --git a/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationListener.java b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationListener.java
new file mode 100644 (file)
index 0000000..5f72c62
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/notify/NotificationListener.java
@@ -0,0 +1,42 @@
+/*\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 java.util.Set;\r
+\r
+import org.opendaylight.controller.sal.core.api.Consumer;\r
+import org.opendaylight.controller.yang.common.QName;\r
+import org.opendaylight.controller.yang.data.api.CompositeNode;\r
+\r
+\r
+/**\r
+ * Notification listener for SAL notifications.\r
+ */\r
+public interface NotificationListener extends Consumer.ConsumerFunctionality {\r
+    /**\r
+     * A set of notification types supported by listeners.\r
+     * \r
+     * The set of notification {@link QName}s which are supported by this\r
+     * listener. This set is used, when {@link Consumer} is registered to the\r
+     * SAL, to automatically register the listener.\r
+     * \r
+     * @return Set of QNames identifying supported notifications.\r
+     */\r
+    Set<QName> getSupportedNotifications();\r
+\r
+    /**\r
+     * Fired when the notification occurs.\r
+     * \r
+     * The type of the notification could be learned by\r
+     * <code>QName type = notification.getNodeType();</code>\r
+     * \r
+     * @param notification\r
+     *            Notification content\r
+     */\r
+    void onNotification(CompositeNode notification);\r
+}\r