2 * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.dom.adapter;
10 import static com.google.common.base.Verify.verifyNotNull;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.collect.ClassToInstanceMap;
14 import com.google.common.collect.ImmutableSet;
15 import com.google.common.util.concurrent.ListenableFuture;
17 import java.util.stream.Collectors;
18 import org.eclipse.jdt.annotation.NonNullByDefault;
19 import org.opendaylight.mdsal.binding.api.ActionProviderService;
20 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
21 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
23 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
24 import org.opendaylight.mdsal.dom.api.DOMActionInstance;
25 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
26 import org.opendaylight.mdsal.dom.api.DOMActionResult;
27 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
28 import org.opendaylight.mdsal.dom.api.DOMService;
29 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
30 import org.opendaylight.yangtools.concepts.ObjectRegistration;
31 import org.opendaylight.yangtools.yang.binding.Action;
32 import org.opendaylight.yangtools.yang.binding.DataObject;
33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
34 import org.opendaylight.yangtools.yang.common.RpcResult;
35 import org.opendaylight.yangtools.yang.common.YangConstants;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
39 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
42 public final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
43 implements ActionProviderService {
44 private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
45 Builder(final AdapterContext adapterContext) {
46 super(adapterContext);
50 protected ActionProviderService createInstance(final ClassToInstanceMap<DOMService> delegates) {
51 return new ActionProviderServiceAdapter(adapterContext(),
52 delegates.getInstance(DOMActionProviderService.class));
56 public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
57 return ImmutableSet.of(DOMActionProviderService.class);
61 static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
63 ActionProviderServiceAdapter(final AdapterContext adapterContext, final DOMActionProviderService delegate) {
64 super(adapterContext, delegate);
68 public <O extends DataObject, P extends InstanceIdentifier<O>, T extends Action<P, ?, ?>, S extends T>
69 ObjectRegistration<S> registerImplementation(final Class<T> actionInterface, final S implementation,
70 final LogicalDatastoreType datastore, final Set<InstanceIdentifier<O>> validNodes) {
71 final CurrentAdapterSerializer serializer = currentSerializer();
72 final Absolute actionPath = serializer.getActionPath(actionInterface);
73 final Impl impl = new Impl(adapterContext(), actionPath, actionInterface, implementation);
74 final DOMActionInstance instance = validNodes.isEmpty()
75 // Register on the entire datastore
76 ? DOMActionInstance.of(actionPath, new DOMDataTreeIdentifier(datastore, YangInstanceIdentifier.empty()))
77 // Register on specific instances
78 : DOMActionInstance.of(actionPath, validNodes.stream()
79 .map(node -> serializer.toDOMDataTreeIdentifier(DataTreeIdentifier.create(datastore, node)))
80 .collect(Collectors.toUnmodifiableSet()));
83 final ObjectRegistration<?> reg = getDelegate().registerActionImplementation(impl, instance);
85 return new AbstractObjectRegistration<>(implementation) {
87 protected void removeRegistration() {
93 private static final class Impl implements DOMActionImplementation {
94 private final Class<? extends Action<?, ?, ?>> actionInterface;
95 private final AdapterContext adapterContext;
96 private final Action implementation;
97 private final NodeIdentifier outputName;
99 Impl(final AdapterContext adapterContext, final Absolute actionPath,
100 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
101 this.adapterContext = requireNonNull(adapterContext);
102 this.outputName = NodeIdentifier.create(
103 YangConstants.operationOutputQName(actionPath.lastNodeIdentifier().getModule()));
104 this.actionInterface = requireNonNull(actionInterface);
105 this.implementation = requireNonNull(implementation);
109 @SuppressWarnings({ "rawtypes", "unchecked" })
110 public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute type,
111 final DOMDataTreeIdentifier path, final ContainerNode input) {
112 final CurrentAdapterSerializer codec = adapterContext.currentSerializer();
114 final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(
115 verifyNotNull(codec.fromYangInstanceIdentifier(path.getRootIdentifier())),
116 codec.fromNormalizedNodeActionInput(actionInterface, input));
117 if (userFuture instanceof BindingOperationFluentFuture) {
118 // If we are looping back through our future we can skip wrapping. This can happen if application
119 // forwards invocations between multiple instantiations of the same action.
120 return (BindingOperationFluentFuture) userFuture;
123 return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, adapterContext);