Bug 7603: ACTION support in Binding spec v2

[mdsal.git] / binding2 / mdsal-binding2-spec / src / main / java / org / opendaylight / mdsal / binding / javav2 / spec / base / Action.java

diff --git a/binding2/mdsal-binding2-spec/src/main/java/org/opendaylight/mdsal/binding/javav2/spec/base/Action.java b/binding2/mdsal-binding2-spec/src/main/java/org/opendaylight/mdsal/binding/javav2/spec/base/Action.java
index 9270e78d38b7037bfbcbacbe6d825de5bd6f1e74..bbda46ed2b93d2a500138fc1f0037d4251a825dd 100644 (file)
--- a/binding2/mdsal-binding2-spec/src/main/java/org/opendaylight/mdsal/binding/javav2/spec/base/Action.java
+++ b/binding2/mdsal-binding2-spec/src/main/java/org/opendaylight/mdsal/binding/javav2/spec/base/Action.java
@@ -9,13 +9,27 @@
 package org.opendaylight.mdsal.binding.javav2.spec.base;
 
 /**
- *  The "action" statement is used to define an operation connected to a
- *  specific container or list data node. The "action" statement defines
- *  an action node in the schema tree. Under the action node, a schema node
- *  with the name "input" and a schema node with the name "output" are also
- *  defined. The nodes "input" and "output" are defined in the module’s namespace.
+ *
+ * The "action" statement is used to define an operation connected to a
+ * specific container or list data node. The "action" statement defines
+ * an action node in the schema tree. Under the action node, a schema node
+ * with the name "input" and a schema node with the name "output" are also
+ * defined. The nodes "input" and "output" are defined in the module’s namespace.
+ *
+ * The difference between an action and an rpc is that an action is tied
+ * to a node in the datastore, whereas an rpc is not.
+ *
+ * Action replaces concept of routed RPC and comes up with implicit InstanceIdentifier
+ * context, whereas routed RPC defines explicit leaf for this purpose.
+ *
  */
-public interface Action<I extends Input<I> & Instantiable<I>, O extends Output<O> & Instantiable<O>> {
+@FunctionalInterface
+public interface Action<P extends TreeNode, I extends Input<I> & Instantiable<I>, O extends Output<O> & Instantiable<O>> {
 
-    void invoke(I input, RpcCallback<O> callback);
+    /**
+     * @param input Action input schema node
+     * @param ii implicit InstanceIdentifier connected to action, according to https://tools.ietf.org/html/rfc7950
+     * @param callback on success/failure callback
+     */
+    void invoke(I input, InstanceIdentifier<P> ii, RpcCallback<O> callback);
 }