HONEYCOMB-151: Rpc support 56/4256/2 v1.17.01-RC0
authorMarek Gradzki <mgradzki@cisco.com>
Sun, 11 Dec 2016 16:25:23 +0000 (17:25 +0100)
committerMarek Gradzki <mgradzki@cisco.com>
Tue, 13 Dec 2016 12:34:59 +0000 (13:34 +0100)
Change-Id: Iccffe5412b4bb06b606b66f7c0e7ebd601d5a7d1
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
21 files changed:
infra/impl/src/main/java/io/fd/honeycomb/impl/NorthboundFacadeHoneycombDOMBroker.java
infra/minimal-distribution/pom.xml
infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/ConfigAndOperationalPipelineModule.java
infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/HoneycombDOMBrokerProvider.java
infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/HoneycombDOMRpcServiceProvider.java [new file with mode: 0644]
infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryBuilderProvider.java [new file with mode: 0644]
infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryProvider.java [new file with mode: 0644]
infra/pom.xml
infra/rpc/api/asciidoc/Readme.adoc [new file with mode: 0644]
infra/rpc/api/pom.xml [new file with mode: 0644]
infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcException.java [new file with mode: 0644]
infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcRegistry.java [new file with mode: 0644]
infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcService.java [new file with mode: 0644]
infra/rpc/asciidoc/Readme.adoc [new file with mode: 0644]
infra/rpc/impl/asciidoc/Readme.adoc [new file with mode: 0644]
infra/rpc/impl/pom.xml [new file with mode: 0644]
infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java [new file with mode: 0644]
infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java [new file with mode: 0644]
infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java [new file with mode: 0644]
infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java [new file with mode: 0644]
infra/rpc/pom.xml [new file with mode: 0644]

