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 com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ClassToInstanceMap;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.Set;
  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.ActionSpec;
  21 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  22 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
  23 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  24 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
  25 import org.opendaylight.mdsal.dom.api.DOMActionInstance;
  26 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
  27 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  29 import org.opendaylight.mdsal.dom.api.DOMService;
  30 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
  31 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  32 import org.opendaylight.yangtools.yang.binding.Action;
  33 import org.opendaylight.yangtools.yang.binding.DataObject;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.common.RpcResult;
  36 import org.opendaylight.yangtools.yang.common.YangConstants;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  40 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  41
  42 @NonNullByDefault
  43 public final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
  44         implements ActionProviderService {
  45     private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
  46         Builder(final AdapterContext adapterContext) {
  47             super(adapterContext);
  48         }
  49
  50         @Override
  51         protected ActionProviderService createInstance(final ClassToInstanceMap<DOMService> delegates) {
  52             return new ActionProviderServiceAdapter(adapterContext(),
  53                 delegates.getInstance(DOMActionProviderService.class));
  54         }
  55
  56         @Override
  57         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  58             return ImmutableSet.of(DOMActionProviderService.class);
  59         }
  60     }
  61
  62     static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
  63
  64     ActionProviderServiceAdapter(final AdapterContext adapterContext, final DOMActionProviderService delegate) {
  65         super(adapterContext, delegate);
  66     }
  67
  68     @Override
  69     public <P extends DataObject, A extends Action<InstanceIdentifier<P>, ?, ?>, S extends A>
  70             ObjectRegistration<S> registerImplementation(final ActionSpec<A, P> spec, final S implementation,
  71                 final LogicalDatastoreType datastore, final Set<InstanceIdentifier<P>> validNodes) {
  72         final CurrentAdapterSerializer serializer = currentSerializer();
  73         final Absolute actionPath = serializer.getActionPath(spec);
  74         final Impl impl = new Impl(adapterContext(), actionPath, spec.type(), implementation);
  75         final DOMActionInstance instance = validNodes.isEmpty()
  76             // Register on the entire datastore
  77             ? DOMActionInstance.of(actionPath, new DOMDataTreeIdentifier(datastore, YangInstanceIdentifier.empty()))
  78                 // Register on specific instances
  79                 : DOMActionInstance.of(actionPath, validNodes.stream()
  80                     .map(node -> serializer.toDOMDataTreeIdentifier(DataTreeIdentifier.create(datastore, node)))
  81                     .collect(Collectors.toUnmodifiableSet()));
  82
  83
  84         final ObjectRegistration<?> reg = getDelegate().registerActionImplementation(impl, instance);
  85
  86         return new AbstractObjectRegistration<>(implementation) {
  87             @Override
  88             protected void removeRegistration() {
  89                 reg.close();
  90             }
  91         };
  92     }
  93
  94     private static final class Impl implements DOMActionImplementation {
  95         private final Class<? extends Action<?, ?, ?>> actionInterface;
  96         private final AdapterContext adapterContext;
  97         private final Action implementation;
  98         private final NodeIdentifier outputName;
  99
 100         Impl(final AdapterContext adapterContext, final Absolute actionPath,
 101                 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
 102             this.adapterContext = requireNonNull(adapterContext);
 103             outputName = NodeIdentifier.create(
 104                 YangConstants.operationOutputQName(actionPath.lastNodeIdentifier().getModule()));
 105             this.actionInterface = requireNonNull(actionInterface);
 106             this.implementation = requireNonNull(implementation);
 107         }
 108
 109         @Override
 110         @SuppressWarnings({ "rawtypes", "unchecked" })
 111         public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute type,
 112                 final DOMDataTreeIdentifier path, final ContainerNode input) {
 113             final CurrentAdapterSerializer codec = adapterContext.currentSerializer();
 114
 115             final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(
 116                 verifyNotNull(codec.fromYangInstanceIdentifier(path.getRootIdentifier())),
 117                 codec.fromNormalizedNodeActionInput(actionInterface, input));
 118             if (userFuture instanceof BindingOperationFluentFuture) {
 119                 // If we are looping back through our future we can skip wrapping. This can happen if application
 120                 // forwards invocations between multiple instantiations of the same action.
 121                 return (BindingOperationFluentFuture) userFuture;
 122             }
 123
 124             return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, adapterContext);
 125         }
 126     }
 127 }