netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/DeviceActionFactoryImpl.java

   1 /*
   2  * Copyright © 2019 FRINX s.r.o. 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.netconf.sal.connect.netconf;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ClassToInstanceMap;
  13 import com.google.common.collect.ImmutableClassToInstanceMap;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import javax.inject.Singleton;
  18 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  19 import org.opendaylight.mdsal.dom.api.DOMActionService;
  20 import org.opendaylight.mdsal.dom.api.DOMActionServiceExtension;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  22 import org.opendaylight.netconf.api.NetconfMessage;
  23 import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory;
  24 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
  25 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
  26 import org.opendaylight.yangtools.yang.common.RpcResult;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  30 import org.osgi.service.component.annotations.Component;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * Implementation of the factory for creation of {@link DOMActionService} instances that are provided by device.
  36  * {@link DOMActionService} is implemented using {@link MessageTransformer} that builds NETCONF RPCs and
  37  * transforms replied NETCONF message  to action result, and using {@link RemoteDeviceCommunicator} that is responsible
  38  * for sending of built RPCs to NETCONF client.
  39  */
  40 @Singleton
  41 @Component(immediate = true, property = "type=default")
  42 public class DeviceActionFactoryImpl implements DeviceActionFactory {
  43     private static final Logger LOG = LoggerFactory.getLogger(DeviceActionFactoryImpl.class);
  44
  45     @Override
  46     public DOMActionService createDeviceAction(final MessageTransformer<NetconfMessage> messageTransformer,
  47             final RemoteDeviceCommunicator<NetconfMessage> listener, final SchemaContext schemaContext) {
  48
  49         return new DOMActionService() {
  50             @Override
  51             public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute schemaPath,
  52                     final DOMDataTreeIdentifier dataTreeIdentifier, final ContainerNode input) {
  53                 requireNonNull(schemaPath);
  54                 requireNonNull(dataTreeIdentifier);
  55                 requireNonNull(input);
  56
  57                 final ListenableFuture<RpcResult<NetconfMessage>> actionResultFuture = listener.sendRequest(
  58                         messageTransformer.toActionRequest(schemaPath, dataTreeIdentifier, input), input.getNodeType());
  59
  60                 return Futures.transform(actionResultFuture, netconfMessageRpcResult -> {
  61                     if (netconfMessageRpcResult != null) {
  62                         return messageTransformer.toActionResult(schemaPath, netconfMessageRpcResult.getResult());
  63                     } else {
  64                         final String message = "Missing action result of action on schema path: " + schemaPath;
  65                         LOG.error(message);
  66                         throw new IllegalStateException(message);
  67                     }
  68                 }, MoreExecutors.directExecutor());
  69             }
  70
  71             @Override
  72             public ClassToInstanceMap<DOMActionServiceExtension> getExtensions() {
  73                 return ImmutableClassToInstanceMap.of();
  74             }
  75         };
  76     }
  77 }