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

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies 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.api;
   9
  10 import org.opendaylight.controller.md.sal.dom.api.DOMActionService;
  11 import org.opendaylight.netconf.api.NetconfMessage;
  12 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  13
  14 public interface DeviceActionFactory {
  15
  16     /**
  17      * Allows user to create DOMActionService for specific device.
  18      *
  19      * @param messageTransformer - message transformer (for action in this case)
  20      * @param listener - allows specific service to send and receive messages to/from device
  21      * @param schemaContext - schema context of device
  22      * @return {@link DOMActionService} of specific device
  23      */
  24     default DOMActionService createDeviceAction(MessageTransformer<NetconfMessage> messageTransformer,
  25             RemoteDeviceCommunicator<NetconfMessage> listener, SchemaContext schemaContext) {
  26         return null;
  27     }
  28 }
  29