Updated SAL Binding APIs

[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / sal / binding / spi / RpcRouter.java

diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/sal/binding/spi/RpcRouter.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/sal/binding/spi/RpcRouter.java
new file mode 100644 (file)
index 0000000..360f039
--- /dev/null
+++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/sal/binding/spi/RpcRouter.java
@@ -0,0 +1,62 @@
+package org.opendaylight.controller.sal.binding.spi;
+
+import org.opendaylight.yangtools.yang.binding.BaseIdentity;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.RpcService;
+
+/**
+ * RpcRouter is responsible for selecting RpcService based on provided routing
+ * context identifier {@link RpcRoutingTable#getContextIdentifier()} and path in
+ * overal data tree (@link {@link InstanceIdentifier}.
+ * 
+ * 
+ * @author Tony Tkacik <ttkacik@cisco.com>
+ * 
+ * @param <T>
+ *            Type of RpcService for which router provides routing information
+ *            and route selection.
+ */
+public interface RpcRouter<T extends RpcService> {
+
+    /**
+     * Returns a type of RpcService which is served by this instance of router.
+     * 
+     * @return type of RpcService which is served by this instance of router.
+     */
+    Class<T> getRpcServiceType();
+
+    /**
+     * Returns a routing table for particular route context
+     * 
+     * @param routeContext
+     * @return Routing Table for particular route context.
+     */
+    <C extends BaseIdentity> RpcRoutingTable<C, T> getRoutingTable(Class<C> routeContext);
+
+    /**
+     * Returns an instance of RpcService which is responsible for processing
+     * particular path.
+     * 
+     * @param context
+     *            Rpc Routing Context
+     * @param path
+     *            Instance Identifier which is used as a selector of instance.
+     * @return instance of RpcService which is responsible for processing
+     *         particular path.
+     */
+    T getService(Class<? extends BaseIdentity> context, InstanceIdentifier path);
+
+    /**
+     * Returns a default fallback instance of RpcService which is responsible
+     * for handling all unknown imports.
+     * 
+     * @return default instance responsible for processing RPCs.
+     */
+    T getDefaultService();
+    
+    /**
+     * 
+     */
+    void setDefaultService();
+
+}