Akihiro Yamanouchi
Committed by Yuta HIGUCHI

[ONOS-4837] NETCONF function for FUJITSU OLT #4 and #5

- Add the following commands for FJ OLT
  volt-onus <netconf:target> <ONU ID>
  volt-setonu <netconf:target> <ONU-ID:parameter type:parameter value>
  volt-onustats <netconf:target> {ONU-ID}
  volt-rebootonu <netconf:target> <ONU-ID>
  volt-ethloopback <netconf:target> <ONU-ETH-ID[:loopback mode]>
- Add the method of doUserRpc() in Netconfsession/NetconfSessionImpl
   *If you dont allow to implement the method, i can move it to our XmlUtility method.
- Add new behaviours in /core/.../net/behaviour, and @Beta in the interface.
- Move those behaviour interface to fujitsu driver directory.
   * VoltPonLinkConfig.java as well.
- Update fujitsu-drivers.xml
- Change the method name from doUserRpc to doWrappedRpc

Change-Id: Ic39d3a11ba35d2377e552af097eda65c5554c63f
Showing 18 changed files with 623 additions and 6 deletions
/*
* Copyright 2016-present 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.fujitsu;
import org.onosproject.mastership.MastershipService;
import org.onosproject.net.DeviceId;
import org.onosproject.drivers.fujitsu.behaviour.VoltOnuOperConfig;
import org.onosproject.net.driver.AbstractHandlerBehaviour;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.netconf.NetconfController;
import org.slf4j.Logger;
import java.io.IOException;
import static com.google.common.base.Preconditions.checkNotNull;
import static org.onosproject.drivers.fujitsu.FujitsuVoltXmlUtility.*;
import static org.slf4j.LoggerFactory.getLogger;
/**
* Implementation to take actions on ONU available in vOLT
* through the Netconf protocol.
*/
public class FujitsuVoltOnuOperConfig extends AbstractHandlerBehaviour
implements VoltOnuOperConfig {
private final Logger log = getLogger(FujitsuVoltOnuOperConfig.class);
private static final String ONU_REBOOT = "onu-reboot";
private static final String ONU_ETHPORT_LOOPBACK = "onu-ethport-loopback";
private static final String ETHPORT_ID = "ethport-id";
private int pon;
private int onu;
private int eth;
@Override
public String rebootOnu(String target) {
DriverHandler handler = handler();
NetconfController controller = handler.get(NetconfController.class);
MastershipService mastershipService = handler.get(MastershipService.class);
DeviceId ncDeviceId = handler.data().deviceId();
checkNotNull(controller, "Netconf controller is null");
String reply = null;
String[] onuId = null;
if (!mastershipService.isLocalMaster(ncDeviceId)) {
log.warn("Not master for {} Use {} to execute command",
ncDeviceId,
mastershipService.getMasterFor(ncDeviceId));
return reply;
}
onuId = target.split(HYPHEN);
if (onuId.length != 2) {
log.error("Invalid number of arguments");
return reply;
}
try {
pon = Integer.parseInt(onuId[0]);
onu = Integer.parseInt(onuId[1]);
} catch (NumberFormatException e) {
log.error("Non-number input");
return reply;
}
try {
StringBuilder request = new StringBuilder();
request.append(ANGLE_LEFT).append(ONU_REBOOT).append(SPACE);
request.append(VOLT_NE_NAMESPACE).append(ANGLE_RIGHT).append(NEW_LINE);
request.append(buildStartTag(PONLINK_ID, false));
request.append(onuId[0]);
request.append(buildEndTag(PONLINK_ID));
request.append(buildStartTag(ONU_ID, false));
request.append(onuId[1]);
request.append(buildEndTag(ONU_ID));
request.append(buildEndTag(ONU_REBOOT));
reply = controller.
getDevicesMap().get(ncDeviceId).getSession().
doWrappedRpc(request.toString());
} catch (IOException e) {
log.error("Cannot communicate to device {} exception ", ncDeviceId, e);
}
return reply;
}
@Override
public String loopbackEthOnu(String target) {
DriverHandler handler = handler();
NetconfController controller = handler.get(NetconfController.class);
MastershipService mastershipService = handler.get(MastershipService.class);
DeviceId ncDeviceId = handler.data().deviceId();
checkNotNull(controller, "Netconf controller is null");
String reply = null;
String[] ethId = null;
if (!mastershipService.isLocalMaster(ncDeviceId)) {
log.warn("Not master for {} Use {} to execute command",
ncDeviceId,
mastershipService.getMasterFor(ncDeviceId));
return reply;
}
ethId = target.split(HYPHEN);
if (ethId.length != 3) {
log.error("Invalid number of arguments");
return reply;
}
try {
pon = Integer.parseInt(ethId[0]);
onu = Integer.parseInt(ethId[1]);
eth = Integer.parseInt(ethId[2]);
} catch (NumberFormatException e) {
log.error("Non-number input");
return reply;
}
try {
StringBuilder request = new StringBuilder();
request.append(ANGLE_LEFT).append(ONU_ETHPORT_LOOPBACK).append(SPACE);
request.append(VOLT_NE_NAMESPACE).append(ANGLE_RIGHT).append(NEW_LINE);
request.append(buildStartTag(PONLINK_ID, false));
request.append(ethId[0]);
request.append(buildEndTag(PONLINK_ID));
request.append(buildStartTag(ONU_ID, false));
request.append(ethId[1]);
request.append(buildEndTag(ONU_ID));
request.append(buildStartTag(ETHPORT_ID, false));
request.append(ethId[2]);
request.append(buildEndTag(ETHPORT_ID));
request.append(buildEndTag(ONU_ETHPORT_LOOPBACK));
reply = controller.
getDevicesMap().get(ncDeviceId).getSession().
doWrappedRpc(request.toString());
} catch (IOException e) {
log.error("Cannot communicate to device {} exception ", ncDeviceId, e);
}
return reply;
}
}
......@@ -18,7 +18,7 @@ package org.onosproject.drivers.fujitsu;
import org.onosproject.mastership.MastershipService;
import org.onosproject.net.DeviceId;
import org.onosproject.net.behaviour.VoltPonLinkConfig;
import org.onosproject.drivers.fujitsu.behaviour.VoltPonLinkConfig;
import org.onosproject.net.driver.AbstractHandlerBehaviour;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.netconf.NetconfController;
......
/*
* Copyright 2016-present 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.fujitsu.behaviour;
import com.google.common.annotations.Beta;
import org.onosproject.net.driver.HandlerBehaviour;
/**
* Device behaviour to obtain and set parameters of ONUs in vOLT.
*/
@Beta
public interface VoltOnuConfig extends HandlerBehaviour {
/**
* Obtain all ONUs or a specific ONU in the device.
*
* @param target input data in string
* @return response string
*/
String getOnus(String target);
/**
* Set a parameter value of an ONU in the device.
*
* @param target input data in string
* @return response string
*/
String setOnu(String target);
/**
* Obtain all or a specific ONU statistics in the device.
*
* @param target input data in string
* @return response string
*/
String getOnuStatistics(String target);
}
/*
* Copyright 2016-present 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.fujitsu.behaviour;
import com.google.common.annotations.Beta;
import org.onosproject.net.driver.HandlerBehaviour;
/**
* Device behaviour to perform actions in an ONU in vOLT.
*/
@Beta
public interface VoltOnuOperConfig extends HandlerBehaviour {
/**
* Reboot an ONU in the device.
*
* @param target input data in string
*/
String rebootOnu(String target);
/**
* Operate/release loopback on Ethernet port an ONU in the device.
*
* @param target input data in string
*/
String loopbackEthOnu(String target);
}
......@@ -13,13 +13,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.net.behaviour;
package org.onosproject.drivers.fujitsu.behaviour;
import com.google.common.annotations.Beta;
import org.onosproject.net.driver.HandlerBehaviour;
/**
* Device behaviour to obtain and set parameters of PON links in vOLT.
*/
@Beta
public interface VoltPonLinkConfig extends HandlerBehaviour {
/**
......
/*
* Copyright 2016-present 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.
*/
/**
* Abstractions of various device configuration or device adaptation behaviours;
* counterpart to the device driver subsystem. -vOLT
*/
package org.onosproject.drivers.fujitsu.behaviour;
/*
* Copyright 2016-present 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.fujitsu.cli;
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.drivers.fujitsu.behaviour.VoltOnuOperConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
/**
* Operates/releases loopback on Ethernet port of an ONU in vOLT.
*/
@Command(scope = "onos", name = "volt-ethloopback",
description = "Operates/releases loopback on Ethernet port of an ONU in vOLT")
public class VoltEthLoopbackCommand extends AbstractShellCommand {
@Argument(index = 0, name = "uri", description = "Device ID",
required = true, multiValued = false)
String uri = null;
@Argument(index = 1, name = "target", description = "PON link ID-ONU ID-Eth port ID[:(operate:release)]",
required = true, multiValued = false)
String target = null;
private DeviceId deviceId;
@Override
protected void execute() {
DriverService service = get(DriverService.class);
deviceId = DeviceId.deviceId(uri);
DriverHandler h = service.createHandler(deviceId);
VoltOnuOperConfig volt = h.behaviour(VoltOnuOperConfig.class);
String reply = volt.loopbackEthOnu(target);
if (reply != null) {
print("%s", reply);
} else {
print("No reply from %s", deviceId.toString());
}
}
}
/*
* Copyright 2016-present Open tworking 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.fujitsu.cli;
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.drivers.fujitsu.behaviour.VoltOnuConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
/**
* Gets ONU statistics in vOLT.
*/
@Command(scope = "onos", name = "volt-onustats",
description = "Gets ONU statistics in vOLT")
public class VoltGetOnuStatsCommand extends AbstractShellCommand {
@Argument(index = 0, name = "uri", description = "Device ID",
required = true, multiValued = false)
String uri = null;
@Argument(index = 1, name = "target", description = "PON link ID-ONU ID",
required = false, multiValued = false)
String target = null;
private DeviceId deviceId;
@Override
protected void execute() {
DriverService service = get(DriverService.class);
deviceId = DeviceId.deviceId(uri);
DriverHandler h = service.createHandler(deviceId);
VoltOnuConfig volt = h.behaviour(VoltOnuConfig.class);
String reply = volt.getOnuStatistics(target);
if (reply != null) {
print("%s", reply);
} else {
print("No reply from %s", deviceId.toString());
}
}
}
/*
* Copyright 2016-present Open tworking 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.fujitsu.cli;
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.drivers.fujitsu.behaviour.VoltOnuConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
/**
* Gets ONUs available in vOLT.
*/
@Command(scope = "onos", name = "volt-onus",
description = "Gets ONUs available in vOLT")
public class VoltGetOnusCommand extends AbstractShellCommand {
@Argument(index = 0, name = "uri", description = "Device ID",
required = true, multiValued = false)
String uri = null;
@Argument(index = 1, name = "target", description = "PON link ID or PON link ID-ONU ID",
required = false, multiValued = false)
String target = null;
private DeviceId deviceId;
@Override
protected void execute() {
DriverService service = get(DriverService.class);
deviceId = DeviceId.deviceId(uri);
DriverHandler h = service.createHandler(deviceId);
VoltOnuConfig volt = h.behaviour(VoltOnuConfig.class);
String reply = volt.getOnus(target);
if (reply != null) {
print("%s", reply);
} else {
print("No reply from %s", deviceId.toString());
}
}
}
......@@ -19,7 +19,7 @@ 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.VoltPonLinkConfig;
import org.onosproject.drivers.fujitsu.behaviour.VoltPonLinkConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
......
/*
* Copyright 2016-present 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.fujitsu.cli;
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.drivers.fujitsu.behaviour.VoltOnuOperConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
/**
* Reboots an ONU in vOLT.
*/
@Command(scope = "onos", name = "volt-rebootonu",
description = "Reboots an ONU in vOLT")
public class VoltRebootOnuCommand extends AbstractShellCommand {
@Argument(index = 0, name = "uri", description = "Device ID",
required = true, multiValued = false)
String uri = null;
@Argument(index = 1, name = "target", description = "PON link ID-ONU ID",
required = true, multiValued = false)
String target = null;
private DeviceId deviceId;
@Override
protected void execute() {
DriverService service = get(DriverService.class);
deviceId = DeviceId.deviceId(uri);
DriverHandler h = service.createHandler(deviceId);
VoltOnuOperConfig volt = h.behaviour(VoltOnuOperConfig.class);
String reply = volt.rebootOnu(target);
if (reply != null) {
print("%s", reply);
} else {
print("No reply from %s", deviceId.toString());
}
}
}
/*
* Copyright 2016-present Open tworking 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.fujitsu.cli;
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.drivers.fujitsu.behaviour.VoltOnuConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
/**
* Sets a parameter value of an ONU in vOLT.
*/
@Command(scope = "onos", name = "volt-setonu",
description = "Sets a parameter value of an ONU in vOLT")
public class VoltSetOnuCommand extends AbstractShellCommand {
@Argument(index = 0, name = "uri", description = "Device ID",
required = true, multiValued = false)
String uri = null;
@Argument(index = 1, name = "target", description = "PON link ID-ONU ID:parameter:value",
required = true, multiValued = false)
String target = null;
private DeviceId deviceId;
@Override
protected void execute() {
DriverService service = get(DriverService.class);
deviceId = DeviceId.deviceId(uri);
DriverHandler h = service.createHandler(deviceId);
VoltOnuConfig volt = h.behaviour(VoltOnuConfig.class);
String reply = volt.setOnu(target);
if (reply != null) {
print("%s", reply);
} else {
print("No reply from %s", deviceId.toString());
}
}
}
......@@ -19,7 +19,7 @@ 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.VoltPonLinkConfig;
import org.onosproject.drivers.fujitsu.behaviour.VoltPonLinkConfig;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
......
......@@ -23,13 +23,42 @@
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltSetPonLinkCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltGetOnusCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltSetOnuCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltGetOnuStatsCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltEthLoopbackCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
<command>
<action class="org.onosproject.drivers.fujitsu.cli.VoltRebootOnuCommand"/>
<completers>
<ref component-id="deviceIdCompleter"/>
</completers>
</command>
</command-bundle>
<bean id="deviceIdCompleter" class="org.onosproject.cli.net.DeviceIdCompleter"/>
......
......@@ -24,7 +24,11 @@
<driver name="fujitsu-volt-netconf" manufacturer="Fujitsu" hwVersion="svkOLT" swVersion="v1.0">
<behaviour api="org.onosproject.net.behaviour.ControllerConfig"
impl="org.onosproject.drivers.fujitsu.FujitsuVoltControllerConfig"/>
<behaviour api="org.onosproject.net.behaviour.VoltPonLinkConfig"
<behaviour api="org.onosproject.drivers.fujitsu.behaviour.VoltPonLinkConfig"
impl="org.onosproject.drivers.fujitsu.FujitsuVoltPonLinkConfig"/>
<behaviour api="org.onosproject.drivers.fujitsu.behaviour.VoltOnuConfig"
impl="org.onosproject.drivers.fujitsu.FujitsuVoltOnuConfig"/>
<behaviour api="org.onosproject.drivers.fujitsu.behaviour.VoltOnuOperConfig"
impl="org.onosproject.drivers.fujitsu.FujitsuVoltOnuOperConfig"/>
</driver>
</drivers>
\ No newline at end of file
......
......@@ -60,6 +60,16 @@ public interface NetconfSession {
throws NetconfException;
/**
* Executes an RPC to the server and wrap the request in RPC header.
*
* @param request the XML containing the request to the server.
* @return Server response or ERROR
* @throws NetconfException when there is a problem in the communication process on
* the underlying connection
*/
String doWrappedRpc(String request) throws NetconfException;
/**
* Executes an synchronous RPC to the server.
*
* @param request the XML containing the RPC for the server.
......
......@@ -289,6 +289,24 @@ public class NetconfSessionImpl implements NetconfSession {
}
@Override
public String doWrappedRpc(String request) throws NetconfException {
StringBuilder rpc = new StringBuilder(XML_HEADER);
rpc.append(RPC_OPEN);
rpc.append(MESSAGE_ID_STRING);
rpc.append(EQUAL);
rpc.append("\"");
rpc.append(messageIdInteger.get());
rpc.append("\" ");
rpc.append(NETCONF_BASE_NAMESPACE).append(">\n");
rpc.append(request);
rpc.append(RPC_CLOSE).append(NEW_LINE);
rpc.append(ENDPATTERN);
String reply = sendRequest(rpc.toString());
checkReply(reply);
return reply;
}
@Override
public String get(String request) throws NetconfException {
return requestSync(request);
}
......