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.ClassToInstanceMap;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.util.concurrent.FluentFuture;
  16 import java.util.Set;
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  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.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  23 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  24 import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
  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.NodeIdentifier;
  37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  39
  40 @Beta
  41 @NonNullByDefault
  42 final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
  43         implements ActionProviderService {
  44     private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
  45         @Override
  46         protected ActionProviderService createInstance(final @Nullable BindingToNormalizedNodeCodec codec,
  47                 final ClassToInstanceMap<DOMService> delegates) {
  48             final DOMActionProviderService domAction = delegates.getInstance(DOMActionProviderService.class);
  49             return new ActionProviderServiceAdapter(requireNonNull(codec), domAction);
  50         }
  51
  52         @Override
  53         public Set<? extends Class<? extends DOMService>> getRequiredDelegates() {
  54             return ImmutableSet.of(DOMActionProviderService.class);
  55         }
  56     }
  57
  58     static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
  59
  60     ActionProviderServiceAdapter(final BindingToNormalizedNodeCodec codec, final DOMActionProviderService delegate) {
  61         super(codec, delegate);
  62     }
  63
  64     @Override
  65     public <O extends DataObject, P extends InstanceIdentifier<O>,
  66         T extends org.opendaylight.yangtools.yang.binding.Action<P, ?, ?>, S extends T>
  67         ObjectRegistration<S> registerImplementation(final Class<T> actionInterface, final S implementation,
  68                 final LogicalDatastoreType datastore, final Set<DataTreeIdentifier<O>> validNodes) {
  69         final SchemaPath path = getCodec().getActionPath(actionInterface);
  70         final ObjectRegistration<DOMActionImplementation> reg = getDelegate().registerActionImplementation(
  71             new Impl(getCodec(),
  72                 NodeIdentifier.create(YangConstants.operationOutputQName(path.getLastComponent().getModule())),
  73                 actionInterface, implementation), ImmutableSet.of());
  74         return new AbstractObjectRegistration<S>(implementation) {
  75             @Override
  76             protected void removeRegistration() {
  77                 reg.close();
  78             }
  79         };
  80     }
  81
  82     private static final class Impl implements DOMActionImplementation {
  83         private final Class<? extends Action<?, ?, ?>> actionInterface;
  84         private final Action implementation;
  85         private final BindingNormalizedNodeSerializer codec;
  86         private final NodeIdentifier outputName;
  87
  88         Impl(final BindingNormalizedNodeSerializer codec, final NodeIdentifier outputName,
  89                 final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
  90             this.codec = requireNonNull(codec);
  91             this.outputName = requireNonNull(outputName);
  92             this.actionInterface = requireNonNull(actionInterface);
  93             this.implementation = requireNonNull(implementation);
  94         }
  95
  96         @Override
  97         @SuppressWarnings({ "rawtypes", "unchecked" })
  98         public FluentFuture<? extends DOMActionResult> invokeAction(final SchemaPath type,
  99                 final DOMDataTreeIdentifier path, final ContainerNode input) {
 100             final FluentFuture<RpcResult<?>> userFuture = implementation.invoke(
 101                 codec.fromYangInstanceIdentifier(path.getRootIdentifier()),
 102                 codec.fromNormalizedNodeActionInput(actionInterface, input));
 103             if (userFuture instanceof BindingOperationFluentFuture) {
 104                 // If we are looping back through our future we can skip wrapping. This can happen if application
 105                 // forwards invocations between multiple instantiations of the same action.
 106                 return (BindingOperationFluentFuture) userFuture;
 107             }
 108
 109             return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, codec);
 110         }
 111     }
 112 }