[GEANT] Adding driver/behavior for setting configuration on NETCONF devices.

Change-Id: Iced3ba42c5b1d43d64c06fd19234017dc8a21278

+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.
+ */
+package org.onosproject.cli.net;
+
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.behaviour.ConfigSetter;
+import org.onosproject.net.driver.DriverHandler;
+import org.onosproject.net.driver.DriverService;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Command that sets the configuration included in the specified file to the
+ * specified device. It prints the response of the device.
+ *
+ * This is a temporary development tool for use until yang integration is complete.
+ * This uses a not properly specified behavior. DO NOT USE AS AN EXAMPLE.
+ */
+//Temporary Developer tool, NOT TO BE USED in production or as example for
+// future commands.
+//FIXME this should eventually be removed.
+
+@Command(scope = "onos", name = "device-setconfiguration",
+        description = "Sets the configuration of the specified file to the " +
+                "specified device.")
+public class DeviceConfigSetterCommand extends AbstractShellCommand {
+
+    @Argument(index = 0, name = "uri", description = "Device ID",
+            required = true, multiValued = false)
+    private String uri = null;
+    @Argument(index = 1, name = "cfgFile", description = "Configuration file",
+            required = true, multiValued = false)
+    private String cfgFile = null;
+    private DeviceId deviceId;
+
+    @Override
+    protected void execute() {
+        DriverService service = get(DriverService.class);
+        deviceId = DeviceId.deviceId(uri);
+        DriverHandler h = service.createHandler(deviceId);
+        ConfigSetter config = h.behaviour(ConfigSetter.class);
+        checkNotNull(cfgFile, "Configuration file cannot be null");
+        print(config.setConfiguration(cfgFile));
+    }
+
+}

@@ -127,6 +127,12 @@
             </completers>
         </command>
         <command>
+            <action class="org.onosproject.cli.net.DeviceConfigSetterCommand"/>
+            <completers>
+                <ref component-id="deviceIdCompleter"/>
+            </completers>
+        </command>
+        <command>
             <action class="org.onosproject.cli.net.DevicePortGetterCommand"/>
             <completers>
                 <ref component-id="deviceIdCompleter"/>

+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.
+ */
+
+package org.onosproject.net.behaviour;
+
+import org.onosproject.net.driver.HandlerBehaviour;
+
+/**
+ * Behaviour that sets the configuration to a device.
+ *
+ */
+//Temporary Developer tool, NOT TO BE USED in production or as example for
+// future drivers/behaviors.
+//FIXME this should eventually be removed.
+public interface ConfigSetter extends HandlerBehaviour {
+
+    /**
+     * Sets the configuration contained in the file at the file path, returns
+     * the response of the device.
+     * @param filePath the path to the configuration file.
+     * @return string response received from the device.
+     */
+    String setConfiguration(String filePath);
+}

+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.
+ */
+
+package org.onosproject.drivers.netconf;
+
+import org.onosproject.net.behaviour.ConfigSetter;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import com.google.common.base.Preconditions;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.driver.DriverHandler;
+import org.onosproject.netconf.NetconfController;
+import org.slf4j.Logger;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Sets the configuration included in the specified file to the specified
+ * device. It returns the response of the device.
+ * Temporary Developer tool, NOT TO BE USED in production or as example for
+ * future drivers/behaviors.
+ */
+//FIXME this should eventually be removed.
+
+public class NetconfConfigSetter extends AbstractHandlerBehaviour
+        implements ConfigSetter {
+
+    private final Logger log = getLogger(getClass());
+
+    private static final String UNABLE_TO_READ_FILE =
+            "Configuration cannot be retrieved from file";
+    private static final String UNABLE_TO_SET_CONFIG =
+            "Configuration cannot be set";
+
+    @Override
+    public String setConfiguration(String filePath) {
+        DriverHandler handler = handler();
+        NetconfController controller = handler.get(NetconfController.class);
+        DeviceId deviceId = handler.data().deviceId();
+        Preconditions.checkNotNull(controller, "Netconf controller is null");
+
+        String request;
+        try {
+            request = new String(Files.readAllBytes(Paths.get(filePath)));
+        } catch (IOException e) {
+            log.error("Cannot read configuration file", e);
+            return UNABLE_TO_READ_FILE;
+        }
+
+        try {
+            return controller.getDevicesMap()
+                    .get(deviceId)
+                    .getSession()
+                    .requestSync(request);
+        } catch (IOException e) {
+            log.error("Configuration could not be set", e);
+        }
+        return UNABLE_TO_SET_CONFIG;
+    }
+
+}

@@ -22,10 +22,14 @@
                    impl="org.onosproject.drivers.netconf.NetconfControllerConfig"/>
         <behaviour api="org.onosproject.net.behaviour.ConfigGetter"
                    impl="org.onosproject.drivers.netconf.NetconfConfigGetter"/>
+        <behaviour api="org.onosproject.net.behaviour.ConfigSetter"
+                   impl="org.onosproject.drivers.netconf.NetconfConfigSetter"/>
     </driver>
     <driver name="netconf" extends="default">
         <behaviour api="org.onosproject.net.behaviour.ConfigGetter"
                    impl="org.onosproject.drivers.netconf.NetconfConfigGetter"/>
+        <behaviour api="org.onosproject.net.behaviour.ConfigSetter"
+                   impl="org.onosproject.drivers.netconf.NetconfConfigSetter"/>
     </driver>
 </drivers>