Add DOMAction(Provider)Service facades 10/74210/19
authorRobert Varga <robert.varga@pantheon.tech>
Wed, 18 Jul 2018 16:36:33 +0000 (18:36 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Mon, 6 Aug 2018 08:53:41 +0000 (10:53 +0200)
DOMRpcRouter needs to be able to route actions, i.e. implement
DOMActionService and DOMActionProviderService. Add facades
and implement them.

Change-Id: I9f66f3aee5ab5b63c2d0dcb3571831a7913a4650
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMActionAvailabilityExtension.java
dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java
dom/mdsal-dom-broker/src/main/resources/org/opendaylight/blueprint/dom-broker.xml
dom/mdsal-dom-broker/src/test/java/org/opendaylight/mdsal/dom/broker/GlobalDOMRpcRoutingTableEntryTest.java
dom/mdsal-dom-broker/src/test/java/org/opendaylight/mdsal/dom/broker/RoutedDOMRpcRoutingTableEntryTest.java
dom/mdsal-dom-broker/src/test/java/org/opendaylight/mdsal/dom/broker/UnknownDOMRpcRoutingTableEntryTest.java

index 52478bc9ec46260ea65ce1b5d719116ba7472c49..886ff01094f9fde48b511e80dc4a8becfaa3723a 100644 (file)
@@ -62,7 +62,7 @@ public interface DOMActionAvailabilityExtension extends DOMActionServiceExtensio
          * @param removed operations which disappeared
          * @param added operations which became available
          */
-        void onActionsChanged(Set<DOMActionInstance> removed, Set<DOMActionService> added);
+        void onActionsChanged(Set<DOMActionInstance> removed, Set<DOMActionInstance> added);
 
         /**
          * Implementation filtering method. This method is useful for forwarding operation implementations,
index 0ddd34259c7c825442b8549c8404f9ef31c33784..8d20c38421f469a0ff91f93527f4d041e866cca4 100644 (file)
@@ -11,7 +11,9 @@ import static com.google.common.base.Verify.verifyNotNull;
 import static java.util.Objects.requireNonNull;
 
 import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ClassToInstanceMap;
 import com.google.common.collect.Collections2;
+import com.google.common.collect.ImmutableClassToInstanceMap;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList.Builder;
 import com.google.common.collect.ImmutableSet;
@@ -24,6 +26,7 @@ import com.google.common.util.concurrent.ThreadFactoryBuilder;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -33,6 +36,18 @@ import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ThreadFactory;
 import javax.annotation.concurrent.GuardedBy;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.opendaylight.mdsal.dom.api.DOMActionAvailabilityExtension;
+import org.opendaylight.mdsal.dom.api.DOMActionAvailabilityExtension.AvailabilityListener;
+import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
+import org.opendaylight.mdsal.dom.api.DOMActionInstance;
+import org.opendaylight.mdsal.dom.api.DOMActionNotAvailableException;
+import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
+import org.opendaylight.mdsal.dom.api.DOMActionProviderServiceExtension;
+import org.opendaylight.mdsal.dom.api.DOMActionResult;
+import org.opendaylight.mdsal.dom.api.DOMActionService;
+import org.opendaylight.mdsal.dom.api.DOMActionServiceExtension;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
 import org.opendaylight.mdsal.dom.api.DOMRpcAvailabilityListener;
 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
@@ -44,10 +59,13 @@ import org.opendaylight.mdsal.dom.api.DOMRpcService;
 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
 import org.opendaylight.mdsal.dom.spi.AbstractDOMRpcImplementationRegistration;
 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
+import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
 import org.opendaylight.yangtools.concepts.AbstractRegistration;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.concepts.ObjectRegistration;
 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
@@ -61,14 +79,21 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
             "DOMRpcRouter-listener-%s").setDaemon(true).build();
 
     private final ExecutorService listenerNotifier = Executors.newSingleThreadExecutor(THREAD_FACTORY);
+    private final DOMActionProviderService actionProviderService = new ActionProviderServiceFacade();
+    private final DOMActionService actionService = new ActionServiceFacade();
     private final DOMRpcProviderService rpcProviderService = new RpcProviderServiceFacade();
     private final DOMRpcService rpcService = new RpcServiceFacade();
 
     @GuardedBy("this")
     private Collection<Registration<?>> listeners = Collections.emptyList();
 
+    @GuardedBy("this")
+    private Collection<ActionRegistration<?>> actionListeners = Collections.emptyList();
+
     private volatile DOMRpcRoutingTable routingTable = DOMRpcRoutingTable.EMPTY;
 
+    private volatile DOMActionRoutingTable actionRoutingTable = DOMActionRoutingTable.EMPTY;
+
     private ListenerRegistration<?> listenerRegistration;
 
     public static DOMRpcRouter newInstance(final DOMSchemaService schemaService) {
@@ -77,6 +102,14 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         return rpcRouter;
     }
 
+    public DOMActionService getActionService() {
+        return actionService;
+    }
+
+    public DOMActionProviderService getActionProviderService() {
+        return actionProviderService;
+    }
+
     public DOMRpcService getRpcService() {
         return rpcService;
     }
@@ -94,10 +127,23 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         listenerNotifier.execute(() -> notifyRemoved(newTable, implementation));
     }
 
+    private synchronized void removeActionImplementation(final DOMActionImplementation implementation,
+            final Set<DOMActionInstance> actions) {
+        final DOMActionRoutingTable oldTable = actionRoutingTable;
+        final DOMActionRoutingTable newTable = (DOMActionRoutingTable) oldTable.remove(implementation, actions);
+        actionRoutingTable = newTable;
+
+        listenerNotifier.execute(() -> notifyActionChanged(newTable, implementation));
+    }
+
     private synchronized void removeListener(final ListenerRegistration<? extends DOMRpcAvailabilityListener> reg) {
         listeners = ImmutableList.copyOf(Collections2.filter(listeners, input -> !reg.equals(input)));
     }
 
+    private synchronized void removeActionListener(final ListenerRegistration<? extends AvailabilityListener> reg) {
+        actionListeners = ImmutableList.copyOf(Collections2.filter(actionListeners, input -> !reg.equals(input)));
+    }
+
     private synchronized void notifyAdded(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) {
         for (Registration<?> l : listeners) {
             l.addRpc(newTable, impl);
@@ -110,6 +156,13 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         }
     }
 
+    private synchronized void notifyActionChanged(final DOMActionRoutingTable newTable,
+            final DOMActionImplementation impl) {
+        for (ActionRegistration<?> l : actionListeners) {
+            l.actionChanged(newTable, impl);
+        }
+    }
+
     @Override
     public synchronized void onGlobalContextUpdated(final SchemaContext context) {
         final DOMRpcRoutingTable oldTable = routingTable;
@@ -218,6 +271,142 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         }
     }
 
+    private static final class ActionRegistration<T extends AvailabilityListener>
+        extends AbstractListenerRegistration<T> {
+
+        private Map<SchemaPath, Set<DOMDataTreeIdentifier>> prevActions;
+        private DOMRpcRouter router;
+
+        ActionRegistration(final DOMRpcRouter router, final T listener,
+                final Map<SchemaPath, Set<DOMDataTreeIdentifier>> actions) {
+            super(listener);
+            this.router = requireNonNull(router);
+            this.prevActions = requireNonNull(actions);
+        }
+
+        @Override
+        protected void removeRegistration() {
+            router.removeActionListener(this);
+            router = null;
+        }
+
+        void initialTable() {
+            final Collection<DOMActionInstance> added = new ArrayList<>();
+            for (Entry<SchemaPath, Set<DOMDataTreeIdentifier>> e : prevActions.entrySet()) {
+                added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
+            }
+            if (!added.isEmpty()) {
+                getInstance().onActionsChanged(ImmutableSet.of(), ImmutableSet.copyOf(added));
+            }
+        }
+
+        void actionChanged(final DOMActionRoutingTable newTable, final DOMActionImplementation impl) {
+            final T l = getInstance();
+            if (!l.acceptsImplementation(impl)) {
+                return;
+            }
+
+            final Map<SchemaPath, Set<DOMDataTreeIdentifier>> actions = verifyNotNull(newTable.getOperations(l));
+            final MapDifference<SchemaPath, Set<DOMDataTreeIdentifier>> diff = Maps.difference(prevActions, actions);
+
+            final Set<DOMActionInstance> removed = new HashSet<>();
+            final Set<DOMActionInstance> added = new HashSet<>();
+
+            for (Entry<SchemaPath, Set<DOMDataTreeIdentifier>> e : diff.entriesOnlyOnLeft().entrySet()) {
+                removed.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
+            }
+
+            for (Entry<SchemaPath, Set<DOMDataTreeIdentifier>> e : diff.entriesOnlyOnRight().entrySet()) {
+                added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i)));
+            }
+
+            for (Entry<SchemaPath, ValueDifference<Set<DOMDataTreeIdentifier>>> e :
+                diff.entriesDiffering().entrySet()) {
+                for (DOMDataTreeIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) {
+                    removed.add(DOMActionInstance.of(e.getKey(), i));
+                }
+
+                for (DOMDataTreeIdentifier i : Sets.difference(e.getValue().rightValue(), e.getValue().leftValue())) {
+                    added.add(DOMActionInstance.of(e.getKey(), i));
+                }
+            }
+
+            prevActions = actions;
+            if (!removed.isEmpty() || !added.isEmpty()) {
+                l.onActionsChanged(removed, added);
+            }
+        }
+    }
+
+    @NonNullByDefault
+    private final class ActionAvailabilityFacade implements DOMActionAvailabilityExtension {
+        @Override
+        public <T extends AvailabilityListener> ListenerRegistration<T> registerAvailabilityListener(final T listener) {
+            synchronized (DOMRpcRouter.this) {
+                final ActionRegistration<T> ret = new ActionRegistration<>(DOMRpcRouter.this,
+                    listener, actionRoutingTable.getOperations(listener));
+                final Builder<ActionRegistration<?>> b = ImmutableList.builder();
+                b.addAll(actionListeners);
+                b.add(ret);
+                actionListeners = b.build();
+
+                listenerNotifier.execute(ret::initialTable);
+                return ret;
+            }
+        }
+    }
+
+    @NonNullByDefault
+    private final class ActionServiceFacade implements DOMActionService {
+        private final ClassToInstanceMap<DOMActionServiceExtension> extensions = ImmutableClassToInstanceMap.of(
+            DOMActionAvailabilityExtension.class, new ActionAvailabilityFacade());
+
+        @Override
+        public ClassToInstanceMap<DOMActionServiceExtension> getExtensions() {
+            return extensions;
+        }
+
+        @Override
+        public FluentFuture<? extends DOMActionResult> invokeAction(final SchemaPath type,
+                final DOMDataTreeIdentifier path, final ContainerNode input) {
+            final DOMActionRoutingTableEntry entry = (DOMActionRoutingTableEntry) actionRoutingTable.getEntry(type);
+            if (entry == null) {
+                return FluentFutures.immediateFailedFluentFuture(
+                    new DOMActionNotAvailableException("No implementation of Action %s available", type));
+            }
+
+            return OperationInvocation.invoke(entry, type, path, input);
+        }
+    }
+
+    @NonNullByDefault
+    private final class ActionProviderServiceFacade implements DOMActionProviderService {
+        @Override
+        public ClassToInstanceMap<DOMActionProviderServiceExtension> getExtensions() {
+            return ImmutableClassToInstanceMap.of();
+        }
+
+        @Override
+        public <T extends DOMActionImplementation> ObjectRegistration<T> registerActionImplementation(
+            final T implementation, final Set<DOMActionInstance> instances) {
+
+            synchronized (DOMRpcRouter.this) {
+                final DOMActionRoutingTable oldTable = actionRoutingTable;
+                final DOMActionRoutingTable newTable = (DOMActionRoutingTable) oldTable.add(implementation, instances);
+                actionRoutingTable = newTable;
+
+                listenerNotifier.execute(() -> notifyActionChanged(newTable, implementation));
+            }
+
+            return new AbstractObjectRegistration<T>(implementation) {
+                @Override
+                protected void removeRegistration() {
+                    removeActionImplementation(getInstance(), instances);
+                }
+            };
+        }
+    }
+
     private final class RpcServiceFacade implements DOMRpcService {
         @Override
         public FluentFuture<DOMRpcResult> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
@@ -227,14 +416,14 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
                     new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
             }
 
-            return RpcInvocation.invoke(entry, input);
+            return OperationInvocation.invoke(entry, input);
         }
 
         @Override
         public <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(final T listener) {
             synchronized (DOMRpcRouter.this) {
                 final Registration<T> ret = new Registration<>(DOMRpcRouter.this, listener,
-                        routingTable.getOperations(listener));
+                    routingTable.getOperations(listener));
                 final Builder<Registration<?>> b = ImmutableList.builder();
                 b.addAll(listeners);
                 b.add(ret);
@@ -249,13 +438,13 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
     private final class RpcProviderServiceFacade implements DOMRpcProviderService {
         @Override
         public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(
-                final T implementation, final DOMRpcIdentifier... rpcs) {
+            final T implementation, final DOMRpcIdentifier... rpcs) {
             return registerRpcImplementation(implementation, ImmutableSet.copyOf(rpcs));
         }
 
         @Override
         public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(
-                final T implementation, final Set<DOMRpcIdentifier> rpcs) {
+            final T implementation, final Set<DOMRpcIdentifier> rpcs) {
 
             synchronized (DOMRpcRouter.this) {
                 final DOMRpcRoutingTable oldTable = routingTable;
@@ -274,11 +463,16 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         }
     }
 
-    static final class RpcInvocation {
-        private static final Logger LOG = LoggerFactory.getLogger(RpcInvocation.class);
+    static final class OperationInvocation {
+        private static final Logger LOG = LoggerFactory.getLogger(OperationInvocation.class);
+
+        static FluentFuture<? extends DOMActionResult> invoke(final DOMActionRoutingTableEntry entry,
+                final SchemaPath type, final DOMDataTreeIdentifier path, final ContainerNode input) {
+            return entry.getImplementations(path).get(0).invokeAction(type, path, input);
+        }
 
         static FluentFuture<DOMRpcResult> invoke(final AbstractDOMRpcRoutingTableEntry entry,
-            final NormalizedNode<?, ?> input) {
+                final NormalizedNode<?, ?> input) {
             if (entry instanceof UnknownDOMRpcRoutingTableEntry) {
                 return FluentFutures.immediateFailedFluentFuture(
                     new DOMRpcImplementationNotAvailableException("SchemaPath %s is not resolved to an RPC",
@@ -294,7 +488,7 @@ public final class DOMRpcRouter extends AbstractRegistration implements SchemaCo
         }
 
         private static FluentFuture<DOMRpcResult> invokeRoutedRpc(final RoutedDOMRpcRoutingTableEntry entry,
-            final NormalizedNode<?, ?> input) {
+                final NormalizedNode<?, ?> input) {
             final Optional<NormalizedNode<?, ?>> maybeKey = NormalizedNodes.findNode(input,
                 entry.getRpcId().getContextReference());
 
index 9a2ed88159d603ba76f98784d8f0884497fd0e31..9ce030a30f608ddc62ab9dde84e0124f607ecce4 100644 (file)
     </interfaces>
   </service>
 
+  <bean id="domActionService" factory-ref="domRpcRouter" factory-method="getActionService"/>
+  <service ref="domActionService" odl:type="default">
+    <interfaces>
+      <value>org.opendaylight.mdsal.dom.api.DOMActionService</value>
+    </interfaces>
+  </service>
+
+  <bean id="domActionProviderService" factory-ref="domRpcRouter" factory-method="getActionProviderService"/>
+  <service ref="domActionProviderService" odl:type="default">
+    <interfaces>
+      <value>org.opendaylight.mdsal.dom.api.DOMActionProviderService</value>
+    </interfaces>
+  </service>
+
   <!-- DOM MountPoint Service -->
 
   <bean id="domMountPointService" class="org.opendaylight.mdsal.dom.broker.DOMMountPointServiceImpl"/>
index 512a7687e489902e89f11bb17ebfba3d190e4dd7..9014555f01c9749cb6bef1bac8348d386a9f6675 100644 (file)
@@ -23,7 +23,7 @@ import java.util.concurrent.TimeoutException;
 import org.junit.Test;
 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
-import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.RpcInvocation;
+import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.OperationInvocation;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
@@ -50,7 +50,7 @@ public class GlobalDOMRpcRoutingTableEntryTest extends TestUtils {
                 rpcImplementation));
 
         try {
-            RpcInvocation.invoke(globalDOMRpcRoutingTableEntry.newInstance(rpcImplementations),
+            OperationInvocation.invoke(globalDOMRpcRoutingTableEntry.newInstance(rpcImplementations),
                     TEST_CONTAINER).get(5, TimeUnit.SECONDS);
             fail("Expected DOMRpcImplementationNotAvailableException");
         } catch (ExecutionException e) {
index a67908dda1ae2abcc5567c2d3c7d52d7a04dbdb2..b8ae49ea0d70b471df7be006b259f6018dfa2c20 100644 (file)
@@ -18,7 +18,7 @@ import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeoutException;
 import org.junit.Test;
 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
-import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.RpcInvocation;
+import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.OperationInvocation;
 import org.opendaylight.mdsal.dom.broker.util.TestModel;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
@@ -36,7 +36,7 @@ public class RoutedDOMRpcRoutingTableEntryTest extends TestUtils {
         assertNotNull(routedDOMRpcRoutingTableEntry.newInstance(new HashMap<>()));
 
         try {
-            RpcInvocation.invoke(routedDOMRpcRoutingTableEntry, TEST_CHILD).get();
+            OperationInvocation.invoke(routedDOMRpcRoutingTableEntry, TEST_CHILD).get();
             fail("Expected DOMRpcImplementationNotAvailableException");
         } catch (ExecutionException e) {
             assertTrue(e.getCause() instanceof DOMRpcImplementationNotAvailableException);
index 7e0e829ae6d61fb9de83f0756e9a0cc697554d94..3f9a0055272bbb8b067f7f514fe8db2b64d834d4 100644 (file)
@@ -17,7 +17,7 @@ import java.util.List;
 import java.util.Map;
 import org.junit.Test;
 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
-import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.RpcInvocation;
+import org.opendaylight.mdsal.dom.broker.DOMRpcRouter.OperationInvocation;
 import org.opendaylight.mdsal.dom.broker.util.TestModel;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
@@ -38,7 +38,7 @@ public class UnknownDOMRpcRoutingTableEntryTest extends TestUtils {
 
         assertNotNull(test);
         assertNotNull(test.newInstance(emptyImpls));
-        assertNotNull(RpcInvocation.invoke(test, TEST_CONTAINER));
+        assertNotNull(OperationInvocation.invoke(test, TEST_CONTAINER));
         assertNotNull(test.getImplementations());
         assertEquals(test.getImplementations(YangInstanceIdentifier.EMPTY), TEST_LIST);
         assertTrue(test.containsContext(YangInstanceIdentifier.EMPTY));