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.collect.ClassToInstanceMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.List;
  17 import java.util.Set;
  18 import java.util.stream.Collectors;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.opendaylight.mdsal.binding.api.ActionProviderService;
  21 import org.opendaylight.mdsal.binding.api.ActionSpec;
  22 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  23 import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
  26 import org.opendaylight.mdsal.dom.api.DOMActionInstance;
  27 import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
  28 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  29 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  30 import org.opendaylight.mdsal.dom.api.DOMService;
  31 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
  32 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
  33 import org.opendaylight.yangtools.concepts.ObjectRegistration;
  34 import org.opendaylight.yangtools.yang.binding.Action;
  35 import org.opendaylight.yangtools.yang.binding.DataObject;
  36 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  37 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  38 import org.opendaylight.yangtools.yang.common.RpcResult;
  39 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  40 import org.opendaylight.yangtools.yang.common.YangConstants;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  44 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 @NonNullByDefault
  49 public final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
  50         implements ActionProviderService {
  51     private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
  52         Builder(final AdapterContext adapterContext) {
  53             super(adapterContext);
  54         }
  55
  56         @Override
  57         protected ActionProviderService createInstance(final ClassToInstanceMap<DOMService> delegates) {
  58             return new ActionProviderServiceAdapter(adapterContext(),
  59                 delegates.getInstance(DOMActionProviderService.class));
  60         }
  61
  62         @Override
  63         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  64             return ImmutableSet.of(DOMActionProviderService.class);
  65         }
  66     }
  67
  68     private static final Logger LOG = LoggerFactory.getLogger(ActionProviderServiceAdapter.class);
  69
  70     static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
  71
  72     ActionProviderServiceAdapter(final AdapterContext adapterContext, final DOMActionProviderService delegate) {
  73         super(adapterContext, delegate);
  74     }
  75
  76     @Override
  77     public <P extends DataObject, A extends Action<? extends InstanceIdentifier<P>, ?, ?>, S extends A>
  78             ObjectRegistration<S> registerImplementation(final ActionSpec<A, P> spec, final S implementation,
  79                 final LogicalDatastoreType datastore, final Set<? extends InstanceIdentifier<P>> validNodes) {
  80         final CurrentAdapterSerializer serializer = currentSerializer();
  81         final Absolute actionPath = serializer.getActionPath(spec);
  82         final Impl impl = new Impl(adapterContext(), actionPath, spec.type(), implementation);
  83         final DOMActionInstance instance = validNodes.isEmpty()
  84             // Register on the entire datastore
  85             ? DOMActionInstance.of(actionPath, new DOMDataTreeIdentifier(datastore, YangInstanceIdentifier.empty()))
  86                 // Register on specific instances
  87                 : DOMActionInstance.of(actionPath, validNodes.stream()
  88                     .map(node -> serializer.toDOMDataTreeIdentifier(DataTreeIdentifier.create(datastore, node)))
  89                     .collect(Collectors.toUnmodifiableSet()));
  90
  91
  92         final ObjectRegistration<?> reg = getDelegate().registerActionImplementation(impl, instance);
  93
  94         return new AbstractObjectRegistration<>(implementation) {
  95             @Override
  96             protected void removeRegistration() {
  97                 reg.close();
  98             }
  99         };
 100     }
 101
 102     private static final class Impl implements DOMActionImplementation {
 103         private final Class<? extends Action<?, ?, ?>> actionInterface;
 104         private final AdapterContext adapterContext;
 105         @SuppressWarnings("rawtypes")
 106         private final Action implementation;
 107         private final NodeIdentifier outputName;
 108
 109         Impl(final AdapterContext adapterContext, final Absolute actionPath,
 110                 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
 111             this.adapterContext = requireNonNull(adapterContext);
 112             outputName = NodeIdentifier.create(
 113                 YangConstants.operationOutputQName(actionPath.lastNodeIdentifier().getModule()));
 114             this.actionInterface = requireNonNull(actionInterface);
 115             this.implementation = requireNonNull(implementation);
 116         }
 117
 118         @Override
 119         @SuppressWarnings({ "rawtypes", "unchecked" })
 120         public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute type,
 121                 final DOMDataTreeIdentifier path, final ContainerNode input) {
 122             final CurrentAdapterSerializer codec = adapterContext.currentSerializer();
 123             final InstanceIdentifier<DataObject> instance = codec.fromYangInstanceIdentifier(path.getRootIdentifier());
 124             if (instance == null) {
 125                 // Not representable: return an error
 126                 LOG.debug("Path {} is not representable in binding, rejecting invocation", path);
 127                 return Futures.immediateFuture(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
 128                     ErrorType.APPLICATION, "invalid-value", "Supplied path cannot be represented"))));
 129             }
 130             if (instance.isWildcarded()) {
 131                 // A wildcard path: return an error
 132                 LOG.debug("Path {} maps to a wildcard {}, rejecting invocation", path, instance);
 133                 return Futures.immediateFuture(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
 134                     ErrorType.APPLICATION, "invalid-value", "Supplied path does not identify a concrete instance"))));
 135             }
 136
 137             final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(instance,
 138                 codec.fromNormalizedNodeActionInput(actionInterface, input));
 139             if (userFuture instanceof BindingOperationFluentFuture) {
 140                 // If we are looping back through our future we can skip wrapping. This can happen if application
 141                 // forwards invocations between multiple instantiations of the same action.
 142                 return (BindingOperationFluentFuture) userFuture;
 143             }
 144
 145             return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, adapterContext);
 146         }
 147     }
 148 }