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