X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=dom%2Fmdsal-dom-broker%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fdom%2Fbroker%2FDOMRpcRouter.java;h=76323b059e7dc91f84f26275427d0469417b3c50;hb=11408d627adca7eb71ac956c3ad01f75b6b91596;hp=f1fa5a70de1cf0f8a4bb03f6a4af3ea049732181;hpb=003b279ba947e1efc230afe110e83715c5c1c2bf;p=mdsal.git diff --git a/dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java b/dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java index f1fa5a70de..76323b059e 100644 --- a/dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java +++ b/dom/mdsal-dom-broker/src/main/java/org/opendaylight/mdsal/dom/broker/DOMRpcRouter.java @@ -7,6 +7,7 @@ */ package org.opendaylight.mdsal.dom.broker; +import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Verify.verifyNotNull; import static java.util.Objects.requireNonNull; @@ -15,7 +16,7 @@ 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.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.MapDifference; import com.google.common.collect.MapDifference.ValueDifference; @@ -24,10 +25,8 @@ import com.google.common.collect.Sets; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.ThreadFactoryBuilder; -import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.ArrayList; import java.util.Collection; -import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; @@ -37,6 +36,7 @@ import java.util.Set; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.ThreadFactory; +import javax.annotation.PreDestroy; import javax.inject.Inject; import javax.inject.Singleton; import org.checkerframework.checker.lock.qual.GuardedBy; @@ -48,7 +48,6 @@ 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; @@ -68,19 +67,28 @@ 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.yang.common.QName; 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.EffectiveModelContext; import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener; -import org.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; +import org.osgi.service.component.annotations.Deactivate; +import org.osgi.service.component.annotations.Reference; +import org.osgi.service.component.annotations.RequireServiceComponentRuntime; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Singleton +@Component(immediate = true, service = DOMRpcRouterServices.class) +@RequireServiceComponentRuntime public final class DOMRpcRouter extends AbstractRegistration implements DOMRpcRouterServices, EffectiveModelContextListener { + private static final Logger LOG = LoggerFactory.getLogger(DOMRpcRouter.class); private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder().setNameFormat( "DOMRpcRouter-listener-%s").setDaemon(true).build(); @@ -91,10 +99,10 @@ public final class DOMRpcRouter extends AbstractRegistration private final @NonNull DOMRpcService rpcService = new RpcServiceFacade(); @GuardedBy("this") - private Collection> listeners = Collections.emptyList(); + private ImmutableList> listeners = ImmutableList.of(); @GuardedBy("this") - private Collection> actionListeners = Collections.emptyList(); + private ImmutableList> actionListeners = ImmutableList.of(); private volatile DOMRpcRoutingTable routingTable = DOMRpcRoutingTable.EMPTY; @@ -102,11 +110,29 @@ public final class DOMRpcRouter extends AbstractRegistration private ListenerRegistration listenerRegistration; + @Deprecated + @VisibleForTesting + // FIXME: 9.0.0: make this constructor package-private + public DOMRpcRouter() { + + } + @Inject + @Activate + public DOMRpcRouter(@Reference final DOMSchemaService schemaService) { + listenerRegistration = schemaService.registerSchemaContextListener(this); + LOG.info("DOM RPC/Action router started"); + } + + @Deprecated(forRemoval = true) public static DOMRpcRouter newInstance(final DOMSchemaService schemaService) { - final DOMRpcRouter rpcRouter = new DOMRpcRouter(); - rpcRouter.listenerRegistration = schemaService.registerSchemaContextListener(rpcRouter); - return rpcRouter; + return new DOMRpcRouter(schemaService); + } + + @PreDestroy + @Deactivate + public void shutdown() { + close(); } @Override @@ -129,8 +155,6 @@ public final class DOMRpcRouter extends AbstractRegistration return rpcProviderService; } - @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", - justification = "https://github.com/spotbugs/spotbugs/issues/811") private synchronized void removeRpcImplementation(final DOMRpcImplementation implementation, final Set rpcs) { final DOMRpcRoutingTable oldTable = routingTable; @@ -140,8 +164,14 @@ public final class DOMRpcRouter extends AbstractRegistration listenerNotifier.execute(() -> notifyRemoved(newTable, implementation)); } - @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", - justification = "https://github.com/spotbugs/spotbugs/issues/811") + private synchronized void removeRpcImplementations(final Map map) { + final DOMRpcRoutingTable oldTable = routingTable; + final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.removeAll(map); + routingTable = newTable; + + listenerNotifier.execute(() -> notifyRemoved(newTable, map.values())); + } + private synchronized void removeActionImplementation(final DOMActionImplementation implementation, final Set actions) { final DOMActionRoutingTable oldTable = actionRoutingTable; @@ -151,32 +181,44 @@ public final class DOMRpcRouter extends AbstractRegistration listenerNotifier.execute(() -> notifyActionChanged(newTable, implementation)); } - @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", - justification = "https://github.com/spotbugs/spotbugs/issues/811") private synchronized void removeListener(final ListenerRegistration reg) { listeners = ImmutableList.copyOf(Collections2.filter(listeners, input -> !reg.equals(input))); } - @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", - justification = "https://github.com/spotbugs/spotbugs/issues/811") private synchronized void removeActionListener(final ListenerRegistration reg) { actionListeners = ImmutableList.copyOf(Collections2.filter(actionListeners, input -> !reg.equals(input))); } - @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", - justification = "https://github.com/spotbugs/spotbugs/issues/811") private synchronized void notifyAdded(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) { for (Registration l : listeners) { l.addRpc(newTable, impl); } } + private synchronized void notifyAdded(final DOMRpcRoutingTable newTable, + final Collection impls) { + for (Registration l : listeners) { + for (DOMRpcImplementation impl : impls) { + l.addRpc(newTable, impl); + } + } + } + private synchronized void notifyRemoved(final DOMRpcRoutingTable newTable, final DOMRpcImplementation impl) { for (Registration l : listeners) { l.removeRpc(newTable, impl); } } + private synchronized void notifyRemoved(final DOMRpcRoutingTable newTable, + final Collection impls) { + for (Registration l : listeners) { + for (DOMRpcImplementation impl : impls) { + l.removeRpc(newTable, impl); + } + } + } + private synchronized void notifyActionChanged(final DOMActionRoutingTable newTable, final DOMActionImplementation impl) { for (ActionRegistration l : actionListeners) { @@ -203,13 +245,19 @@ public final class DOMRpcRouter extends AbstractRegistration listenerRegistration = null; } listenerNotifier.shutdown(); + LOG.info("DOM RPC/Action router stopped"); } @VisibleForTesting - synchronized Collection listeners() { + synchronized List listeners() { return listeners; } + @VisibleForTesting + synchronized List actionListeners() { + return actionListeners; + } + @VisibleForTesting DOMRpcRoutingTable routingTable() { return routingTable; @@ -218,11 +266,10 @@ public final class DOMRpcRouter extends AbstractRegistration private static final class Registration extends AbstractListenerRegistration { - private Map> prevRpcs; + private Map> prevRpcs; private DOMRpcRouter router; - Registration(final DOMRpcRouter router, final T listener, - final Map> rpcs) { + Registration(final DOMRpcRouter router, final T listener, final Map> rpcs) { super(listener); this.router = requireNonNull(router); this.prevRpcs = requireNonNull(rpcs); @@ -235,8 +282,8 @@ public final class DOMRpcRouter extends AbstractRegistration } void initialTable() { - final Collection added = new ArrayList<>(); - for (Entry> e : prevRpcs.entrySet()) { + final List added = new ArrayList<>(); + for (Entry> e : prevRpcs.entrySet()) { added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i))); } if (!added.isEmpty()) { @@ -250,15 +297,14 @@ public final class DOMRpcRouter extends AbstractRegistration return; } - final Map> rpcs = verifyNotNull(newTable.getOperations(l)); - final MapDifference> diff = Maps.difference(prevRpcs, rpcs); + final Map> rpcs = verifyNotNull(newTable.getOperations(l)); + final MapDifference> diff = Maps.difference(prevRpcs, rpcs); - final Collection added = new ArrayList<>(); - for (Entry> e : diff.entriesOnlyOnRight().entrySet()) { + final List added = new ArrayList<>(); + for (Entry> e : diff.entriesOnlyOnRight().entrySet()) { added.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i))); } - for (Entry>> e : - diff.entriesDiffering().entrySet()) { + for (Entry>> e : diff.entriesDiffering().entrySet()) { for (YangInstanceIdentifier i : Sets.difference(e.getValue().rightValue(), e.getValue().leftValue())) { added.add(DOMRpcIdentifier.create(e.getKey(), i)); } @@ -276,15 +322,14 @@ public final class DOMRpcRouter extends AbstractRegistration return; } - final Map> rpcs = verifyNotNull(newTable.getOperations(l)); - final MapDifference> diff = Maps.difference(prevRpcs, rpcs); + final Map> rpcs = verifyNotNull(newTable.getOperations(l)); + final MapDifference> diff = Maps.difference(prevRpcs, rpcs); - final Collection removed = new ArrayList<>(); - for (Entry> e : diff.entriesOnlyOnLeft().entrySet()) { + final List removed = new ArrayList<>(); + for (Entry> e : diff.entriesOnlyOnLeft().entrySet()) { removed.addAll(Collections2.transform(e.getValue(), i -> DOMRpcIdentifier.create(e.getKey(), i))); } - for (Entry>> e : - diff.entriesDiffering().entrySet()) { + for (Entry>> e : diff.entriesDiffering().entrySet()) { for (YangInstanceIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) { removed.add(DOMRpcIdentifier.create(e.getKey(), i)); } @@ -300,11 +345,11 @@ public final class DOMRpcRouter extends AbstractRegistration private static final class ActionRegistration extends AbstractListenerRegistration { - private Map> prevActions; + private Map> prevActions; private DOMRpcRouter router; ActionRegistration(final DOMRpcRouter router, final T listener, - final Map> actions) { + final Map> actions) { super(listener); this.router = requireNonNull(router); this.prevActions = requireNonNull(actions); @@ -317,8 +362,8 @@ public final class DOMRpcRouter extends AbstractRegistration } void initialTable() { - final Collection added = new ArrayList<>(); - for (Entry> e : prevActions.entrySet()) { + final List added = new ArrayList<>(); + for (Entry> e : prevActions.entrySet()) { added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i))); } if (!added.isEmpty()) { @@ -332,22 +377,21 @@ public final class DOMRpcRouter extends AbstractRegistration return; } - final Map> actions = verifyNotNull(newTable.getOperations(l)); - final MapDifference> diff = Maps.difference(prevActions, actions); + final Map> actions = verifyNotNull(newTable.getOperations(l)); + final MapDifference> diff = Maps.difference(prevActions, actions); final Set removed = new HashSet<>(); final Set added = new HashSet<>(); - for (Entry> e : diff.entriesOnlyOnLeft().entrySet()) { + for (Entry> e : diff.entriesOnlyOnLeft().entrySet()) { removed.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i))); } - for (Entry> e : diff.entriesOnlyOnRight().entrySet()) { + for (Entry> e : diff.entriesOnlyOnRight().entrySet()) { added.addAll(Collections2.transform(e.getValue(), i -> DOMActionInstance.of(e.getKey(), i))); } - for (Entry>> e : - diff.entriesDiffering().entrySet()) { + for (Entry>> e : diff.entriesDiffering().entrySet()) { for (DOMDataTreeIdentifier i : Sets.difference(e.getValue().leftValue(), e.getValue().rightValue())) { removed.add(DOMActionInstance.of(e.getKey(), i)); } @@ -369,12 +413,12 @@ public final class DOMRpcRouter extends AbstractRegistration @Override public ListenerRegistration registerAvailabilityListener(final T listener) { synchronized (DOMRpcRouter.this) { - final ActionRegistration ret = new ActionRegistration<>(DOMRpcRouter.this, - listener, actionRoutingTable.getOperations(listener)); - final Builder> b = ImmutableList.builder(); - b.addAll(actionListeners); - b.add(ret); - actionListeners = b.build(); + final ActionRegistration ret = new ActionRegistration<>(DOMRpcRouter.this, listener, + actionRoutingTable.getOperations(listener)); + actionListeners = ImmutableList.>builder() + .addAll(actionListeners) + .add(ret) + .build(); listenerNotifier.execute(ret::initialTable); return ret; @@ -393,28 +437,23 @@ public final class DOMRpcRouter extends AbstractRegistration } @Override - public ListenableFuture invokeAction(final SchemaPath type, + public ListenableFuture invokeAction(final Absolute type, final DOMDataTreeIdentifier path, final ContainerNode input) { + final YangInstanceIdentifier pathRoot = path.getRootIdentifier(); + checkArgument(!pathRoot.isEmpty(), "Action path must not be empty"); + final DOMActionRoutingTableEntry entry = (DOMActionRoutingTableEntry) actionRoutingTable.getEntry(type); - if (entry == null) { - return Futures.immediateFailedFuture( + return entry != null ? OperationInvocation.invoke(entry, type, path, requireNonNull(input)) + : Futures.immediateFailedFuture( new DOMActionNotAvailableException("No implementation of Action %s available", type)); - } - - return OperationInvocation.invoke(entry, type, path, requireNonNull(input)); } } @NonNullByDefault private final class ActionProviderServiceFacade implements DOMActionProviderService { - @Override - public ClassToInstanceMap getExtensions() { - return ImmutableClassToInstanceMap.of(); - } - @Override public ObjectRegistration registerActionImplementation( - final T implementation, final Set instances) { + final T implementation, final Set instances) { synchronized (DOMRpcRouter.this) { final DOMActionRoutingTable oldTable = actionRoutingTable; @@ -435,8 +474,7 @@ public final class DOMRpcRouter extends AbstractRegistration private final class RpcServiceFacade implements DOMRpcService { @Override - public ListenableFuture invokeRpc(final SchemaPath type, - final NormalizedNode input) { + public ListenableFuture invokeRpc(final QName type, final NormalizedNode input) { final AbstractDOMRpcRoutingTableEntry entry = (AbstractDOMRpcRoutingTableEntry) routingTable.getEntry(type); if (entry == null) { return Futures.immediateFailedFuture( @@ -451,10 +489,7 @@ public final class DOMRpcRouter extends AbstractRegistration synchronized (DOMRpcRouter.this) { final Registration ret = new Registration<>(DOMRpcRouter.this, listener, routingTable.getOperations(listener)); - final Builder> b = ImmutableList.builder(); - b.addAll(listeners); - b.add(ret); - listeners = b.build(); + listeners = ImmutableList.>builder().addAll(listeners).add(ret).build(); listenerNotifier.execute(ret::initialTable); return ret; @@ -465,13 +500,13 @@ public final class DOMRpcRouter extends AbstractRegistration private final class RpcProviderServiceFacade implements DOMRpcProviderService { @Override public DOMRpcImplementationRegistration registerRpcImplementation( - final T implementation, final DOMRpcIdentifier... rpcs) { + final T implementation, final DOMRpcIdentifier... rpcs) { return registerRpcImplementation(implementation, ImmutableSet.copyOf(rpcs)); } @Override public DOMRpcImplementationRegistration registerRpcImplementation( - final T implementation, final Set rpcs) { + final T implementation, final Set rpcs) { synchronized (DOMRpcRouter.this) { final DOMRpcRoutingTable oldTable = routingTable; @@ -488,22 +523,53 @@ public final class DOMRpcRouter extends AbstractRegistration } }; } + + @Override + public org.opendaylight.yangtools.concepts.Registration registerRpcImplementations( + final Map map) { + final ImmutableMap defensive = ImmutableMap.copyOf(map); + checkArgument(!map.isEmpty()); + + synchronized (DOMRpcRouter.this) { + final DOMRpcRoutingTable oldTable = routingTable; + final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.addAll(defensive); + routingTable = newTable; + + listenerNotifier.execute(() -> notifyAdded(newTable, defensive.values())); + } + + return new AbstractRegistration() { + @Override + protected void removeRegistration() { + removeRpcImplementations(defensive); + } + }; + } } static final class OperationInvocation { private static final Logger LOG = LoggerFactory.getLogger(OperationInvocation.class); static ListenableFuture invoke(final DOMActionRoutingTableEntry entry, - final SchemaPath type, final DOMDataTreeIdentifier path, final ContainerNode input) { - return entry.getImplementations(path).get(0).invokeAction(type, path, input); + final Absolute type, final DOMDataTreeIdentifier path, final ContainerNode input) { + List impls = entry.getImplementations(path); + if (impls == null) { + impls = entry.getImplementations( + new DOMDataTreeIdentifier(path.getDatastoreType(), YangInstanceIdentifier.empty())); + if (impls == null) { + return Futures.immediateFailedFuture(new DOMActionNotAvailableException( + "No implementation of Action %s available for %s", type, path)); + } + } + + return impls.get(0).invokeAction(type, path, input); } static ListenableFuture invoke(final AbstractDOMRpcRoutingTableEntry entry, - final NormalizedNode input) { + final NormalizedNode input) { if (entry instanceof UnknownDOMRpcRoutingTableEntry) { return Futures.immediateFailedFuture( - new DOMRpcImplementationNotAvailableException("SchemaPath %s is not resolved to an RPC", - entry.getType())); + new DOMRpcImplementationNotAvailableException("%s is not resolved to an RPC", entry.getType())); } else if (entry instanceof RoutedDOMRpcRoutingTableEntry) { return invokeRoutedRpc((RoutedDOMRpcRoutingTableEntry) entry, input); } else if (entry instanceof GlobalDOMRpcRoutingTableEntry) { @@ -515,14 +581,14 @@ public final class DOMRpcRouter extends AbstractRegistration } private static ListenableFuture invokeRoutedRpc( - final RoutedDOMRpcRoutingTableEntry entry, final NormalizedNode input) { - final Optional> maybeKey = NormalizedNodes.findNode(input, + final RoutedDOMRpcRoutingTableEntry entry, final NormalizedNode input) { + final Optional maybeKey = NormalizedNodes.findNode(input, entry.getRpcId().getContextReference()); // Routing key is present, attempt to deliver as a routed RPC if (maybeKey.isPresent()) { - final NormalizedNode key = maybeKey.get(); - final Object value = key.getValue(); + final NormalizedNode key = maybeKey.get(); + final Object value = key.body(); if (value instanceof YangInstanceIdentifier) { final YangInstanceIdentifier iid = (YangInstanceIdentifier) value; @@ -561,7 +627,7 @@ public final class DOMRpcRouter extends AbstractRegistration } private static ListenableFuture invokeGlobalRpc( - final GlobalDOMRpcRoutingTableEntry entry, final NormalizedNode input) { + final GlobalDOMRpcRoutingTableEntry entry, final NormalizedNode input) { return entry.getImplementations(YangInstanceIdentifier.empty()).get(0).invokeRpc(entry.getRpcId(), input); } }