Add subscribeToStream to JSONRestConfService

[netconf.git] / restconf / restconf-nb-bierman02 / src / main / java / org / opendaylight / netconf / sal / restconf / api / JSONRestconfService.java

diff --git a/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/api/JSONRestconfService.java b/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/api/JSONRestconfService.java
index 5e080da064ff6ebfb08a7974badd63f49e596698..17651af566da338dbca6fa5846dac8330bb78430 100644 (file)
--- a/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/api/JSONRestconfService.java
+++ b/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/api/JSONRestconfService.java
@@ -9,9 +9,12 @@ package org.opendaylight.netconf.sal.restconf.api;
 
 import com.google.common.base.Optional;
 import javax.annotation.Nonnull;
+import javax.ws.rs.core.MultivaluedMap;
+
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.yangtools.yang.common.OperationFailedException;
 
+
 /**
  * Provides restconf CRUD operations via code with input/output data in JSON format.
  *
@@ -84,4 +87,15 @@ public interface JSONRestconfService {
      * @throws OperationFailedException if the request fails.
      */
     Optional<String> patch(@Nonnull String uriPath, @Nonnull String payload) throws OperationFailedException;
+
+    /**
+     * Subscribe to a stream.
+     * @param identifier the identifier of the stream, e.g., "data-change-event-subscription/neutron:neutron/...
+     *                   ...neutron:ports/datastore=OPERATIONAL/scope=SUBTREE".
+     * @param params HTTP query parameters or null.
+     * @return On optional containing the JSON response.
+     * @throws OperationFailedException if the requests fails.
+     */
+    Optional<String> subscribeToStream(@Nonnull String identifier, MultivaluedMap<String, String> params)
+                                                                                    throws OperationFailedException;
 }