index d497417..ebf0e6e 100644 (file)
@@ -51,21 +51,21 @@ import org.osgi.framework.BundleContext;
  */
 public class NorthboundFacadeHoneycombDOMBroker implements AutoCloseable, Broker {
 
-    private static final BrokerService EMPTY_DOM_RPC_SERVICE = new EmptyDomRpcService();
     private static final BrokerService EMPTY_DOM_MOUNT_SERVICE = new EmptyDomMountService();
 
     private Map<Class<? extends BrokerService>, BrokerService> services;
 
     public NorthboundFacadeHoneycombDOMBroker(@Nonnull final DOMDataBroker domDataBrokerDependency,
                                               @Nonnull final SchemaService schemaBiService,
-                                              @Nonnull final DOMNotificationService domNotificatioNService) {
+                                              @Nonnull final DOMNotificationService domNotificatioNService,
+                                              @Nonnull final DOMRpcService domRpcService) {
         services = Maps.newHashMap();
         services.put(DOMDataBroker.class, domDataBrokerDependency);
         services.put(SchemaService.class, schemaBiService);
         services.put(DOMNotificationService.class, domNotificatioNService);
         services.put(DOMNotificationPublishService.class, domNotificatioNService);
-        // All services below are required to be present by Restconf northbound even if not used
-        services.put(DOMRpcService.class, EMPTY_DOM_RPC_SERVICE);
+        services.put(DOMRpcService.class, domRpcService);
+        // Required to be present by Restconf northbound even if not used:
         services.put(DOMMountPointService.class, EMPTY_DOM_MOUNT_SERVICE);
     }
 
index f8575ba..4fe0c89 100644 (file)
             <artifactId>notification-impl</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>rpc-impl</artifactId>
+            <version>${project.version}</version>
+        </dependency>
 
         <!-- Utilities -->
         <dependency>
index 488f0b3..8cc9594 100644 (file)
@@ -27,11 +27,14 @@ import io.fd.honeycomb.infra.distro.data.oper.ReadableDTDelegProvider;
 import io.fd.honeycomb.infra.distro.data.oper.ReaderRegistryBuilderProvider;
 import io.fd.honeycomb.infra.distro.data.oper.ReaderRegistryProvider;
 import io.fd.honeycomb.infra.distro.initializer.PersistedFileInitializerProvider;
+import io.fd.honeycomb.rpc.RpcRegistry;
+import io.fd.honeycomb.rpc.RpcRegistryBuilder;
 import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
 import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
 import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
 import org.opendaylight.controller.sal.core.api.Broker;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
@@ -81,6 +84,7 @@ public class ConfigAndOperationalPipelineModule extends PrivateModule {
         expose(DataTreeInitializer.class).annotatedWith(Names.named(HONEYCOMB_CONFIG));
 
         configureNotifications();
+        configureRpcs();
     }
 
     private void configureNotifications() {
@@ -91,4 +95,16 @@ public class ConfigAndOperationalPipelineModule extends PrivateModule {
         bind(Broker.class).toProvider(HoneycombDOMBrokerProvider.class).in(Singleton.class);
         expose(Broker.class);
     }
+
+    private void configureRpcs() {
+        // Create rpc service
+        bind(DOMRpcService.class).toProvider(HoneycombDOMRpcServiceProvider.class).in(Singleton.class);
+        expose(DOMRpcService.class);
+
+        bind(RpcRegistryBuilder.class).toProvider(RpcRegistryBuilderProvider.class).in(Singleton.class);
+        expose(RpcRegistryBuilder.class);
+
+        bind(RpcRegistry.class).toProvider(RpcRegistryProvider.class).in(Singleton.class);
+        expose(RpcRegistry.class);
+    }
 }
index eefa1c1..dd34c6c 100644 (file)
@@ -20,6 +20,7 @@ import com.google.inject.Inject;
 import io.fd.honeycomb.impl.NorthboundFacadeHoneycombDOMBroker;
 import io.fd.honeycomb.infra.distro.ProviderTrait;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
 import org.opendaylight.controller.md.sal.dom.broker.impl.DOMNotificationRouter;
 import org.opendaylight.controller.sal.core.api.Broker;
 import org.opendaylight.controller.sal.core.api.model.SchemaService;
@@ -32,9 +33,12 @@ public final class HoneycombDOMBrokerProvider extends ProviderTrait<Broker> {
     private SchemaService schemaService;
     @Inject
     private DOMNotificationRouter domNotificationService;
+    @Inject
+    private DOMRpcService domRpcService;
 
     @Override
     protected NorthboundFacadeHoneycombDOMBroker create() {
-        return new NorthboundFacadeHoneycombDOMBroker(domDataBroker, schemaService, domNotificationService);
+        return new NorthboundFacadeHoneycombDOMBroker(domDataBroker, schemaService, domNotificationService,
+            domRpcService);
     }
 }
diff --git a/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/HoneycombDOMRpcServiceProvider.java b/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/HoneycombDOMRpcServiceProvider.java
new file mode 100644 (file)
index 0000000..0459b2f
--- /dev/null
@@ -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.infra.distro.data;
+
+import com.google.inject.Inject;
+import io.fd.honeycomb.infra.distro.ProviderTrait;
+import io.fd.honeycomb.rpc.HoneycombDOMRpcService;
+import io.fd.honeycomb.rpc.RpcRegistry;
+import org.opendaylight.controller.md.sal.binding.impl.BindingToNormalizedNodeCodec;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
+
+public final class HoneycombDOMRpcServiceProvider extends ProviderTrait<DOMRpcService> {
+
+    @Inject
+    private BindingToNormalizedNodeCodec serializer;
+
+    @Inject
+    private RpcRegistry rpcRegistry;
+
+    @Override
+    protected DOMRpcService create() {
+        return new HoneycombDOMRpcService(serializer, rpcRegistry);
+    }
+}
diff --git a/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryBuilderProvider.java b/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryBuilderProvider.java
new file mode 100644 (file)
index 0000000..92d9ce9
--- /dev/null
@@ -0,0 +1,39 @@
+/*
+ * 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.infra.distro.data;
+
+import com.google.inject.Inject;
+import io.fd.honeycomb.infra.distro.ProviderTrait;
+import io.fd.honeycomb.rpc.RpcRegistryBuilder;
+import io.fd.honeycomb.rpc.RpcService;
+import java.util.HashSet;
+import java.util.Set;
+
+public final class RpcRegistryBuilderProvider extends ProviderTrait<RpcRegistryBuilder> {
+
+    @Inject(optional = true)
+    private Set<RpcService> rpcServices = new HashSet<>();
+
+    @Override
+    protected RpcRegistryBuilder create() {
+        final RpcRegistryBuilder builder = new RpcRegistryBuilder();
+        rpcServices.stream()
+                .forEach(service -> builder.addService(service));
+        return builder;
+    }
+
+}
diff --git a/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryProvider.java b/infra/minimal-distribution/src/main/java/io/fd/honeycomb/infra/distro/data/RpcRegistryProvider.java
new file mode 100644 (file)
index 0000000..4e09a9d
--- /dev/null
@@ -0,0 +1,34 @@
+/*
+ * 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.infra.distro.data;
+
+import com.google.inject.Inject;
+import io.fd.honeycomb.infra.distro.ProviderTrait;
+import io.fd.honeycomb.rpc.RpcRegistry;
+import io.fd.honeycomb.rpc.RpcRegistryBuilder;
+
+public final class RpcRegistryProvider extends ProviderTrait<RpcRegistry> {
+
+    @Inject
+    private RpcRegistryBuilder builder;
+
+    @Override
+    protected RpcRegistry create() {
+        return builder.build();
+    }
+
+}
index b8c4c64..e850d13 100644 (file)
@@ -43,6 +43,7 @@
     <module>minimal-distribution</module>
     <module>it</module>
     <module>test-utils</module>
+    <module>rpc</module>
   </modules>
 
   <!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build -->
diff --git a/infra/rpc/api/asciidoc/Readme.adoc b/infra/rpc/api/asciidoc/Readme.adoc
new file mode 100644 (file)
index 0000000..3ff98ad
--- /dev/null
@@ -0,0 +1,3 @@
+= rpc-api
+
+Overview of rpc-api
\ No newline at end of file
diff --git a/infra/rpc/api/pom.xml b/infra/rpc/api/pom.xml
new file mode 100644 (file)
index 0000000..17782f3
--- /dev/null
@@ -0,0 +1,39 @@
+<?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.17.01-SNAPSHOT</version>
+        <relativePath>../../../common/impl-parent</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.fd.honeycomb</groupId>
+    <artifactId>rpc-api</artifactId>
+    <name>${project.artifactId}</name>
+    <version>1.17.01-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.opendaylight.controller</groupId>
+            <artifactId>sal-core-api</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcException.java b/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcException.java
new file mode 100644 (file)
index 0000000..907ce6c
--- /dev/null
@@ -0,0 +1,28 @@
+/*
+ * 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.rpc;
+
+import com.google.common.annotations.Beta;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
+
+@Beta
+public class RpcException extends DOMRpcException {
+
+    public RpcException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+}
diff --git a/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcRegistry.java b/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcRegistry.java
new file mode 100644 (file)
index 0000000..b58ed58
--- /dev/null
@@ -0,0 +1,30 @@
+/*
+ * 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.rpc;
+
+import com.google.common.annotations.Beta;
+import java.util.concurrent.CompletionStage;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+@Beta
+public interface RpcRegistry {
+
+    @Nonnull CompletionStage invoke(@Nonnull final SchemaPath schemaPath, @Nullable final DataObject request);
+}
diff --git a/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcService.java b/infra/rpc/api/src/main/java/io/fd/honeycomb/rpc/RpcService.java
new file mode 100644 (file)
index 0000000..a86a360
--- /dev/null
@@ -0,0 +1,32 @@
+/*
+ * 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.rpc;
+
+import com.google.common.annotations.Beta;
+import java.util.concurrent.CompletionStage;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+@Beta
+public interface RpcService<I extends DataObject, O extends DataObject> {
+
+    @Nonnull CompletionStage<O> invoke(@Nullable final I request);
+
+    @Nonnull SchemaPath getManagedNode();
+}
diff --git a/infra/rpc/asciidoc/Readme.adoc b/infra/rpc/asciidoc/Readme.adoc
new file mode 100644 (file)
index 0000000..248593a
--- /dev/null
@@ -0,0 +1,3 @@
+= rpc-aggregator
+
+Overview of rpc-aggregator
\ No newline at end of file
diff --git a/infra/rpc/impl/asciidoc/Readme.adoc b/infra/rpc/impl/asciidoc/Readme.adoc
new file mode 100644 (file)
index 0000000..9b9441a
--- /dev/null
@@ -0,0 +1,3 @@
+= rpc-impl
+
+Overview of rpc-impl
\ No newline at end of file
diff --git a/infra/rpc/impl/pom.xml b/infra/rpc/impl/pom.xml
new file mode 100644 (file)
index 0000000..7e52f4d
--- /dev/null
@@ -0,0 +1,69 @@
+<?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.17.01-SNAPSHOT</version>
+        <relativePath>../../../common/impl-parent</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.fd.honeycomb</groupId>
+    <artifactId>rpc-impl</artifactId>
+    <name>${project.artifactId}</name>
+    <version>1.17.01-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>rpc-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.mdsal</groupId>
+            <artifactId>mdsal-binding-dom-codec</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.controller</groupId>
+            <artifactId>sal-core-spi</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>net.javacrumbs.future-converter</groupId>
+            <artifactId>future-converter-java8-guava</artifactId>
+            <version>0.3.0</version>
+        </dependency>
+
+        <!-- tests -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/HoneycombDOMRpcService.java
new file mode 100644 (file)
index 0000000..09f93db
--- /dev/null
@@ -0,0 +1,96 @@
+/*
+ * 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.rpc;
+
+import static net.javacrumbs.futureconverter.java8guava.FutureConverter.toListenableFuture;
+
+import com.google.common.base.Function;
+import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcAvailabilityListener;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
+import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public final class HoneycombDOMRpcService implements DOMRpcService {
+
+    private static final Function<? super Exception, DOMRpcException> ANY_EX_TO_RPC_EXCEPTION_MAPPER =
+        (Function<Exception, DOMRpcException>) e -> (e instanceof DOMRpcException)
+            ? (DOMRpcException) e
+            : new RpcException("RPC failed", e);
+
+    // TODO HONEYCOMB-161 what to use instead of deprecated BindingNormalizedNodeSerializer ?
+    private final BindingNormalizedNodeSerializer serializer;
+    private final RpcRegistry rpcRegistry;
+
+    public HoneycombDOMRpcService(@Nonnull final BindingNormalizedNodeSerializer serializer,
+                                  @Nonnull final RpcRegistry rpcRegistry) {
+        this.serializer = serializer;
+        this.rpcRegistry = rpcRegistry;
+    }
+
+    @Nonnull
+    @Override
+    public CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(@Nonnull final SchemaPath schemaPath,
+                                                                  @Nullable final NormalizedNode<?, ?> normalizedNode) {
+        DataObject input = null;
+        if (normalizedNode != null) {
+            // RPC input is optional
+            final SchemaPath nodePatch = schemaPath.createChild(normalizedNode.getNodeType());
+            input = serializer.fromNormalizedNodeRpcData(nodePatch, (ContainerNode) normalizedNode);
+        }
+        final CompletableFuture<DataObject> result = rpcRegistry.invoke(schemaPath, input).toCompletableFuture();
+        final ListenableFuture<DOMRpcResult> output = getDOMRpcResult(toListenableFuture(result));
+        return Futures.makeChecked(output, ANY_EX_TO_RPC_EXCEPTION_MAPPER);
+    }
+
+    private ListenableFuture<DOMRpcResult> getDOMRpcResult(final ListenableFuture<DataObject> invoke) {
+        return Futures.transform(
+            invoke,
+            (Function<DataObject, DOMRpcResult>) output -> {
+                final ContainerNode outputNode = serializer.toNormalizedNodeRpcData(output);
+                return new DefaultDOMRpcResult(outputNode);
+            });
+    }
+
+    @Nonnull
+    @Override
+    public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(@Nonnull final T t) {
+        return new ListenerRegistration<T>() {
+            @Override
+            public void close() {
+                // Noop
+            }
+
+            @Override
+            public T getInstance() {
+                return t;
+            }
+        };
+    }
+}
diff --git a/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java b/infra/rpc/impl/src/main/java/io/fd/honeycomb/rpc/RpcRegistryBuilder.java
new file mode 100644 (file)
index 0000000..0b96be0
--- /dev/null
@@ -0,0 +1,63 @@
+/*
+ * 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.rpc;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public final class RpcRegistryBuilder {
+
+    private Map<SchemaPath, RpcService> services = new HashMap<>();
+
+    public RpcRegistry build() {
+        return new RpcRegistryImpl(services);
+    }
+
+    public void addService(@Nonnull final RpcService service) {
+        services.put(service.getManagedNode(), service);
+    }
+
+
+    private static final class RpcRegistryImpl implements RpcRegistry {
+        private final Map<SchemaPath, RpcService> services;
+
+        private RpcRegistryImpl(@Nonnull final Map<SchemaPath, RpcService> services) {
+            this.services = services;
+        }
+
+        @Override
+        @Nonnull
+        public CompletionStage invoke(@Nonnull final SchemaPath schemaPath, @Nullable final DataObject request) {
+            final RpcService rpcService = services.get(schemaPath);
+            if (rpcService == null) {
+                final CompletableFuture<DataObject> result = new CompletableFuture<>();
+                result.completeExceptionally(
+                    new DOMRpcImplementationNotAvailableException("Service not found: %s", schemaPath));
+                return result;
+            }
+            return rpcService.invoke(request);
+
+        }
+    }
+}
diff --git a/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/HoneycombDOMRpcServiceTest.java
new file mode 100644 (file)
index 0000000..476db56
--- /dev/null
@@ -0,0 +1,82 @@
+/*
+ * 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.rpc;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.concurrent.CompletableFuture;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.opendaylight.yangtools.binding.data.codec.api.BindingNormalizedNodeSerializer;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public class HoneycombDOMRpcServiceTest {
+
+    @Mock
+    private BindingNormalizedNodeSerializer serializer;
+    @Mock
+    private RpcRegistry registry;
+    @Mock
+    private SchemaPath path;
+    @Mock
+    private DataObject input;
+    @Mock
+    private ContainerNode output;
+
+    private ContainerNode node;
+    private HoneycombDOMRpcService service;
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+        node = mockContainerNode(QName.create("a"));
+
+        service = new HoneycombDOMRpcService(serializer, registry);
+
+        Mockito.when(serializer.fromNormalizedNodeRpcData(ArgumentMatchers.any(), ArgumentMatchers.any())).thenReturn(input);
+        Mockito.when(serializer.toNormalizedNodeRpcData(ArgumentMatchers.any())).thenReturn(output);
+    }
+
+    @Test
+    public void testInvokeRpc() throws Exception {
+        Mockito.when(registry.invoke(path, input)).thenReturn(CompletableFuture.completedFuture(input));
+
+        assertEquals(output, service.invokeRpc(path, node).get().getResult());
+    }
+
+    @Test(expected = RpcException.class)
+    public void testInvokeRpcFailed() throws Exception {
+        final CompletableFuture future = new CompletableFuture();
+        future.completeExceptionally(new RuntimeException());
+        Mockito.when(registry.invoke(path, input)).thenReturn(future);
+
+        service.invokeRpc(path, node).checkedGet();
+    }
+
+    private ContainerNode mockContainerNode(final QName nn1) {
+        final ContainerNode nn1B = Mockito.mock(ContainerNode.class);
+        Mockito.when(nn1B.getNodeType()).thenReturn(nn1);
+        return nn1B;
+    }
+}
\ No newline at end of file
diff --git a/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java b/infra/rpc/impl/src/test/java/io/fd/honeycomb/rpc/RpcRegistryBuilderTest.java
new file mode 100644 (file)
index 0000000..c7d7ce7
--- /dev/null
@@ -0,0 +1,80 @@
+/*
+ * 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.rpc;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.util.concurrent.ExecutionException;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentMatchers;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationNotAvailableException;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+
+public class RpcRegistryBuilderTest {
+
+    private RpcRegistry registry;
+    @Mock
+    private RpcService service1;
+    @Mock
+    private RpcService service2;
+    private static final SchemaPath ID1 = SchemaPath.ROOT.createChild(QName.create("a"));
+    private static final SchemaPath ID2 = SchemaPath.ROOT.createChild(QName.create("b"));
+
+    @Before
+    public void setUp() {
+        service1 = Mockito.mock(RpcService.class);
+        Mockito.when(service1.getManagedNode()).thenReturn(ID1);
+
+        service2 = Mockito.mock(RpcService.class);
+        Mockito.when(service2.getManagedNode()).thenReturn(ID2);
+
+        final RpcRegistryBuilder builder = new RpcRegistryBuilder();
+        builder.addService(service1);
+        builder.addService(service2);
+        registry = builder.build();
+    }
+
+    @Test
+    public void testInvokeService() {
+        final DataObject request = Mockito.mock(DataObject.class);
+
+        registry.invoke(ID2, request);
+
+        Mockito.verify(service2).invoke(request);
+        Mockito.verify(service1, Mockito.never()).invoke(ArgumentMatchers.any());
+    }
+
+    @Test
+    public void testServiceNotFound() throws ExecutionException, InterruptedException {
+        final SchemaPath id = SchemaPath.ROOT.createChild(QName.create("c"));
+        final DataObject request = Mockito.mock(DataObject.class);
+
+        try {
+            registry.invoke(id, request).toCompletableFuture().get();
+        } catch (Exception e) {
+            assertTrue(e.getCause() instanceof DOMRpcImplementationNotAvailableException);
+            return;
+        }
+        fail("Exception expected");
+    }
+}
\ No newline at end of file
diff --git a/infra/rpc/pom.xml b/infra/rpc/pom.xml
new file mode 100644 (file)
index 0000000..64bd9d5
--- /dev/null
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>honeycomb-parent</artifactId>
+        <version>1.17.01-SNAPSHOT</version>
+        <relativePath>../../common/honeycomb-parent</relativePath>
+    </parent>
+
+    <groupId>io.fd.honeycomb</groupId>
+    <artifactId>rpc-aggregator</artifactId>
+    <version>1.17.01-SNAPSHOT</version>
+    <name>${project.artifactId}</name>
+    <packaging>pom</packaging>
+    <modelVersion>4.0.0</modelVersion>
+
+    <modules>
+        <module>api</module>
+        <module>impl</module>
+    </modules>
+    <!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build -->
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-install-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
\ No newline at end of file