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 org.eclipse.jdt.annotation.NonNullByDefault;
18 import org.opendaylight.mdsal.binding.api.ActionProviderService;
19 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
20 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
22 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
23 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
24 import org.opendaylight.mdsal.dom.api.DOMActionResult;
25 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
26 import org.opendaylight.mdsal.dom.api.DOMService;
27 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
28 import org.opendaylight.yangtools.concepts.ObjectRegistration;
29 import org.opendaylight.yangtools.yang.binding.Action;
30 import org.opendaylight.yangtools.yang.binding.DataObject;
31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
32 import org.opendaylight.yangtools.yang.common.RpcResult;
33 import org.opendaylight.yangtools.yang.common.YangConstants;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
36 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
39 public final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
40 implements ActionProviderService {
41 private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
42 Builder(final AdapterContext adapterContext) {
43 super(adapterContext);
47 protected ActionProviderService createInstance(final ClassToInstanceMap<DOMService> delegates) {
48 return new ActionProviderServiceAdapter(adapterContext(),
49 delegates.getInstance(DOMActionProviderService.class));
53 public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
54 return ImmutableSet.of(DOMActionProviderService.class);
58 static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
60 ActionProviderServiceAdapter(final AdapterContext adapterContext, final DOMActionProviderService delegate) {
61 super(adapterContext, delegate);
65 public <O extends DataObject, P extends InstanceIdentifier<O>, T extends Action<P, ?, ?>, S extends T>
66 ObjectRegistration<S> registerImplementation(final Class<T> actionInterface, final S implementation,
67 final LogicalDatastoreType datastore, final Set<DataTreeIdentifier<O>> validNodes) {
68 final SchemaPath path = currentSerializer().getActionPath(actionInterface);
69 final ObjectRegistration<DOMActionImplementation> reg = getDelegate().registerActionImplementation(
70 new Impl(adapterContext(),
71 NodeIdentifier.create(YangConstants.operationOutputQName(path.getLastComponent().getModule())),
72 actionInterface, implementation), ImmutableSet.of());
73 return new AbstractObjectRegistration<>(implementation) {
75 protected void removeRegistration() {
81 private static final class Impl implements DOMActionImplementation {
82 private final Class<? extends Action<?, ?, ?>> actionInterface;
83 private final AdapterContext adapterContext;
84 private final Action implementation;
85 private final NodeIdentifier outputName;
87 Impl(final AdapterContext adapterContext, final NodeIdentifier outputName,
88 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
89 this.adapterContext = requireNonNull(adapterContext);
90 this.outputName = requireNonNull(outputName);
91 this.actionInterface = requireNonNull(actionInterface);
92 this.implementation = requireNonNull(implementation);
96 @SuppressWarnings({ "rawtypes", "unchecked" })
97 public ListenableFuture<? extends DOMActionResult> invokeAction(final SchemaPath type,
98 final DOMDataTreeIdentifier path, final ContainerNode input) {
99 final CurrentAdapterSerializer codec = adapterContext.currentSerializer();
101 final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(
102 verifyNotNull(codec.fromYangInstanceIdentifier(path.getRootIdentifier())),
103 codec.fromNormalizedNodeActionInput(actionInterface, input));
104 if (userFuture instanceof BindingOperationFluentFuture) {
105 // If we are looping back through our future we can skip wrapping. This can happen if application
106 // forwards invocations between multiple instantiations of the same action.
107 return (BindingOperationFluentFuture) userFuture;
110 return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, adapterContext);