Power config consolidation Palc
Change-Id: Ia3469ded1822146f61760fc2779baedece8f01b4
diff --git a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/AdvaTerminalDevicePowerConfig.java b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/AdvaTerminalDevicePowerConfig.java
index e76df4e..17eaf92 100644
--- a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/AdvaTerminalDevicePowerConfig.java
+++ b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/AdvaTerminalDevicePowerConfig.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2018-present Open Networking Foundation
+ * Copyright 2019-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,447 +19,73 @@
package org.onosproject.drivers.odtn;
import com.google.common.collect.Range;
-import org.apache.commons.configuration.ConfigurationException;
-import org.apache.commons.configuration.HierarchicalConfiguration;
-import org.apache.commons.configuration.XMLConfiguration;
-import org.apache.commons.configuration.tree.xpath.XPathExpressionEngine;
-import org.onlab.osgi.DefaultServiceDirectory;
-import org.onosproject.drivers.utilities.XmlConfigParser;
-import org.onosproject.net.DeviceId;
+import org.onosproject.drivers.odtn.openconfig.TerminalDevicePowerConfig;
import org.onosproject.net.PortNumber;
import org.onosproject.net.behaviour.PowerConfig;
-import org.onosproject.net.device.DeviceService;
-import org.onosproject.net.driver.AbstractHandlerBehaviour;
-import org.onosproject.netconf.DatastoreId;
-import org.onosproject.netconf.NetconfController;
-import org.onosproject.netconf.NetconfDevice;
-import org.onosproject.netconf.NetconfException;
-import org.onosproject.netconf.NetconfSession;
import org.slf4j.Logger;
-import java.io.StringWriter;
-import java.util.ArrayList;
-import java.util.List;
import java.util.Optional;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutionException;
-import static com.google.common.base.Preconditions.checkNotNull;
import static org.slf4j.LoggerFactory.getLogger;
/**
* Driver Implementation of the PowerConfig for OpenConfig terminal devices.
*/
public class AdvaTerminalDevicePowerConfig<T>
- extends AbstractHandlerBehaviour implements PowerConfig<T> {
-
- private static final String RPC_TAG_NETCONF_BASE =
- "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
-
- private static final String RPC_CLOSE_TAG = "</rpc>";
+ extends TerminalDevicePowerConfig<T> implements PowerConfig<T> {
private static final Logger log = getLogger(AdvaTerminalDevicePowerConfig.class);
- private ComponentType state = ComponentType.DIRECTION;
+ /**
+ * Getting target value of output power.
+ * @param port port
+ * @param component the component
+ * @return target output power range
+ */
+ @Override
+ public Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
+ double targetMin = -30;
+ double targetMax = 1;
+ return Optional.of(Range.open(targetMin, targetMax));
+ }
+
+ @Override
+ public Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
+ double targetMin = -30;
+ double targetMax = 1;
+ return Optional.of(Range.open(targetMin, targetMax));
+ }
/**
- * Returns the NetconfSession with the device for which the method was called.
+ * Construct a rpc target power message.
*
- * @param deviceId device indetifier
- * @return The netconf session or null
- */
- private NetconfSession getNetconfSession(DeviceId deviceId) {
- NetconfController controller = handler().get(NetconfController.class);
- NetconfDevice ncdev = controller.getDevicesMap().get(deviceId);
- if (ncdev == null) {
- log.trace("No netconf device, returning null session");
- return null;
- }
- return ncdev.getSession();
- }
-
- /**
- * Get the deviceId for which the methods apply.
- *
- * @return The deviceId as contained in the handler data
- */
- private DeviceId did() {
- return handler().data().deviceId();
- }
-
- /**
- * Execute RPC request.
- *
- * @param session Netconf session
- * @param message Netconf message in XML format
- * @return XMLConfiguration object
- */
-
- private XMLConfiguration executeRpc(NetconfSession session, String message) {
- try {
- if (log.isDebugEnabled()) {
- try {
- StringWriter stringWriter = new StringWriter();
- XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(message);
- xconf.setExpressionEngine(new XPathExpressionEngine());
- xconf.save(stringWriter);
- log.debug("Request {}", stringWriter.toString());
- } catch (ConfigurationException e) {
- log.error("XML Config Exception ", e);
- }
- }
- CompletableFuture<String> fut = session.rpc(message);
- String rpcReply = fut.get();
- XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(rpcReply);
- xconf.setExpressionEngine(new XPathExpressionEngine());
- if (log.isDebugEnabled()) {
- try {
- StringWriter stringWriter = new StringWriter();
- xconf.save(stringWriter);
- log.debug("Response {}", stringWriter.toString());
- } catch (ConfigurationException e) {
- log.error("XML Config Exception ", e);
- }
- }
- return xconf;
- } catch (NetconfException ne) {
- log.error("Exception on Netconf protocol: {}.", ne);
- } catch (InterruptedException ie) {
- log.error("Interrupted Exception: {}.", ie);
- } catch (ExecutionException ee) {
- log.error("Concurrent Exception while executing Netconf operation: {}.", ee);
- }
- return null;
- }
-
- /**
- * Get the target-output-power value on specific optical-channel.
- *
- * @param port the port
- * @param component the port component. It should be 'oc-name' in the Annotations of Port.
- * 'oc-name' could be mapped to '/component/name' in openconfig yang.
- * @return target power value
+ * @param name for optical channel name
+ * @param power to build rpc for target output power configuration
+ * @return RPC payload
*/
@Override
- public Optional<Double> getTargetPower(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, T component, double power) {
- checkState(component);
- state.setTargetPower(port, component, power);
- }
-
- @Override
- public Optional<Double> currentPower(PortNumber port, T component) {
- checkState(component);
- return state.currentPower(port, component);
- }
-
- @Override
- public Optional<Double> currentInputPower(PortNumber port, T component) {
- checkState(component);
- return state.currentInputPower(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getTargetPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPowerRange(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getInputPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getInputPowerRange(port, component);
- }
-
- @Override
- public List<PortNumber> getPorts(T component) {
- checkState(component);
- return state.getPorts(component);
- }
-
-
- /**
- * Set the ComponentType to invoke proper methods for different template T.
- *
- * @param component the component.
- */
- void checkState(Object component) {
- String clsName = component.getClass().getName();
- switch (clsName) {
- case "org.onosproject.net.Direction":
- state = ComponentType.DIRECTION;
- break;
- case "org.onosproject.net.OchSignal":
- state = ComponentType.OCHSIGNAL;
- break;
- default:
- log.error("Cannot parse the component type {}.", clsName);
- log.info("The component content is {}.", component.toString());
- }
- state.adva = this;
- }
-
- /**
- * Component type.
- */
- enum ComponentType {
-
- /**
- * Direction.
- */
- DIRECTION() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- },
-
- /**
- * OchSignal.
- */
- OCHSIGNAL() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- };
-
-
- AdvaTerminalDevicePowerConfig adva;
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component component
- * @return target power
- */
- Optional<Double> getTargetPower(PortNumber port, Object component) {
- NetconfSession session = adva.getNetconfSession(adva.did());
- checkNotNull(session);
- String filter = parsePort(adva, port, null, null);
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<get-config>")
- .append("<source>")
- .append("<" + DatastoreId.RUNNING + "/>")
- .append("</source>")
- .append("<filter type='subtree'>")
- .append(filter)
- .append("</filter>")
- .append("</get-config>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = adva.executeRpc(session, rpcReq.toString());
- if (xconf == null) {
- log.error("Error in executingRpc");
- return Optional.empty();
- }
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/config");
- if (config == null || config.getString("target-output-power") == null) {
- return Optional.empty();
- }
- double power = Float.valueOf(config.getString("target-output-power")).doubleValue();
- return Optional.of(power);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component component
- * @param power target value
- */
- void setTargetPower(PortNumber port, Object component, double power) {
- NetconfSession session = adva.getNetconfSession(adva.did());
- checkNotNull(session);
- String editConfig = parsePort(adva, port, null, power);
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<edit-config>")
- .append("<target><" + DatastoreId.CANDIDATE + "/></target>")
- .append("<config>")
- .append(editConfig)
+ public StringBuilder parsePortRequestRpc(Double power, String name) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<component>");
+ if (power != null) {
+ // This is an edit-config operation.
+ rpc.append("<config>")
+ .append("<name>")
+ .append(name)
+ .append("</name>")
.append("</config>")
- .append("</edit-config>")
- .append(RPC_CLOSE_TAG);
- log.info("Setting power {}", rpcReq.toString());
- XMLConfiguration xconf = adva.executeRpc(session, rpcReq.toString());
- // The successful reply should be "<rpc-reply ...><ok /></rpc-reply>"
- if (!xconf.getRoot().getChild(0).getName().equals("ok")) {
- log.error("The <edit-config> operation to set target-output-power of Port({}:{}) is failed.",
- port.toString(), component.toString());
- }
- try {
- session.commit();
- } catch (NetconfException e) {
- log.error("error committing channel power", e);
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component the component.
- * @return current output power.
- */
- Optional<Double> currentPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- adva, port, "<output-power><instant/></output-power>");
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/state/output-power");
- if (config == null || config.getString("instant") == null) {
- return Optional.empty();
- }
- double currentPower = Float.valueOf(config.getString("instant")).doubleValue();
- return Optional.of(currentPower);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component the component
- * @return current input power
- */
- Optional<Double> currentInputPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- adva, port, "<input-power><instant/></input-power>");
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/state/input-power");
- if (config == null || config.getString("instant") == null) {
- return Optional.empty();
- }
- double currentPower = Float.valueOf(config.getString("instant")).doubleValue();
- return Optional.of(currentPower);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
- double targetMin = -30;
- double targetMax = 1;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
- double targetMin = -30;
- double targetMax = 1;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- List<PortNumber> getPorts(Object component) {
- // FIXME
- log.warn("Not Implemented Yet!");
- return new ArrayList<PortNumber>();
- }
-
- /**
- * Get filtered content under <optical-channel><state>.
- *
- * @param pc power config instance
- * @param port the port number
- * @param underState the filter condition
- * @return RPC reply
- */
- private static XMLConfiguration getOpticalChannelState(AdvaTerminalDevicePowerConfig pc,
- PortNumber port, String underState) {
- NetconfSession session = pc.getNetconfSession(pc.did());
- checkNotNull(session);
- String name = ocName(pc, port);
- StringBuilder rpcReq = new StringBuilder(RPC_TAG_NETCONF_BASE);
- rpcReq.append("<get><filter><components xmlns=\"http://openconfig.net/yang/platform\"><component>")
- .append("<name>").append(name).append("</name>")
.append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
- .append("<state>")
- .append(underState)
- .append("</state></optical-channel></component></components></filter></get>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = pc.executeRpc(session, rpcReq.toString());
- return xconf;
+ .append("<config>")
+ .append("<target-output-power>")
+ .append(power)
+ .append("</target-output-power>")
+ .append("</config>")
+ .append("</optical-channel>");
+ } else {
+ rpc.append("<name>")
+ .append(name)
+ .append("</name>");
}
-
-
- /**
- * Extract component name from portNumber's annotations.
- *
- * @param pc power config instance
- * @param portNumber the port number
- * @return the component name
- */
- private static String ocName(AdvaTerminalDevicePowerConfig pc, PortNumber portNumber) {
- DeviceService deviceService = DefaultServiceDirectory.getService(DeviceService.class);
- DeviceId deviceId = pc.handler().data().deviceId();
- return deviceService.getPort(deviceId, portNumber).annotations().value("oc-name");
- }
-
-
- /**
- * Parse filtering string from port and component.
- *
- * @param portNumber Port Number
- * @param component port component (optical-channel)
- * @param power power value set.
- * @return filtering string in xml format
- */
- private static String parsePort(AdvaTerminalDevicePowerConfig pc, PortNumber portNumber,
- Object component, Double power) {
- if (component == null) {
- String name = ocName(pc, portNumber);
- StringBuilder sb = new StringBuilder("<components xmlns=\"http://openconfig.net/yang/platform\">");
- sb.append("<component>");
- if (power != null) {
- // This is an edit-config operation.
- sb.append("<config>")
- .append("<name>")
- .append(name)
- .append("</name>")
- .append("</config>")
- .append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
- .append("<config>")
- .append("<target-output-power>")
- .append(power)
- .append("</target-output-power>")
- .append("</config>")
- .append("</optical-channel>");
- } else {
- sb.append("<name>")
- .append(name)
- .append("</name>");
- }
-
- sb.append("</component>").append("</components>");
- return sb.toString();
- } else {
- log.error("Cannot process the component {}.", component.getClass());
- return null;
- }
- }
+ return rpc;
}
}
diff --git a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/CassiniTerminalDevicePowerConfig.java b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/CassiniTerminalDevicePowerConfig.java
index f0f5d3a..aa0955e 100644
--- a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/CassiniTerminalDevicePowerConfig.java
+++ b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/CassiniTerminalDevicePowerConfig.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2018-present Open Networking Foundation
+ * Copyright 2019-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,437 +19,35 @@
package org.onosproject.drivers.odtn;
import com.google.common.collect.Range;
-import org.apache.commons.configuration.ConfigurationException;
-import org.apache.commons.configuration.HierarchicalConfiguration;
-import org.apache.commons.configuration.XMLConfiguration;
-import org.apache.commons.configuration.tree.xpath.XPathExpressionEngine;
-import org.onlab.osgi.DefaultServiceDirectory;
-import org.onosproject.drivers.utilities.XmlConfigParser;
-import org.onosproject.net.DeviceId;
+import org.onosproject.drivers.odtn.openconfig.TerminalDevicePowerConfig;
import org.onosproject.net.PortNumber;
import org.onosproject.net.behaviour.PowerConfig;
-import org.onosproject.net.device.DeviceService;
-import org.onosproject.net.driver.AbstractHandlerBehaviour;
-import org.onosproject.netconf.DatastoreId;
-import org.onosproject.netconf.NetconfController;
-import org.onosproject.netconf.NetconfDevice;
-import org.onosproject.netconf.NetconfException;
-import org.onosproject.netconf.NetconfSession;
-import org.slf4j.Logger;
-import java.io.StringWriter;
-import java.util.ArrayList;
-import java.util.List;
import java.util.Optional;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutionException;
-
-import static com.google.common.base.Preconditions.checkNotNull;
-import static org.slf4j.LoggerFactory.getLogger;
/**
* Driver Implementation of the PowerConfig for OpenConfig terminal devices.
*/
public class CassiniTerminalDevicePowerConfig<T>
- extends AbstractHandlerBehaviour implements PowerConfig<T> {
-
- private static final String RPC_TAG_NETCONF_BASE =
- "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
-
- private static final String RPC_CLOSE_TAG = "</rpc>";
-
- private static final Logger log = getLogger(CassiniTerminalDevicePowerConfig.class);
-
- private ComponentType state = ComponentType.DIRECTION;
-
+ extends TerminalDevicePowerConfig<T> implements PowerConfig<T> {
/**
- * Returns the NetconfSession with the device for which the method was called.
- *
- * @param deviceId device indetifier
- * @return The netconf session or null
- */
- private NetconfSession getNetconfSession(DeviceId deviceId) {
- NetconfController controller = handler().get(NetconfController.class);
- NetconfDevice ncdev = controller.getDevicesMap().get(deviceId);
- if (ncdev == null) {
- log.trace("No netconf device, returning null session");
- return null;
- }
- return ncdev.getSession();
- }
-
- /**
- * Get the deviceId for which the methods apply.
- *
- * @return The deviceId as contained in the handler data
- */
- private DeviceId did() {
- return handler().data().deviceId();
- }
-
- /**
- * Execute RPC request.
- *
- * @param session Netconf session
- * @param message Netconf message in XML format
- * @return XMLConfiguration object
- */
-
- private XMLConfiguration executeRpc(NetconfSession session, String message) {
- try {
- if (log.isDebugEnabled()) {
- try {
- StringWriter stringWriter = new StringWriter();
- XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(message);
- xconf.setExpressionEngine(new XPathExpressionEngine());
- xconf.save(stringWriter);
- log.debug("Request {}", stringWriter.toString());
- } catch (ConfigurationException e) {
- log.error("XML Config Exception ", e);
- }
- }
- CompletableFuture<String> fut = session.rpc(message);
- String rpcReply = fut.get();
- XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(rpcReply);
- xconf.setExpressionEngine(new XPathExpressionEngine());
- if (log.isDebugEnabled()) {
- try {
- StringWriter stringWriter = new StringWriter();
- xconf.save(stringWriter);
- log.debug("Response {}", stringWriter.toString());
- } catch (ConfigurationException e) {
- log.error("XML Config Exception ", e);
- }
- }
- return xconf;
- } catch (NetconfException ne) {
- log.error("Exception on Netconf protocol: {}.", ne);
- } catch (InterruptedException ie) {
- log.error("Interrupted Exception: {}.", ie);
- } catch (ExecutionException ee) {
- log.error("Concurrent Exception while executing Netconf operation: {}.", ee);
- }
- return null;
- }
-
- /**
- * Get the target-output-power value on specific optical-channel.
- *
- * @param port the port
- * @param component the port component. It should be 'oc-name' in the Annotations of Port.
- * 'oc-name' could be mapped to '/component/name' in openconfig yang.
- * @return target power value
+ * Getting target value of output power.
+ * @param port port
+ * @param component the component
+ * @return target output power range
*/
@Override
- public Optional<Double> getTargetPower(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPower(port, component);
+ public Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
+ double targetMin = -30;
+ double targetMax = 1;
+ return Optional.of(Range.open(targetMin, targetMax));
}
@Override
- public void setTargetPower(PortNumber port, T component, double power) {
- checkState(component);
- state.setTargetPower(port, component, power);
+ public Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
+ double targetMin = -30;
+ double targetMax = 1;
+ return Optional.of(Range.open(targetMin, targetMax));
}
- @Override
- public Optional<Double> currentPower(PortNumber port, T component) {
- checkState(component);
- return state.currentPower(port, component);
- }
-
- @Override
- public Optional<Double> currentInputPower(PortNumber port, T component) {
- checkState(component);
- return state.currentInputPower(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getTargetPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPowerRange(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getInputPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getInputPowerRange(port, component);
- }
-
- @Override
- public List<PortNumber> getPorts(T component) {
- checkState(component);
- return state.getPorts(component);
- }
-
-
- /**
- * Set the ComponentType to invoke proper methods for different template T.
- *
- * @param component the component.
- */
- void checkState(Object component) {
- String clsName = component.getClass().getName();
- switch (clsName) {
- case "org.onosproject.net.Direction":
- state = ComponentType.DIRECTION;
- break;
- case "org.onosproject.net.OchSignal":
- state = ComponentType.OCHSIGNAL;
- break;
- default:
- log.error("Cannot parse the component type {}.", clsName);
- log.info("The component content is {}.", component.toString());
- }
- state.cassini = this;
- }
-
- /**
- * Component type.
- */
- enum ComponentType {
-
- /**
- * Direction.
- */
- DIRECTION() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- },
-
- /**
- * OchSignal.
- */
- OCHSIGNAL() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- };
-
-
- CassiniTerminalDevicePowerConfig cassini;
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component component
- * @return target power
- */
- Optional<Double> getTargetPower(PortNumber port, Object component) {
- NetconfSession session = cassini.getNetconfSession(cassini.did());
- checkNotNull(session);
- String filter = parsePort(cassini, port, null, null);
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<get-config>")
- .append("<source>")
- .append("<" + DatastoreId.RUNNING + "/>")
- .append("</source>")
- .append("<filter type='subtree'>")
- .append(filter)
- .append("</filter>")
- .append("</get-config>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = cassini.executeRpc(session, rpcReq.toString());
- if (xconf == null) {
- log.error("Error in executingRpc");
- return Optional.empty();
- }
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/config");
- if (config == null || config.getString("target-output-power") == null) {
- return Optional.empty();
- }
- double power = Float.valueOf(config.getString("target-output-power")).doubleValue();
- return Optional.of(power);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component component
- * @param power target value
- */
- void setTargetPower(PortNumber port, Object component, double power) {
- NetconfSession session = cassini.getNetconfSession(cassini.did());
- checkNotNull(session);
- String editConfig = parsePort(cassini, port, null, power);
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<edit-config>")
- .append("<target><" + DatastoreId.CANDIDATE + "/></target>")
- .append("<config>")
- .append(editConfig)
- .append("</config>")
- .append("</edit-config>")
- .append(RPC_CLOSE_TAG);
- log.info("Setting power {}", rpcReq.toString());
- XMLConfiguration xconf = cassini.executeRpc(session, rpcReq.toString());
- // The successful reply should be "<rpc-reply ...><ok /></rpc-reply>"
- if (!xconf.getRoot().getChild(0).getName().equals("ok")) {
- log.error("The <edit-config> operation to set target-output-power of Port({}:{}) is failed.",
- port.toString(), component.toString());
- }
- try {
- session.commit();
- } catch (NetconfException e) {
- log.error("error committing channel power", e);
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component the component.
- * @return current output power.
- */
- Optional<Double> currentPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- cassini, port, "<output-power><instant/></output-power>");
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/state/output-power");
- if (config == null || config.getString("instant") == null) {
- return Optional.empty();
- }
- double currentPower = Float.valueOf(config.getString("instant")).doubleValue();
- return Optional.of(currentPower);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- *
- * @param port port
- * @param component the component
- * @return current input power
- */
- Optional<Double> currentInputPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- cassini, port, "<input-power><instant/></input-power>");
- try {
- HierarchicalConfiguration config =
- xconf.configurationAt("data/components/component/optical-channel/state/input-power");
- if (config == null || config.getString("instant") == null) {
- return Optional.empty();
- }
- double currentPower = Float.valueOf(config.getString("instant")).doubleValue();
- return Optional.of(currentPower);
- } catch (IllegalArgumentException e) {
- return Optional.empty();
- }
- }
-
- Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
- double targetMin = -30;
- double targetMax = 1;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
- double targetMin = -30;
- double targetMax = 1;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- List<PortNumber> getPorts(Object component) {
- // FIXME
- log.warn("Not Implemented Yet!");
- return new ArrayList<PortNumber>();
- }
-
- /**
- * Get filtered content under <optical-channel><state>.
- *
- * @param pc power config instance
- * @param port the port number
- * @param underState the filter condition
- * @return RPC reply
- */
- private static XMLConfiguration getOpticalChannelState(CassiniTerminalDevicePowerConfig pc,
- PortNumber port, String underState) {
- NetconfSession session = pc.getNetconfSession(pc.did());
- checkNotNull(session);
- String name = ocName(pc, port);
- StringBuilder rpcReq = new StringBuilder(RPC_TAG_NETCONF_BASE);
- rpcReq.append("<get><filter><components xmlns=\"http://openconfig.net/yang/platform\"><component>")
- .append("<name>").append(name).append("</name>")
- .append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
- .append("<state>")
- .append(underState)
- .append("</state></optical-channel></component></components></filter></get>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = pc.executeRpc(session, rpcReq.toString());
- return xconf;
- }
-
-
- /**
- * Extract component name from portNumber's annotations.
- *
- * @param pc power config instance
- * @param portNumber the port number
- * @return the component name
- */
- private static String ocName(CassiniTerminalDevicePowerConfig pc, PortNumber portNumber) {
- DeviceService deviceService = DefaultServiceDirectory.getService(DeviceService.class);
- DeviceId deviceId = pc.handler().data().deviceId();
- return deviceService.getPort(deviceId, portNumber).annotations().value("oc-name");
- }
-
-
- /**
- * Parse filtering string from port and component.
- *
- * @param portNumber Port Number
- * @param component port component (optical-channel)
- * @param power power value set.
- * @return filtering string in xml format
- */
- private static String parsePort(CassiniTerminalDevicePowerConfig pc, PortNumber portNumber,
- Object component, Double power) {
- if (component == null) {
- String name = ocName(pc, portNumber);
- StringBuilder sb = new StringBuilder("<components xmlns=\"http://openconfig.net/yang/platform\">");
- sb.append("<component>").append("<name>").append(name).append("</name>");
- if (power != null) {
- // This is an edit-config operation.
- sb.append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
- .append("<config>")
- .append("<target-output-power>")
- .append(power)
- .append("</target-output-power>")
- .append("</config>")
- .append("</optical-channel>");
- }
- sb.append("</component>").append("</components>");
- return sb.toString();
- } else {
- log.error("Cannot process the component {}.", component.getClass());
- return null;
- }
- }
- }
-}
+}
\ No newline at end of file
diff --git a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/NokiaTerminalDevicePowerConfig.java b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/NokiaTerminalDevicePowerConfig.java
index 9893fdb..a237e81 100644
--- a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/NokiaTerminalDevicePowerConfig.java
+++ b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/NokiaTerminalDevicePowerConfig.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2018-present Open Networking Foundation
+ * Copyright 2019-present Open Networking Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,25 +19,20 @@
package org.onosproject.drivers.odtn;
import com.google.common.collect.Range;
-import org.apache.commons.configuration.XMLConfiguration;
-import org.onlab.osgi.DefaultServiceDirectory;
-import org.onosproject.drivers.utilities.XmlConfigParser;
+import org.onosproject.drivers.odtn.openconfig.TerminalDevicePowerConfig;
import org.onosproject.net.DeviceId;
import org.onosproject.net.PortNumber;
-import org.onosproject.net.behaviour.PowerConfig;
-import org.onosproject.net.device.DeviceService;
-import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.netconf.DatastoreId;
import org.onosproject.netconf.NetconfController;
import org.onosproject.netconf.NetconfDevice;
import org.onosproject.netconf.NetconfException;
import org.onosproject.netconf.NetconfSession;
import org.slf4j.Logger;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
import java.util.Optional;
-import static com.google.common.base.Preconditions.checkNotNull;
import static org.slf4j.LoggerFactory.getLogger;
/**
@@ -47,24 +42,16 @@
*
*/
public class NokiaTerminalDevicePowerConfig<T>
- extends AbstractHandlerBehaviour implements PowerConfig<T> {
-
- private static final String RPC_TAG_NETCONF_BASE =
- "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
-
- private static final String RPC_CLOSE_TAG = "</rpc>";
+ extends TerminalDevicePowerConfig<T> {
private static final String OPTICAL_CHANNEL = "OCH";
private static final Logger log = getLogger(NokiaTerminalDevicePowerConfig.class);
- private ComponentType state = ComponentType.DIRECTION;
-
//The username and password are different from the username and password in the netconf-cfg file
private static final String USER_NAME = "admin";
private static final String PASSWORD = "admin";
-
/**
* Login to the device by providing the correct user and password in order to configure the device
* Returns the NetconfSession with the device for which the method was called.
@@ -74,7 +61,10 @@
* @param passwd password to access the device
* @return The netconf session or null
*/
- private NetconfSession getNetconfSessionAndLogin(DeviceId deviceId, String userName, String passwd) {
+ @Override
+ public NetconfSession getNetconfSession(DeviceId deviceId, String userName, String passwd) {
+ userName = USER_NAME;
+ passwd = PASSWORD;
NetconfController nc = handler().get(NetconfController.class);
NetconfDevice ndev = nc.getDevicesMap().get(deviceId);
if (ndev == null) {
@@ -136,391 +126,133 @@
}
/**
- * Get the deviceId for which the methods apply.
*
- * @return The deviceId as contained in the handler data
+ * @param param the config parameter.
+ * @return array of string
*/
- private DeviceId did() {
- return handler().data().deviceId();
+ @Override
+ public Map<String, String> buildRpcString(String param) {
+ Map<String, String> rpcMap = new HashMap<String, String>();
+ switch (param) {
+ case TARGET_POWER:
+ rpcMap.put("TARGET_OUTPUT_PATH", "components/component/oc-opt-term:optical-channel/oc-opt-term:config");
+ rpcMap.put("TARGET_OUTPUT_LEAF", "oc-opt-term:target-output-power");
+ case CURRENT_POWER:
+ rpcMap.put("CURRENT_POWER_PATH", "components.component." +
+ "oc-opt-term:optical-channel." +
+ "oc-opt-term:state." +
+ "oc-opt-term:output-power");
+ rpcMap.put("CURRENT_POWER_ROUTE", "<oc-opt-term:output-power>" +
+ "<oc-opt-term:instant/>" +
+ "</oc-opt-term:output-power>");
+ rpcMap.put("CURRENT_POWER_LEAF", "oc-opt-term:instant");
+ default:
+ rpcMap.put("CURRENT_INPUT_POWER_PATH", "components.component." +
+ "oc-opt-term:optical-channel." +
+ "oc-opt-term:state." +
+ "oc-opt-term:input-power");
+ rpcMap.put("CURRENT_INPUT_POWER_ROUTE", "<oc-opt-term:input-power>" +
+ "<oc-opt-term:instant/>" +
+ "</oc-opt-term:input-power>");
+ rpcMap.put("CURRENT_INPUT_POWER_LEAF", "oc-opt-term:instant");
+ }
+ return rpcMap;
}
/**
- * Execute RPC request.
- * @param session Netconf session
- * @param message Netconf message in XML format
- * @return XMLConfiguration object
+ * Construct a rpc target power message.
+ *
+ * @param filter to build rpc
+ * @return RPC payload
*/
+ @Override
+ public StringBuilder getTargetPowerRequestRpc(String filter) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<get>")
+ .append("<filter type='subtree'>")
+ .append(filter)
+ .append("</filter>")
+ .append("</get>");
+ return rpc;
+ }
- //TODO: rewrite with requestSync operation..
- private XMLConfiguration executeRpcReq(NetconfSession session, String message) {
- try {
- String reply = session.requestSync(message);
- String data = getDataOfRpcReply(reply);
- log.debug("\n\n [executeRpcReq] RPC request returned this: \n {} \n\n", data);
- XMLConfiguration cfg = (XMLConfiguration) XmlConfigParser.loadXmlString(getDataOfRpcReply(reply));
- return cfg;
- } catch (NetconfException ne) {
- log.error("Exception on NetConf protocol: {}.", ne);
- } catch (Exception e) {
- log.debug("Error loading data to internal XML Configuration format: \n {}", e);
+ /**
+ * Construct a rpc target power message.
+ *
+ * @return RPC payload
+ */
+ @Override
+ public DatastoreId getDataStoreId() {
+ return DatastoreId.RUNNING;
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @param name
+ * @param underState to build rpc for setting configuration
+ * @return RPC payload
+ */
+ @Override
+ public StringBuilder getOpticalChannelStateRequestRpc(String name, String underState) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<name>").append(name).append("</name>")
+ .append("<oc-opt-term:optical-channel " +
+ "xmlns:oc-opt-term=\"http://openconfig.net/yang/terminal-device\">")
+ .append("<oc-opt-term:state>")
+ .append(underState)
+ .append("</oc-opt-term:state>")
+ .append("</oc-opt-term:optical-channel>")
+ .append("</component></components></filter></get>");
+ return rpc;
+ }
+
+ /**
+ * Getting target value of output power.
+ * @param port port
+ * @param component the component
+ * @return target output power range
+ */
+ @Override
+ public Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
+ double targetMin = -20;
+ double targetMax = 5;
+ return Optional.of(Range.open(targetMin, targetMax));
+ }
+
+ @Override
+ public Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
+ double targetMin = -20;
+ double targetMax = 5;
+ return Optional.of(Range.open(targetMin, targetMax));
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @param name for optical channel name
+ * @param power to build rpc for setting configuration
+ * @return RPC payload
+ */
+ @Override
+ public StringBuilder parsePortRequestRpc(Double power, String name) {
+ if (name != null) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<component>").append("<name>").append(name).append("</name>");
+ if (power != null) {
+ // This is an edit-config operation.
+ rpc.append("<oc-opt-term:optical-channel " +
+ "xmlns:oc-opt-term=\"http://openconfig.net/yang/terminal-device\">")
+ .append("<oc-opt-term:config>")
+ .append("<oc-opt-term:target-output-power>")
+ .append(power)
+ .append("</oc-opt-term:target-output-power>")
+ .append("</oc-opt-term:config>")
+ .append("</oc-opt-term:optical-channel>");
+ }
+ return rpc;
}
return null;
}
- /**
- * Get the target-output-power value on specific optical-channel.
- * @param port the port
- * @param component the port component. It should be 'oc-name' in the Annotations of Port.
- * 'oc-name' could be mapped to '/component/name' in openconfig yang.
- * @return target power value
- */
- @Override
- public Optional<Double> getTargetPower(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, T component, double power) {
- checkState(component);
- state.setTargetPower(port, component, power);
- }
-
- @Override
- public Optional<Double> currentPower(PortNumber port, T component) {
- checkState(component);
- return state.currentPower(port, component);
- }
-
- @Override
- public Optional<Double> currentInputPower(PortNumber port, T component) {
- checkState(component);
- return state.currentInputPower(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getTargetPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getTargetPowerRange(port, component);
- }
-
- @Override
- public Optional<Range<Double>> getInputPowerRange(PortNumber port, T component) {
- checkState(component);
- return state.getInputPowerRange(port, component);
- }
-
- @Override
- public List<PortNumber> getPorts(T component) {
- checkState(component);
- return state.getPorts(component);
- }
-
-
- /**
- * Set the ComponentType to invoke proper methods for different template T.
- * @param component the component.
- */
- void checkState(Object component) {
- String clsName = component.getClass().getName();
- switch (clsName) {
- case "org.onosproject.net.Direction":
- state = ComponentType.DIRECTION;
- break;
- case "org.onosproject.net.OchSignal":
- state = ComponentType.OCHSIGNAL;
- break;
- default:
- log.error("Cannot parse the component type {}.", clsName);
- log.info("The component content is {}.", component.toString());
- }
- state.nokia = this;
- }
-
- /**
- * Component type.
- */
- enum ComponentType {
-
- /**
- * Direction.
- */
- DIRECTION() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- },
-
- /**
- * OchSignal.
- */
- OCHSIGNAL() {
- @Override
- public Optional<Double> getTargetPower(PortNumber port, Object component) {
- return super.getTargetPower(port, component);
- }
-
- @Override
- public void setTargetPower(PortNumber port, Object component, double power) {
- super.setTargetPower(port, component, power);
- }
- };
-
-
-
- NokiaTerminalDevicePowerConfig nokia;
-
- /**
- * mirror method in the internal class.
- * @param port port
- * @param component component
- * @return target power
- */
- //TODO: Overlap with getTargetPowerRange function..
- Optional<Double> getTargetPower(PortNumber port, Object component) {
- NetconfSession session = nokia.getNetconfSessionAndLogin(nokia.did(), USER_NAME, PASSWORD);
- checkNotNull(session);
- String filter = parsePort(nokia, port, null, null);
- if (filter != null) {
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<get>")
- .append("<filter type='subtree'>")
- .append(filter)
- .append("</filter>")
- .append("</get>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = nokia.executeRpcReq(session, rpcReq.toString());
- log.debug("\n\n [getTargetPower] Obtained information " +
- "from getTargetPower function is.. \n {} \n\n", xconf);
- try {
- String tpower = xconf.getString("components.component." +
- "oc-opt-term:optical-channel." +
- "oc-opt-term:config." +
- "oc-opt-term:target-output-power");
- double power = Float.valueOf(tpower).doubleValue();
- log.debug("\n\n [getTargetPower] Target OUTPUT power is.. {} \n\n", power);
- return Optional.of(power);
- } catch (IllegalArgumentException e) {
- log.debug("\n\n [getTargetPower] Something went wrong " +
- "during the parsing of configuration in getTargetPower function.. \n\n");
- return Optional.empty();
- }
- } else {
- log.debug("Port you're trying to get ({}) is not optical", port.toString());
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- * @param port port
- * @param component component
- * @param power target value
- */
- void setTargetPower(PortNumber port, Object component, double power) {
- NetconfSession session = nokia.getNetconfSessionAndLogin(nokia.did(), USER_NAME, PASSWORD);
- checkNotNull(session);
- String editConfig = parsePort(nokia, port, null, power);
- if (editConfig != null) {
- StringBuilder rpcReq = new StringBuilder();
- rpcReq.append(RPC_TAG_NETCONF_BASE)
- .append("<edit-config>")
- .append("<target><running/></target>")
- .append("<config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">")
- .append(editConfig)
- .append("</config>")
- .append("</edit-config>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = nokia.executeRpcReq(session, rpcReq.toString());
- log.debug("\n\n [setTargetPower] Obtained information is.. \n {} \n\n", xconf);
- // The successful reply should be "<rpc-reply ...><ok /></rpc-reply>"
- if (!xconf.getRoot().getChild(0).getName().equals("ok")) {
- log.error("[setTargetPower] The <edit-config> operation " +
- "to set target-output-power of Port({}:{}) is failed.",
- port.toString(), component.toString());
- } else {
- log.debug("[setTargetPower] Answer on <edit-config> request " +
- "is following: \n {}\n", xconf.toString());
- }
- } else {
- log.debug("[setTargetPower] Port you're trying " +
- "to set ({}) is not optical", port.toString());
- }
- }
-
- /**
- * mirror method in the internal class.
- * @param port port
- * @param component the component.
- * @return current output power.
- */
- Optional<Double> currentPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- nokia, port, "<oc-opt-term:output-power>" +
- "<oc-opt-term:instant/>" +
- "</oc-opt-term:output-power>");
- try {
- String oipower = xconf.getString("components.component." +
- "oc-opt-term:optical-channel." +
- "oc-opt-term:state." +
- "oc-opt-term:output-power." +
- "oc-opt-term:instant");
- log.debug("\n\n [currentPower] That's what we read: \n {} \n\n", oipower);
- double currentPower = Float.valueOf(oipower).doubleValue();
- return Optional.of(currentPower);
- } catch (Exception e) {
- log.debug("\n\n [currentPower] Something went wrong " +
- "during the parsing of obtained answer.. \n\n");
- return Optional.empty();
- }
- }
-
- /**
- * mirror method in the internal class.
- * @param port port
- * @param component the component
- * @return current input power
- */
- Optional<Double> currentInputPower(PortNumber port, Object component) {
- XMLConfiguration xconf = getOpticalChannelState(
- nokia, port, "<oc-opt-term:input-power>" +
- "<oc-opt-term:instant/>" +
- "</oc-opt-term:input-power>");
- try {
- String iipower = xconf.getString("components.component." +
- "oc-opt-term:optical-channel." +
- "oc-opt-term:state." +
- "oc-opt-term:input-power." +
- "oc-opt-term:instant");
- log.debug("\n\n [currentInputPower] That's what we read: \n {} \n\n", iipower);
- double currentPower = Float.valueOf(iipower).doubleValue();
-
- return Optional.of(currentPower);
- } catch (Exception e) {
- log.debug("\n\n [currentInputPower] Something went wrong " +
- "during the parsing of obtained answer.. \n\n");
- return Optional.empty();
- }
- }
-
- /**
- * Getting target value of output power.
- * @param port port
- * @param component the component
- * @return target output power range
- */
-
- Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
- double targetMin = -20;
- double targetMax = 5;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
- double targetMin = -20;
- double targetMax = 5;
- return Optional.of(Range.open(targetMin, targetMax));
- }
-
- List<PortNumber> getPorts(Object component) {
- // FIXME
- log.warn("[getPorts] Not Implemented Yet!");
- return new ArrayList<PortNumber>();
- }
-
- /**
- * Get filtered content under <optical-channel><state>.
- * @param pc power config instance
- * @param port the port number
- * @param underState the filter condition
- * @return RPC reply
- */
- private static XMLConfiguration getOpticalChannelState(NokiaTerminalDevicePowerConfig pc,
- PortNumber port, String underState) {
- NetconfSession session = pc.getNetconfSessionAndLogin(pc.did(), USER_NAME, PASSWORD);
- checkNotNull(session);
- String name = ocName(pc, port);
- StringBuilder rpcReq = new StringBuilder(RPC_TAG_NETCONF_BASE);
- rpcReq.append("<get><filter><components xmlns=\"http://openconfig.net/yang/platform\"><component>")
- .append("<name>").append(name).append("</name>")
- .append("<oc-opt-term:optical-channel " +
- "xmlns:oc-opt-term=\"http://openconfig.net/yang/terminal-device\">")
- .append("<oc-opt-term:state>")
- .append(underState)
- .append("</oc-opt-term:state>")
- .append("</oc-opt-term:optical-channel>")
- .append("</component></components></filter></get>")
- .append(RPC_CLOSE_TAG);
- XMLConfiguration xconf = pc.executeRpcReq(session, rpcReq.toString());
- return xconf;
- }
-
- /**
- * Extract component name from portNumber's annotations.
- * @param pc power config instance
- * @param portNumber the port number
- * @return the component name
- */
- private static String ocName(NokiaTerminalDevicePowerConfig pc, PortNumber portNumber) {
- DeviceService deviceService = DefaultServiceDirectory.getService(DeviceService.class);
- DeviceId deviceId = pc.handler().data().deviceId();
- String port = deviceService.getPort(deviceId, portNumber).annotations().value("oc-name");
-
- // Applying some magic to return the correct port with the correct name
- String portType = deviceService.getPort(deviceId, portNumber).type().toString();
- log.debug("\n\n [ocName] Type of the port taken from ONOS storage " +
- "has following properties.. \n {} \n", portType);
- if (portType.equals(OPTICAL_CHANNEL)) {
- String[] textStr = port.split("-");
- String och = "OCH-" + textStr[1] + "-" + textStr[2] + "-" + textStr[3];
- log.debug("\n\n [ocName] Optical channel returned is.. {} \n\n", och);
- return och;
- } else {
- log.debug("[ocName] This port is not an optical one");
- return null;
- }
- }
-
- /**
- * Parse filtering string from port and component.
- * @param portNumber Port Number
- * @param component port component (optical-channel)
- * @param power power value set.
- * @return filtering string in xml format
- */
- private static String parsePort(NokiaTerminalDevicePowerConfig pc, PortNumber portNumber,
- Object component, Double power) {
- if (component == null) {
- String name = ocName(pc, portNumber);
- if (name != null) {
- StringBuilder sb = new StringBuilder("<components " +
- "xmlns=\"http://openconfig.net/yang/platform\">");
- sb.append("<component>").append("<name>").append(name).append("</name>");
- if (power != null) {
- // This is an edit-config operation.
- sb.append("<oc-opt-term:optical-channel " +
- "xmlns:oc-opt-term=\"http://openconfig.net/yang/terminal-device\">")
- .append("<oc-opt-term:config>")
- .append("<oc-opt-term:target-output-power>")
- .append(power)
- .append("</oc-opt-term:target-output-power>")
- .append("</oc-opt-term:config>")
- .append("</oc-opt-term:optical-channel>");
- }
- sb.append("</component>").append("</components>");
- return sb.toString();
- }
- } else {
- log.error("[parsePort] Cannot process the component {}.", component.getClass());
- return null;
- }
- return null;
- }
- }
}
diff --git a/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/openconfig/TerminalDevicePowerConfig.java b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/openconfig/TerminalDevicePowerConfig.java
new file mode 100644
index 0000000..5715a4b
--- /dev/null
+++ b/drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/openconfig/TerminalDevicePowerConfig.java
@@ -0,0 +1,559 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This work was partially supported by EC H2020 project METRO-HAUL (761727).
+ */
+
+package org.onosproject.drivers.odtn.openconfig;
+
+import com.google.common.collect.Range;
+import org.apache.commons.configuration.ConfigurationException;
+import org.apache.commons.configuration.HierarchicalConfiguration;
+import org.apache.commons.configuration.XMLConfiguration;
+import org.apache.commons.configuration.tree.xpath.XPathExpressionEngine;
+import org.onlab.osgi.DefaultServiceDirectory;
+import org.onosproject.drivers.utilities.XmlConfigParser;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.behaviour.PowerConfig;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.netconf.DatastoreId;
+import org.onosproject.netconf.NetconfController;
+import org.onosproject.netconf.NetconfDevice;
+import org.onosproject.netconf.NetconfException;
+import org.onosproject.netconf.NetconfSession;
+import org.slf4j.Logger;
+
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.slf4j.LoggerFactory.getLogger;
+
+public class TerminalDevicePowerConfig<T> extends AbstractHandlerBehaviour implements PowerConfig<T> {
+
+ public static final String RPC_TAG_NETCONF_BASE =
+ "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
+
+ public static final String RPC_CLOSE_TAG = "</rpc>";
+
+ public static final String TARGET_POWER = "TargetPower";
+
+ public static final String CURRENT_POWER = "CurrentPower";
+
+ public static final String CURRENT_INPUT_POWER = "CurrentInputPower";
+
+ public static final Logger log = getLogger(TerminalDevicePowerConfig.class);
+
+ public ComponentType state = ComponentType.DIRECTION;
+
+ /**
+ * Returns the NetconfSession with the device for which the method was called.
+ *
+ * @param deviceId device indetifier
+ * @param userName username to access the device
+ * @param passwd password to access the device
+ * @return The netconf session or null
+ */
+ public NetconfSession getNetconfSession(DeviceId deviceId, String userName, String passwd) {
+ NetconfController controller = handler().get(NetconfController.class);
+ NetconfDevice ncdev = controller.getDevicesMap().get(deviceId);
+ if (ncdev == null) {
+ log.trace("No netconf device, returning null session");
+ return null;
+ }
+ return ncdev.getSession();
+ }
+
+ /**
+ * Get the deviceId for which the methods apply.
+ *
+ * @return The deviceId as contained in the handler data
+ */
+ public DeviceId did() {
+ return handler().data().deviceId();
+ }
+
+ /**
+ * Execute RPC request.
+ *
+ * @param session Netconf session
+ * @param message Netconf message in XML format
+ * @return XMLConfiguration object
+ */
+
+ public XMLConfiguration executeRpc(NetconfSession session, String message) {
+ try {
+ if (log.isDebugEnabled()) {
+ try {
+ StringWriter stringWriter = new StringWriter();
+ XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(message);
+ xconf.setExpressionEngine(new XPathExpressionEngine());
+ xconf.save(stringWriter);
+ log.debug("Request {}", stringWriter.toString());
+ } catch (ConfigurationException e) {
+ log.error("XML Config Exception ", e);
+ }
+ }
+ CompletableFuture<String> fut = session.rpc(message);
+ String rpcReply = fut.get();
+ XMLConfiguration xconf = (XMLConfiguration) XmlConfigParser.loadXmlString(rpcReply);
+ xconf.setExpressionEngine(new XPathExpressionEngine());
+ if (log.isDebugEnabled()) {
+ try {
+ StringWriter stringWriter = new StringWriter();
+ xconf.save(stringWriter);
+ log.debug("Response {}", stringWriter.toString());
+ } catch (ConfigurationException e) {
+ log.error("XML Config Exception ", e);
+ }
+ }
+ return xconf;
+ } catch (NetconfException ne) {
+ log.error("Exception on Netconf protocol: {}.", ne);
+ } catch (InterruptedException ie) {
+ log.error("Interrupted Exception: {}.", ie);
+ } catch (ExecutionException ee) {
+ log.error("Concurrent Exception while executing Netconf operation: {}.", ee);
+ }
+ return null;
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @param filter to build rpc
+ * @return RPC payload
+ */
+ public StringBuilder getTargetPowerRequestRpc(String filter) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<get-config>")
+ .append("<source>")
+ .append("<" + DatastoreId.RUNNING + "/>")
+ .append("</source>")
+ .append("<filter type='subtree'>")
+ .append(filter)
+ .append("</filter>")
+ .append("</get-config>");
+ return rpc;
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @return RPC payload
+ */
+ public DatastoreId getDataStoreId() {
+ return DatastoreId.CANDIDATE;
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @param name for optical channel name
+ * @param underState to build rpc for setting configuration
+ * @return RPC payload
+ */
+ public StringBuilder getOpticalChannelStateRequestRpc(String name, String underState) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<name>").append(name).append("</name>")
+ .append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
+ .append("<state>")
+ .append(underState)
+ .append("</state></optical-channel></component></components></filter></get>");
+ return rpc;
+ }
+
+ /**
+ * Construct a rpc target power message.
+ *
+ * @param name for optical channel name
+ * @param power to build rpc for setting configuration
+ * @return RPC payload
+ */
+ public StringBuilder parsePortRequestRpc(Double power, String name) {
+ StringBuilder rpc = new StringBuilder();
+ rpc.append("<component>").append("<name>").append(name).append("</name>").
+ append("<optical-channel xmlns=\"http://openconfig.net/yang/terminal-device\">")
+ .append("<config>")
+ .append("<target-output-power>")
+ .append(power)
+ .append("</target-output-power>")
+ .append("</config>")
+ .append("</optical-channel>");
+ return rpc;
+ }
+ /**
+ * Get the target-output-power value on specific optical-channel.
+ *
+ * @param port the port
+ * @param component the port component. It should be 'oc-name' in the Annotations of Port.
+ * 'oc-name' could be mapped to '/component/name' in openconfig yang.
+ * @return target power value
+ */
+ @Override
+ public Optional<Double> getTargetPower(PortNumber port, T component) {
+ checkState(component);
+ return state.getTargetPower(port, component);
+ }
+
+ @Override
+ public void setTargetPower(PortNumber port, T component, double power) {
+ checkState(component);
+ state.setTargetPower(port, component, power);
+ }
+
+ @Override
+ public Optional<Double> currentPower(PortNumber port, T component) {
+ checkState(component);
+ return state.currentPower(port, component);
+ }
+
+ @Override
+ public Optional<Double> currentInputPower(PortNumber port, T component) {
+ checkState(component);
+ return state.currentInputPower(port, component);
+ }
+
+ @Override
+ public Optional<Range<Double>> getTargetPowerRange(PortNumber port, T component) {
+ checkState(component);
+ return state.getTargetPowerRange(port, component);
+ }
+
+ @Override
+ public Optional<Range<Double>> getInputPowerRange(PortNumber port, T component) {
+ checkState(component);
+ return state.getInputPowerRange(port, component);
+ }
+
+ @Override
+ public List<PortNumber> getPorts(T component) {
+ checkState(component);
+ return state.getPorts(component);
+ }
+
+
+ /**
+ * Set the ComponentType to invoke proper methods for different template T.
+ *
+ * @param component the component.
+ */
+ public void checkState(Object component) {
+ String clsName = component.getClass().getName();
+ switch (clsName) {
+ case "org.onosproject.net.Direction":
+ state = TerminalDevicePowerConfig.ComponentType.DIRECTION;
+ break;
+ case "org.onosproject.net.OchSignal":
+ state = TerminalDevicePowerConfig.ComponentType.OCHSIGNAL;
+ break;
+ default:
+ log.error("Cannot parse the component type {}.", clsName);
+ log.info("The component content is {}.", component.toString());
+ }
+ state.driver = this;
+ }
+ /**
+ *
+ * @param param the config parameter.
+ * @return array of string
+ */
+ public Map<String, String> buildRpcString(String param) {
+ Map<String, String> rpcMap = new HashMap<String, String>();
+ switch (param) {
+ case TARGET_POWER:
+ rpcMap.put("TARGET_OUTPUT_PATH", "data/components/component/optical-channel/config");
+ rpcMap.put("TARGET_OUTPUT_LEAF", "target-output-power");
+ case CURRENT_POWER:
+ rpcMap.put("CURRENT_POWER_PATH", "data/components/component/optical-channel/state/output-power");
+ rpcMap.put("CURRENT_POWER_ROUTE", "<output-power><instant/></output-power>");
+ rpcMap.put("CURRENT_POWER_LEAF", "instant");
+ default:
+ rpcMap.put("CURRENT_INPUT_POWER_PATH", "data/components/component/optical-channel/state/input-power");
+ rpcMap.put("CURRENT_INPUT_POWER_ROUTE", "<input-power><instant/></input-power>");
+ rpcMap.put("CURRENT_INPUT_POWER_LEAF", "instant");
+ }
+ return rpcMap;
+ }
+
+ /**
+ * Component type.
+ */
+ public enum ComponentType {
+
+ /**
+ * Direction.
+ */
+ DIRECTION() {
+ @Override
+ public Optional<Double> getTargetPower(PortNumber port, Object component) {
+ return super.getTargetPower(port, component);
+ }
+
+ @Override
+ public void setTargetPower(PortNumber port, Object component, double power) {
+ super.setTargetPower(port, component, power);
+ }
+ },
+
+ /**
+ * OchSignal.
+ */
+ OCHSIGNAL() {
+ @Override
+ public Optional<Double> getTargetPower(PortNumber port, Object component) {
+ return super.getTargetPower(port, component);
+ }
+
+ @Override
+ public void setTargetPower(PortNumber port, Object component, double power) {
+ super.setTargetPower(port, component, power);
+ }
+ };
+
+
+ public TerminalDevicePowerConfig driver;
+
+ /**
+ * mirror method in the internal class.
+ *
+ * @param port port
+ * @param component component
+ * @return target power
+ */
+ public Optional<Double> getTargetPower(PortNumber port, Object component) {
+ NetconfSession session = driver.getNetconfSession(driver.did(), "", "");
+ checkNotNull(session);
+ String filter = parsePort(driver, port, null, null);
+ StringBuilder rpcReq = new StringBuilder();
+ rpcReq.append(RPC_TAG_NETCONF_BASE)
+ .append(driver.getTargetPowerRequestRpc(filter))
+ .append(RPC_CLOSE_TAG);
+ XMLConfiguration xconf = driver.executeRpc(session, rpcReq.toString());
+ if (xconf == null) {
+ log.error("Error in executingRpc");
+ return Optional.empty();
+ }
+ try {
+ Map<String, String> rpcMap = driver.buildRpcString(TARGET_POWER);
+ String configString = rpcMap.get("TARGET_OUTPUT_PATH"),
+ paramStr = rpcMap.get("TARGET_OUTPUT_LEAF");
+ HierarchicalConfiguration config =
+ xconf.configurationAt(configString);
+ if (config == null || config.getString(paramStr) == null) {
+ return Optional.empty();
+ }
+ double power = Float.valueOf(config.getString(paramStr)).doubleValue();
+ return Optional.of(power);
+ } catch (IllegalArgumentException e) {
+ return Optional.empty();
+ }
+ }
+
+ /**
+ * mirror method in the internal class.
+ *
+ * @param port port
+ * @param component component
+ * @param power target value
+ */
+ public void setTargetPower(PortNumber port, Object component, double power) {
+ NetconfSession session = driver.getNetconfSession(driver.did(), "", "");
+ checkNotNull(session);
+ String editConfig = parsePort(driver, port, null, power);
+ StringBuilder rpcReq = new StringBuilder();
+ rpcReq.append(RPC_TAG_NETCONF_BASE)
+ .append("<edit-config>")
+ .append("<target><" + driver.getDataStoreId() + "/></target>")
+ .append("<config>")
+ .append(editConfig)
+ .append("</config>")
+ .append("</edit-config>")
+ .append(RPC_CLOSE_TAG);
+ log.info("Setting power {}", rpcReq.toString());
+ XMLConfiguration xconf = driver.executeRpc(session, rpcReq.toString());
+ // The successful reply should be "<rpc-reply ...><ok /></rpc-reply>"
+ if (!xconf.getRoot().getChild(0).getName().equals("ok")) {
+ log.error("The <edit-config> operation to set target-output-power of Port({}:{}) is failed.",
+ port.toString(), component.toString());
+ }
+ try {
+ session.commit();
+ } catch (NetconfException e) {
+ log.error("error committing channel power", e);
+ }
+ }
+
+ /**
+ * mirror method in the internal class.
+ *
+ * @param port port
+ * @param component the component.
+ * @return current output power.
+ */
+ public Optional<Double> currentPower(PortNumber port, Object component) {
+ Map<String, String> rpcMap = driver.buildRpcString(CURRENT_POWER);
+ String configString = rpcMap.get("CURRENT_POWER_PATH"),
+ queryStr = rpcMap.get("CURRENT_POWER_ROUTE"),
+ paramStr = rpcMap.get("CURRENT_POWER_LEAF");
+ XMLConfiguration xconf = getOpticalChannelState(
+ driver, port, queryStr);
+ try {
+ HierarchicalConfiguration config =
+ xconf.configurationAt(configString);
+ if (config == null || config.getString(paramStr) == null) {
+ return Optional.empty();
+ }
+ double currentPower = Float.valueOf(config.getString(paramStr)).doubleValue();
+ return Optional.of(currentPower);
+ } catch (IllegalArgumentException e) {
+ return Optional.empty();
+ }
+ }
+
+ /**
+ * mirror method in the internal class.
+ *
+ * @param port port
+ * @param component the component
+ * @return current input power
+ */
+ public Optional<Double> currentInputPower(PortNumber port, Object component) {
+ Map<String, String> rpcMap = driver.buildRpcString(CURRENT_INPUT_POWER);
+ String configString = rpcMap.get("CURRENT_INPUT_POWER_PATH"),
+ queryStr = rpcMap.get("CURRENT_INPUT_POWER_ROUTE"),
+ paramStr = rpcMap.get("CURRENT_INPUT_POWER_LEAF");
+ XMLConfiguration xconf = getOpticalChannelState(
+ driver, port, queryStr);
+ try {
+ HierarchicalConfiguration config =
+ xconf.configurationAt(configString);
+ if (config == null || config.getString(paramStr) == null) {
+ return Optional.empty();
+ }
+ double currentPower = Float.valueOf(config.getString(paramStr)).doubleValue();
+ return Optional.of(currentPower);
+ } catch (IllegalArgumentException e) {
+ return Optional.empty();
+ }
+ }
+
+ public Optional<Range<Double>> getTargetPowerRange(PortNumber port, Object component) {
+ XMLConfiguration xconf = getOpticalChannelState(
+ driver, port, "<target-power-range/>");
+ try {
+ HierarchicalConfiguration config =
+ xconf.configurationAt("data/components/component/optical-channel/state/target-power-range");
+ double targetMin = Float.valueOf(config.getString("min")).doubleValue();
+ double targetMax = Float.valueOf(config.getString("max")).doubleValue();
+ return Optional.of(Range.open(targetMin, targetMax));
+ } catch (IllegalArgumentException e) {
+ return Optional.empty();
+ }
+ }
+
+ public Optional<Range<Double>> getInputPowerRange(PortNumber port, Object component) {
+ XMLConfiguration xconf = getOpticalChannelState(
+ driver, port, "<input-power-range/>");
+ try {
+ HierarchicalConfiguration config =
+ xconf.configurationAt("data/components/component/optical-channel/state/input-power-range");
+ double inputMin = Float.valueOf(config.getString("min")).doubleValue();
+ double inputMax = Float.valueOf(config.getString("max")).doubleValue();
+ return Optional.of(Range.open(inputMin, inputMax));
+ } catch (IllegalArgumentException e) {
+ return Optional.empty();
+ }
+ }
+
+ public List<PortNumber> getPorts(Object component) {
+ // FIXME
+ log.warn("Not Implemented Yet!");
+ return new ArrayList<PortNumber>();
+ }
+
+ /**
+ * Get filtered content under <optical-channel><state>.
+ *
+ * @param pc power config instance
+ * @param port the port number
+ * @param underState the filter condition
+ * @return RPC reply
+ */
+ public static XMLConfiguration getOpticalChannelState(TerminalDevicePowerConfig pc,
+ PortNumber port, String underState) {
+ NetconfSession session = pc.getNetconfSession(pc.did(), "", "");
+ checkNotNull(session);
+ String name = ocName(pc, port);
+ StringBuilder rpcReq = new StringBuilder(RPC_TAG_NETCONF_BASE);
+ rpcReq.append("<get><filter><components xmlns=\"http://openconfig.net/yang/platform\"><component>")
+ .append(pc.getOpticalChannelStateRequestRpc(name, underState))
+ .append(RPC_CLOSE_TAG);
+ XMLConfiguration xconf = pc.executeRpc(session, rpcReq.toString());
+ return xconf;
+ }
+
+
+ /**
+ * Extract component name from portNumber's annotations.
+ *
+ * @param pc power config instance
+ * @param portNumber the port number
+ * @return the component name
+ */
+ public static String ocName(TerminalDevicePowerConfig pc, PortNumber portNumber) {
+ DeviceService deviceService = DefaultServiceDirectory.getService(DeviceService.class);
+ DeviceId deviceId = pc.handler().data().deviceId();
+ return deviceService.getPort(deviceId, portNumber).annotations().value("oc-name");
+ }
+
+
+ /**
+ * Parse filtering string from port and component.
+ *
+ * @param portNumber Port Number
+ * @param component port component (optical-channel)
+ * @param power power value set
+ * @param pc instance of Power config implementation
+ * @return filtering string in xml format
+ */
+ public static String parsePort(TerminalDevicePowerConfig pc, PortNumber portNumber,
+ Object component, Double power) {
+ if (component == null) {
+ String name = ocName(pc, portNumber);
+ StringBuilder sb = new StringBuilder("<components xmlns=\"http://openconfig.net/yang/platform\">");
+ if (power != null) {
+ // This is an edit-config operation.
+ sb.append(pc.parsePortRequestRpc(power, name));
+ }
+ sb.append("</component>").append("</components>");
+ return sb.toString();
+ } else {
+ log.error("Cannot process the component {}.", component.getClass());
+ return null;
+ }
+ }
+ }
+
+}
+