Add ActionProviderService adapter
[mdsal.git] / binding / mdsal-binding-dom-adapter / src / main / java / org / opendaylight / mdsal / binding / dom / adapter / ActionProviderServiceAdapter.java
1 /*
2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.mdsal.binding.dom.adapter;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableSet;
14 import com.google.common.util.concurrent.FluentFuture;
15 import java.util.Set;
16 import org.eclipse.jdt.annotation.NonNullByDefault;
17 import org.opendaylight.mdsal.binding.api.ActionProviderService;
18 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
21 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
22 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
23 import org.opendaylight.mdsal.dom.api.DOMActionResult;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
25 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
26 import org.opendaylight.yangtools.concepts.ObjectRegistration;
27 import org.opendaylight.yangtools.yang.binding.Action;
28 import org.opendaylight.yangtools.yang.binding.DataObject;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
30 import org.opendaylight.yangtools.yang.common.RpcResult;
31 import org.opendaylight.yangtools.yang.common.YangConstants;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
34 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
35
36 @Beta
37 @NonNullByDefault
38 final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
39         implements ActionProviderService {
40     ActionProviderServiceAdapter(final BindingToNormalizedNodeCodec codec, final DOMActionProviderService delegate) {
41         super(codec, delegate);
42     }
43
44     @Override
45     public <O extends DataObject, P extends InstanceIdentifier<O>,
46         T extends org.opendaylight.yangtools.yang.binding.Action<P, ?, ?>, S extends T>
47         ObjectRegistration<S> registerImplementation(final Class<T> actionInterface, final S implementation,
48                 final LogicalDatastoreType datastore, final Set<DataTreeIdentifier<O>> validNodes) {
49         final SchemaPath path = getCodec().getActionPath(actionInterface);
50         final ObjectRegistration<DOMActionImplementation> reg = getDelegate().registerActionImplementation(
51             new Impl(getCodec(),
52                 NodeIdentifier.create(YangConstants.operationOutputQName(path.getLastComponent().getModule())),
53                 actionInterface, implementation), ImmutableSet.of());
54         return new AbstractObjectRegistration<S>(implementation) {
55             @Override
56             protected void removeRegistration() {
57                 reg.close();
58             }
59         };
60     }
61
62     private static final class Impl implements DOMActionImplementation {
63         private final Class<? extends Action<?, ?, ?>> actionInterface;
64         private final Action implementation;
65         private final BindingNormalizedNodeSerializer codec;
66         private final NodeIdentifier outputName;
67
68         Impl(final BindingNormalizedNodeSerializer codec, final NodeIdentifier outputName,
69                 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
70             this.codec = requireNonNull(codec);
71             this.outputName = requireNonNull(outputName);
72             this.actionInterface = requireNonNull(actionInterface);
73             this.implementation = requireNonNull(implementation);
74         }
75
76         @Override
77         @SuppressWarnings({ "rawtypes", "unchecked" })
78         public FluentFuture<? extends DOMActionResult> invokeAction(final SchemaPath type,
79                 final DOMDataTreeIdentifier path, final ContainerNode input) {
80             final FluentFuture<RpcResult<?>> userFuture = implementation.invoke(
81                 codec.fromYangInstanceIdentifier(path.getRootIdentifier()),
82                 codec.fromNormalizedNodeActionInput(actionInterface, input));
83             if (userFuture instanceof BindingOperationFluentFuture) {
84                 // If we are looping back through our future we can skip wrapping. This can happen if application
85                 // forwards invocations between multiple instantiations of the same action.
86                 return (BindingOperationFluentFuture) userFuture;
87             }
88
89             return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, codec);
90         }
91     }
92 }