홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Sanjay S
Committed by Gerrit Code Review
eb5eebbb 1 parent fc3b48e0

Modified to accommodate code review comments. 

Change-Id: I391db0afe13d862706b5592e60e83b725d99e672
Inline Side-by-side
Showing 4 changed files with 83 additions and 121 deletions
......@@ -129,7 +129,7 @@
<bundle>mvn:org.onosproject/onos-core-common/@ONOS-VERSION</bundle>
<bundle>mvn:org.onosproject/onos-core-trivial/@ONOS-VERSION</bundle>
</feature>
<feature name="onos-netconf" version="@FEATURE-VERSION"
description="ONOS Netconf providers">
<feature>onos-api</feature>
......
......@@ -41,7 +41,7 @@ import com.tailf.jnc.SSHSession;
* necessary information to connect and execute NETCONF operations.
*/
public class NetconfDevice {
private static final Logger log = getLogger(NetconfDevice.class);
private final Logger log = getLogger(NetconfDevice.class);
/**
* The Device State is used to determine whether the device is active or
......@@ -51,9 +51,9 @@ public class NetconfDevice {
public static enum DeviceState {
/* Used to specify Active state of the device */
ACTIVE,
/* Used to specify In Active state of the device */
/* Used to specify inactive state of the device */
INACTIVE,
/* Used to specify In Valid state of the device */
/* Used to specify invalid state of the device */
INVALID
}
......@@ -99,13 +99,11 @@ public class NetconfDevice {
}
// Send hello message to retrieve capabilities.
} catch (IOException e) {
NetconfDevice.log
.error("Fatal Error while creating connection to the device: "
+ deviceInfo(), e);
log.error("Fatal Error while creating connection to the device: "
+ deviceInfo(), e);
throw e;
} catch (JNCException e) {
NetconfDevice.log.error("Failed to connect to the device: "
+ deviceInfo(), e);
log.error("Failed to connect to the device: " + deviceInfo(), e);
throw e;
}
......@@ -118,14 +116,10 @@ public class NetconfDevice {
ssh = new SSHSession(sshConnection);
String helloRequestXML = INPUT_HELLO_XML_MSG.trim();
if (NetconfDevice.log.isDebugEnabled()) {
NetconfDevice.log
.debug("++++++++++++++++++++++++++++++++++Sending Hello: "
+ sshConnection.getGanymedConnection()
.getHostname()
+ "++++++++++++++++++++++++++++++++++");
printPrettyXML(helloRequestXML);
}
log.debug("++++++++++++++++++++++++++++++++++Sending Hello: "
+ sshConnection.getGanymedConnection().getHostname()
+ "++++++++++++++++++++++++++++++++++");
printPrettyXML(helloRequestXML);
ssh.print(helloRequestXML);
// ssh.print(endCharSeq);
ssh.flush();
......@@ -139,8 +133,7 @@ public class NetconfDevice {
if (ssh.ready()) {
StringBuffer readOne = ssh.readOne();
if (readOne == null) {
NetconfDevice.log
.error("The Hello Contains No Capabilites");
log.error("The Hello Contains No Capabilites");
throw new JNCException(
JNCException.SESSION_ERROR,
"server does not support NETCONF base capability: "
......@@ -148,39 +141,31 @@ public class NetconfDevice {
} else {
xmlResponse = readOne.toString().trim();
if (NetconfDevice.log.isDebugEnabled()) {
NetconfDevice.log
.debug("++++++++++++++++++++++++++++++++++Reading Capabilities: "
+ sshConnection.getGanymedConnection()
.getHostname()
+ "++++++++++++++++++++++++++++++++++");
log.debug("++++++++++++++++++++++++++++++++++Reading Capabilities: "
+ sshConnection.getGanymedConnection()
.getHostname()
+ "++++++++++++++++++++++++++++++++++");
printPrettyXML(xmlResponse);
}
printPrettyXML(xmlResponse);
processCapabilities(xmlResponse);
}
}
reachable = true;
} catch (IOException e) {
NetconfDevice.log
.error("Fatal Error while sending Hello Message to the device: "
+ deviceInfo(), e);
log.error("Fatal Error while sending Hello Message to the device: "
+ deviceInfo(), e);
} catch (JNCException e) {
NetconfDevice.log
.error("Fatal Error while sending Hello Message to the device: "
+ deviceInfo(), e);
log.error("Fatal Error while sending Hello Message to the device: "
+ deviceInfo(), e);
} finally {
if (NetconfDevice.log.isDebugEnabled()) {
NetconfDevice.log
.debug("Closing the session after successful execution");
}
log.debug("Closing the session after successful execution");
ssh.close();
}
}
private void processCapabilities(String xmlResponse) throws JNCException {
if (xmlResponse.isEmpty()) {
NetconfDevice.log.error("The capability response cannot be empty");
log.error("The capability response cannot be empty");
throw new JNCException(
JNCException.SESSION_ERROR,
"server does not support NETCONF base capability: "
......@@ -192,8 +177,7 @@ public class NetconfDevice {
Element rootElement = doc.getRootElement();
processCapabilities(rootElement);
} catch (Exception e) {
NetconfDevice.log.error("ERROR while parsing the XML "
+ xmlResponse);
log.error("ERROR while parsing the XML " + xmlResponse);
}
}
......@@ -218,12 +202,9 @@ public class NetconfDevice {
Document doc = new SAXBuilder().build(new StringReader(xmlstring));
XMLOutputter xmOut = new XMLOutputter(Format.getPrettyFormat());
String outputString = xmOut.outputString(doc);
if (NetconfDevice.log.isDebugEnabled()) {
NetconfDevice.log.debug(outputString);
}
log.debug(outputString);
} catch (Exception e) {
NetconfDevice.log.error("ERROR while parsing the XML " + xmlstring,
e);
log.error("ERROR while parsing the XML " + xmlstring, e);
}
}
......
......@@ -63,7 +63,7 @@ import org.slf4j.Logger;
public class NetconfDeviceProvider extends AbstractProvider
implements DeviceProvider {
private static final Logger log = getLogger(NetconfDeviceProvider.class);
private final Logger log = getLogger(NetconfDeviceProvider.class);
private Map<DeviceId, NetconfDevice> netconfDeviceMap = new ConcurrentHashMap<DeviceId, NetconfDevice>();
......@@ -102,7 +102,7 @@ public class NetconfDeviceProvider extends AbstractProvider
@Activate
public void activate(ComponentContext context) {
NetconfDeviceProvider.log.info("Netconf Device Provider Started");
log.info("Netconf Device Provider Started");
providerService = providerRegistry.register(this);
modified(context);
}
......@@ -117,32 +117,30 @@ public class NetconfDeviceProvider extends AbstractProvider
}
deviceBuilder.awaitTermination(1000, TimeUnit.MILLISECONDS);
} catch (InterruptedException e) {
NetconfDeviceProvider.log.error("Device builder did not terminate");
log.error("Device builder did not terminate");
}
deviceBuilder.shutdownNow();
netconfDeviceMap.clear();
providerRegistry.unregister(this);
providerService = null;
NetconfDeviceProvider.log.info("Stopped");
log.info("Stopped");
}
@Modified
public void modified(ComponentContext context) {
if (context == null) {
NetconfDeviceProvider.log.info("No configuration file");
log.info("No configuration file");
return;
}
Dictionary<?, ?> properties = context.getProperties();
String deviceCfgValue = get(properties, "devConfigs");
NetconfDeviceProvider.log
.info("Getting Device configuration from cfg file: "
+ deviceCfgValue);
log.info("Getting Device configuration from cfg file: "
+ deviceCfgValue);
if (!isNullOrEmpty(deviceCfgValue)) {
addOrRemoveDevicesConfig(deviceCfgValue);
} else {
NetconfDeviceProvider.log
.info("Device Configuration value receiviced from the property 'devConfigs': "
+ deviceCfgValue + ", is not valid");
log.info("Device Configuration value receiviced from the property 'devConfigs': "
+ deviceCfgValue + ", is not valid");
}
}
......@@ -150,10 +148,11 @@ public class NetconfDeviceProvider extends AbstractProvider
for (String deviceEntry : deviceConfig.split(",")) {
NetconfDevice device = processDeviceEntry(deviceEntry);
if (device != null) {
NetconfDeviceProvider.log.info("Device Detail: " + "username: "
log.info("Device Detail: " + "username: "
+ device.getUsername() + ", host: "
+ device.getSshHost() + ", port: "
+ device.getSshPort());
+ device.getSshPort() + " device state: "
+ device.getDeviceState().name());
if (device.isActive()) {
deviceBuilder.submit(new DeviceCreator(device, true));
} else {
......@@ -165,13 +164,11 @@ public class NetconfDeviceProvider extends AbstractProvider
private NetconfDevice processDeviceEntry(String deviceEntry) {
if (deviceEntry == null) {
NetconfDeviceProvider.log
.info("No content for Device Entry, so cannot proceed further.");
log.info("No content for Device Entry, so cannot proceed further.");
return null;
}
NetconfDeviceProvider.log
.info("Trying to convert Device Entry String: " + deviceEntry
+ " to a Netconf Device Object");
log.info("Trying to convert Device Entry String: " + deviceEntry
+ " to a Netconf Device Object");
NetconfDevice device = null;
try {
String userInfo = deviceEntry.substring(0, deviceEntry
......@@ -187,17 +184,15 @@ public class NetconfDeviceProvider extends AbstractProvider
try {
hostPort = Integer.parseInt(infoSplit[1]);
} catch (NumberFormatException nfe) {
NetconfDeviceProvider.log
.error("Bad Configuration Data: Failed to parse host port number string: "
+ infoSplit[1]);
log.error("Bad Configuration Data: Failed to parse host port number string: "
+ infoSplit[1]);
throw nfe;
}
String deviceState = infoSplit[2];
if (isNullOrEmpty(username) || isNullOrEmpty(password)
|| isNullOrEmpty(hostIp) || hostPort == 0) {
NetconfDeviceProvider.log
.warn("Bad Configuration Data: both user and device information parts of Configuration "
+ deviceEntry + " should be non-nullable");
log.warn("Bad Configuration Data: both user and device information parts of Configuration "
+ deviceEntry + " should be non-nullable");
} else {
device = new NetconfDevice(hostIp, hostPort, username, password);
if (!isNullOrEmpty(deviceState)) {
......@@ -206,28 +201,24 @@ public class NetconfDeviceProvider extends AbstractProvider
device.setDeviceState(DeviceState.ACTIVE);
} else if (deviceState.toUpperCase()
.equals(DeviceState.INACTIVE.name())) {
device.setDeviceState(DeviceState.ACTIVE);
device.setDeviceState(DeviceState.INACTIVE);
} else {
NetconfDeviceProvider.log
.warn("Device State Information can not be empty, so marking the state as INVALID");
log.warn("Device State Information can not be empty, so marking the state as INVALID");
device.setDeviceState(DeviceState.INVALID);
}
} else {
NetconfDeviceProvider.log
.warn("The device entry do not specify state information, so marking the state as INVALID");
log.warn("The device entry do not specify state information, so marking the state as INVALID");
device.setDeviceState(DeviceState.INVALID);
}
}
} catch (ArrayIndexOutOfBoundsException aie) {
NetconfDeviceProvider.log
.error("Error while reading config infromation from the config file: "
+ "The user, host and device state infomation should be "
+ "in the order 'userInfo@hostInfo:deviceState'"
+ deviceEntry, aie);
log.error("Error while reading config infromation from the config file: "
+ "The user, host and device state infomation should be "
+ "in the order 'userInfo@hostInfo:deviceState'"
+ deviceEntry, aie);
} catch (Exception e) {
NetconfDeviceProvider.log
.error("Error while parsing config information for the device entry: "
+ deviceEntry, e);
log.error("Error while parsing config information for the device entry: "
+ deviceEntry, e);
}
return device;
}
......@@ -246,10 +237,9 @@ public class NetconfDeviceProvider extends AbstractProvider
public boolean isReachable(DeviceId deviceId) {
NetconfDevice netconfDevice = netconfDeviceMap.get(deviceId);
if (netconfDevice == null) {
NetconfDeviceProvider.log
.warn("BAD REQUEST: the requested device id: "
+ deviceId.toString()
+ " is not associated to any NETCONF Device");
log.warn("BAD REQUEST: the requested device id: "
+ deviceId.toString()
+ " is not associated to any NETCONF Device");
return false;
}
return netconfDevice.isReachable();
......@@ -273,13 +263,11 @@ public class NetconfDeviceProvider extends AbstractProvider
@Override
public void run() {
if (createFlag && (device.getDeviceState() == DeviceState.ACTIVE)) {
NetconfDeviceProvider.log
.info("Trying to create Device Info on ONOS core");
if (createFlag) {
log.info("Trying to create Device Info on ONOS core");
advertiseDevices();
} else {
NetconfDeviceProvider.log
.info("Trying to remove Device Info on ONOS core");
log.info("Trying to remove Device Info on ONOS core");
removeDevices();
}
}
......@@ -288,22 +276,27 @@ public class NetconfDeviceProvider extends AbstractProvider
* For each Netconf Device, remove the entry from the device store.
*/
private void removeDevices() {
if (!device.isReachable()) {
log.error("BAD Request: 'Currently device is not discovered, so cannot remove/disconnect the device: "
+ device.deviceInfo() + "'");
if (device == null) {
log.warn("The Request Netconf Device is null, cannot proceed further");
return;
}
try {
DeviceId did = getDeviceId();
if (!netconfDeviceMap.containsKey(did)) {
log.error("BAD Request: 'Currently device is not discovered, "
+ "so cannot remove/disconnect the device: "
+ device.deviceInfo() + "'");
return;
}
providerService.deviceDisconnected(did);
device.disconnect();
netconfDeviceMap.remove(did);
delay(EVENTINTERVAL);
} catch (URISyntaxException uriSyntaxExcpetion) {
NetconfDeviceProvider.log
.error("Syntax Error while creating URI for the device: "
+ device.deviceInfo()
+ " couldn't remove the device from the store",
uriSyntaxExcpetion);
log.error("Syntax Error while creating URI for the device: "
+ device.deviceInfo()
+ " couldn't remove the device from the store",
uriSyntaxExcpetion);
}
}
......@@ -314,8 +307,7 @@ public class NetconfDeviceProvider extends AbstractProvider
private void advertiseDevices() {
try {
if (device == null) {
NetconfDeviceProvider.log
.warn("The Request Netconf Device is null, cannot proceed further");
log.warn("The Request Netconf Device is null, cannot proceed further");
return;
}
device.init();
......@@ -327,31 +319,20 @@ public class NetconfDeviceProvider extends AbstractProvider
"", "",
"", "",
cid);
if (NetconfDeviceProvider.log.isDebugEnabled()) {
NetconfDeviceProvider.log.debug("Persisting Device"
+ did.uri().toString());
}
log.info("Persisting Device" + did.uri().toString());
netconfDeviceMap.put(did, device);
providerService.deviceConnected(did, desc);
if (NetconfDeviceProvider.log.isDebugEnabled()) {
NetconfDeviceProvider.log
.debug("Done with Device Info Creation on ONOS core. Device Info: "
+ device.deviceInfo()
+ " "
+ did.uri().toString());
}
log.info("Done with Device Info Creation on ONOS core. Device Info: "
+ device.deviceInfo() + " " + did.uri().toString());
delay(EVENTINTERVAL);
} catch (URISyntaxException e) {
NetconfDeviceProvider.log
.error("Syntax Error while creating URI for the device: "
+ device.deviceInfo()
+ " couldn't persist the device onto the store",
e);
log.error("Syntax Error while creating URI for the device: "
+ device.deviceInfo()
+ " couldn't persist the device onto the store", e);
} catch (Exception e) {
NetconfDeviceProvider.log
.error("Error while initializing session for the device: "
+ device.deviceInfo(), e);
log.error("Error while initializing session for the device: "
+ device.deviceInfo(), e);
}
}
......
......@@ -32,7 +32,7 @@
<description>ONOS Netconf protocol adapters</description>
<modules>
<module>device</module>
<module>device</module>
</modules>
<dependencies>
......