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;
import com.google.common.collect.MapDifference.ValueDifference;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
-import com.google.common.util.concurrent.CheckedFuture;
-import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.FluentFuture;
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;
+import java.util.Optional;
import java.util.Set;
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.DOMRpcException;
import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
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;
import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
public final class DOMRpcRouter extends AbstractRegistration implements SchemaContextListener {
private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder().setNameFormat(
"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) {
return rpcRouter;
}
+ public DOMActionService getActionService() {
+ return actionService;
+ }
+
+ public DOMActionProviderService getActionProviderService() {
+ return actionProviderService;
+ }
+
public DOMRpcService getRpcService() {
return rpcService;
}
private synchronized void removeRpcImplementation(final DOMRpcImplementation implementation,
final Set<DOMRpcIdentifier> rpcs) {
final DOMRpcRoutingTable oldTable = routingTable;
- final DOMRpcRoutingTable newTable = oldTable.remove(implementation, rpcs);
+ final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.remove(implementation, rpcs);
routingTable = newTable;
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);
}
}
+ 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;
- final DOMRpcRoutingTable newTable = oldTable.setSchemaContext(context);
+ final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.setSchemaContext(context);
routingTable = newTable;
+
+ final DOMActionRoutingTable oldActionTable = actionRoutingTable;
+ final DOMActionRoutingTable newActionTable = (DOMActionRoutingTable) oldActionTable.setSchemaContext(context);
+ actionRoutingTable = newActionTable;
}
@Override
}
@VisibleForTesting
- Collection<?> listeners() {
+ synchronized Collection<?> listeners() {
return listeners;
}
return;
}
- final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getRpcs(l));
+ final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getOperations(l));
final MapDifference<SchemaPath, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
final Collection<DOMRpcIdentifier> added = new ArrayList<>();
return;
}
- final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getRpcs(l));
+ final Map<SchemaPath, Set<YangInstanceIdentifier>> rpcs = verifyNotNull(newTable.getOperations(l));
final MapDifference<SchemaPath, Set<YangInstanceIdentifier>> diff = Maps.difference(prevRpcs, rpcs);
final Collection<DOMRpcIdentifier> removed = new ArrayList<>();
}
}
+ 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 CheckedFuture<DOMRpcResult, DOMRpcException> invokeRpc(final SchemaPath type,
- final NormalizedNode<?, ?> input) {
- final AbstractDOMRpcRoutingTableEntry entry = routingTable.getEntry(type);
+ public FluentFuture<DOMRpcResult> invokeRpc(final SchemaPath type, final NormalizedNode<?, ?> input) {
+ final AbstractDOMRpcRoutingTableEntry entry = (AbstractDOMRpcRoutingTableEntry) routingTable.getEntry(type);
if (entry == null) {
- return Futures.immediateFailedCheckedFuture(
+ return FluentFutures.immediateFailedFluentFuture(
new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available", type));
}
- return entry.invokeRpc(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.getRpcs(listener));
+ routingTable.getOperations(listener));
final Builder<Registration<?>> b = ImmutableList.builder();
b.addAll(listeners);
b.add(ret);
listeners = b.build();
- listenerNotifier.execute(() -> ret.initialTable());
+ listenerNotifier.execute(ret::initialTable);
return ret;
}
}
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;
- final DOMRpcRoutingTable newTable = oldTable.add(implementation, rpcs);
+ final DOMRpcRoutingTable newTable = (DOMRpcRoutingTable) oldTable.add(implementation, rpcs);
routingTable = newTable;
listenerNotifier.execute(() -> notifyAdded(newTable, implementation));
};
}
}
+
+ 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) {
+ if (entry instanceof UnknownDOMRpcRoutingTableEntry) {
+ return FluentFutures.immediateFailedFluentFuture(
+ new DOMRpcImplementationNotAvailableException("SchemaPath %s is not resolved to an RPC",
+ entry.getType()));
+ } else if (entry instanceof RoutedDOMRpcRoutingTableEntry) {
+ return invokeRoutedRpc((RoutedDOMRpcRoutingTableEntry) entry, input);
+ } else if (entry instanceof GlobalDOMRpcRoutingTableEntry) {
+ return invokeGlobalRpc((GlobalDOMRpcRoutingTableEntry) entry, input);
+ }
+
+ return FluentFutures.immediateFailedFluentFuture(
+ new DOMRpcImplementationNotAvailableException("Unsupported RPC entry."));
+ }
+
+ private static FluentFuture<DOMRpcResult> invokeRoutedRpc(final RoutedDOMRpcRoutingTableEntry entry,
+ final NormalizedNode<?, ?> input) {
+ final Optional<NormalizedNode<?, ?>> 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();
+ if (value instanceof YangInstanceIdentifier) {
+ final YangInstanceIdentifier iid = (YangInstanceIdentifier) value;
+
+ // Find a DOMRpcImplementation for a specific iid
+ final List<DOMRpcImplementation> specificImpls = entry.getImplementations(iid);
+ if (specificImpls != null) {
+ return specificImpls.get(0)
+ .invokeRpc(DOMRpcIdentifier.create(entry.getType(), iid), input);
+ }
+
+ LOG.debug("No implementation for context {} found will now look for wildcard id", iid);
+
+ // Find a DOMRpcImplementation for a wild card. Usually remote-rpc-connector would register an
+ // implementation this way
+ final List<DOMRpcImplementation> mayBeRemoteImpls =
+ entry.getImplementations(YangInstanceIdentifier.EMPTY);
+
+ if (mayBeRemoteImpls != null) {
+ return mayBeRemoteImpls.get(0)
+ .invokeRpc(DOMRpcIdentifier.create(entry.getType(), iid), input);
+ }
+
+ } else {
+ LOG.warn("Ignoring wrong context value {}", value);
+ }
+ }
+
+ final List<DOMRpcImplementation> impls = entry.getImplementations(null);
+ if (impls != null) {
+ return impls.get(0).invokeRpc(entry.getRpcId(), input);
+ }
+
+ return FluentFutures.immediateFailedFluentFuture(
+ new DOMRpcImplementationNotAvailableException("No implementation of RPC %s available",
+ entry.getType()));
+ }
+
+ private static FluentFuture<DOMRpcResult> invokeGlobalRpc(final GlobalDOMRpcRoutingTableEntry entry,
+ final NormalizedNode<?, ?> input) {
+ return entry.getImplementations(YangInstanceIdentifier.EMPTY).get(0).invokeRpc(entry.getRpcId(), input);
+ }
+ }
}