summaryrefslogtreecommitdiffstats
path: root/infra/notification/api
diff options
context:
space:
mode:
Diffstat (limited to 'infra/notification/api')
-rw-r--r--infra/notification/api/pom.xml40
-rw-r--r--infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/ManagedNotificationProducer.java38
-rw-r--r--infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationCollector.java35
-rw-r--r--infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationProducer.java37
-rw-r--r--infra/notification/api/src/main/yang/notification-api.yang31
5 files changed, 181 insertions, 0 deletions
diff --git a/infra/notification/api/pom.xml b/infra/notification/api/pom.xml
new file mode 100644
index 000000000..2291025f9
--- /dev/null
+++ b/infra/notification/api/pom.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2015 Cisco and/or its affiliates.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at:
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>impl-parent</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <relativePath>../../../common/impl-parent</relativePath>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>io.fd.honeycomb</groupId>
+ <artifactId>notification-api</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <packaging>bundle</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.opendaylight.mdsal</groupId>
+ <artifactId>mdsal-dom-api</artifactId>
+ <version>2.0.2-Beryllium-SR2</version>
+ </dependency>
+ </dependencies>
+
+
+</project>
diff --git a/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/ManagedNotificationProducer.java b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/ManagedNotificationProducer.java
new file mode 100644
index 000000000..0f5e28cde
--- /dev/null
+++ b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/ManagedNotificationProducer.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fd.honeycomb.v3po.notification;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+
+/**
+ * Special notification producer that is capable of starting and stopping the notification stream
+ */
+@Beta
+public interface ManagedNotificationProducer extends NotificationProducer {
+
+ /**
+ * Start notification stream managed by this producer.
+ *
+ * @param collector Notification collector expected to collect produced notifications
+ */
+ void start(@Nonnull NotificationCollector collector);
+
+ /**
+ * Stop notification stream managed by this producer.
+ */
+ void stop();
+}
diff --git a/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationCollector.java b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationCollector.java
new file mode 100644
index 000000000..406ab03d2
--- /dev/null
+++ b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationCollector.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fd.honeycomb.v3po.notification;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.Notification;
+
+/**
+ * Notification collector. Collects all the notifications, which are further
+ * propagated to all wired northbound interfaces.
+ */
+@Beta
+public interface NotificationCollector extends AutoCloseable, NotificationProducer {
+
+ /**
+ * Publish a single notification.
+ *
+ * @param notification notification to be published
+ */
+ void onNotification(@Nonnull Notification notification);
+}
diff --git a/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationProducer.java b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationProducer.java
new file mode 100644
index 000000000..dab773c45
--- /dev/null
+++ b/infra/notification/api/src/main/java/io/fd/honeycomb/v3po/notification/NotificationProducer.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fd.honeycomb.v3po.notification;
+
+import com.google.common.annotations.Beta;
+import java.util.Collection;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.binding.Notification;
+
+/**
+ * Produces notification of exposed notification types
+ */
+@Beta
+public interface NotificationProducer extends AutoCloseable {
+
+ /**
+ * Return collection of notification types that will be emitted by this producer.
+ * Other types of notifications should not be emitted, since they can be rejected.
+ *
+ * @return collection of all notification types emitted by this producer
+ */
+ @Nonnull
+ Collection<Class<? extends Notification>> getNotificationTypes();
+}
diff --git a/infra/notification/api/src/main/yang/notification-api.yang b/infra/notification/api/src/main/yang/notification-api.yang
new file mode 100644
index 000000000..4e6eb98ae
--- /dev/null
+++ b/infra/notification/api/src/main/yang/notification-api.yang
@@ -0,0 +1,31 @@
+module notification-api {
+ yang-version 1;
+ namespace "urn:honeycomb:params:xml:ns:yang:notification:api";
+ prefix "hc-notif-a";
+
+ import config { prefix config; revision-date 2013-04-05; }
+
+ description
+ "Module definition for honeycomb notification service APIs";
+
+ revision "2016-06-01" {
+ description
+ "Initial revision";
+ }
+
+ identity honeycomb-notification-collector {
+ base "config:service-type";
+ config:java-class io.fd.honeycomb.v3po.notification.NotificationCollector;
+ }
+
+ identity dom-notification-service {
+ base "config:service-type";
+ config:java-class org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
+ }
+
+ identity honeycomb-notification-producer {
+ base "config:service-type";
+ config:java-class io.fd.honeycomb.v3po.notification.ManagedNotificationProducer;
+ }
+
+}