diff options
Diffstat (limited to 'vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper')
3 files changed, 393 insertions, 0 deletions
diff --git a/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/ActionHelper.java b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/ActionHelper.java new file mode 100644 index 00000000..d9714ff7 --- /dev/null +++ b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/ActionHelper.java @@ -0,0 +1,124 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package com.ericsson.testvnf.server.helper; + +import java.io.OutputStream; +import java.util.Map; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import com.ericsson.testvnf.server.Server; +import com.ericsson.testvnf.server.models.NetconfMessage; +import com.ericsson.testvnf.server.models.RpcData; + +/* + * The helper class which performs actions based on netconf requests + */ +public class ActionHelper { + + private static final Log log = LogFactory.getLog(ActionHelper.class); + private OutputStream out; + private Thread groovyCallerThread; + + public ActionHelper(OutputStream out){ + this.out = out; + } + + public boolean doActionForRPCRequest(NetconfMessage netconfMessage, Map<String, Boolean> connectionResetMap, boolean sessionClosedStatus){ + // if the client is sending an rpc request for any protocol operation + RpcData rpcData = (RpcData) netconfMessage; + if (null != rpcData.getTargetName()) { + // the connectionResetMap is a shared between multiple client connections coming in for a single netconf server instance + // true value for a target indicates that sending events to that target needs to be stopped + // edit-config operation with a target determines the termination of sending events to that target. + if (rpcData.getOperation().equals("edit-config")) { + connectionResetMap.put(rpcData.getTargetName(), true); + } else { + connectionResetMap.put(rpcData.getTargetName(), false); + } + } + if (rpcData.getOperation().equals("\"close-session\"")) { + sessionClosedStatus = true; + } + String operation = rpcData.getOperation(); + log.info("Received query"); + + // on getting a get-schema request from client, the server sends back the yang + // model of the particular functionality/capability asked for. + if (operation.equals("get-schema")) { + doActionForGetSchemaOperation(rpcData); + } else { + doActionForOperations(rpcData, operation, connectionResetMap); + } + return sessionClosedStatus; + } + + public void doActionForOperations(RpcData rpcData, String operation, Map<String, Boolean> connectionResetMap) { + groovyCallerThread = new Thread("Groovy caller") { + @Override + public void run() { + rpcData.setTimeDelayForSendingEvents(Server.getTimeDelayForSendingEvents()); + String result =""; + // pick up and execute the correct groovy file based on the operation and configuration datastore identified from the rpc request + result = HelperUtils.executeGroovy(Server.getNetconfTemplatesDirectory() + + "/netconftemplates/"+operation+"/"+rpcData.getConfigurationDatastore()+"/response.groovy", rpcData, connectionResetMap); + if (!result.equals("ignore")) { + result = result.replaceAll("<MID>", rpcData.getMessageId()); + HelperUtils.sendAsBytesToOutput(result.getBytes(), out); + log.info("Finished writing " + result); + } + } + }; + groovyCallerThread.start(); + log.info("groovyCallerThread started"); + } + + public void doActionForGetSchemaOperation(RpcData rpcData){ + log.info("get-schema received."); + if (null != rpcData.getSchemaDetails() + && null != rpcData.getSchemaDetails().getIdentifier()) { + log.info("Sending schema for capability..."); + String schemaString = HelperUtils.readFile(Server.getNetconfTemplatesDirectory() + + "/netconftemplates/"+rpcData.getSchemaDetails().getIdentifier()+"-schema.yang"); // the yang model has to be in the netconftemplates directory with the proper naming format : '<operation>-schema.yang' + String schemaStringValue = schemaString.replaceAll("<MID>", rpcData.getMessageId()); // Put the correct message id in the response as it is in the request. + HelperUtils.sendAsBytesToOutput(schemaStringValue.getBytes(), out); + log.info("Finished writing the schema information"); + } + } + + // the method sends a hello message to the client, hello.xml in the netconftemplates directory is used to send the hello message + public void sendHelloMessage(){ + log.info("Send hello message."); + String helloMessage = HelperUtils.readFile(Server.getNetconfTemplatesDirectory()+"/netconftemplates/hello.xml"); + HelperUtils.sendAsBytesToOutput(helloMessage.getBytes(), out); + log.info("Hello message sent."); + } + + public void interruptGroovyCallerThread() { + // kill thread if it don't finish naturally + if (groovyCallerThread!=null && groovyCallerThread.isAlive()) { + log.info("Killing groovy caller thread"); + groovyCallerThread.interrupt(); + } + + } +} diff --git a/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/CustomParser.java b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/CustomParser.java new file mode 100644 index 00000000..c615d108 --- /dev/null +++ b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/CustomParser.java @@ -0,0 +1,177 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package com.ericsson.testvnf.server.helper; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.xml.sax.Attributes; +import org.xml.sax.SAXException; +import org.xml.sax.SAXParseException; +import org.xml.sax.ext.DefaultHandler2; + +import com.ericsson.testvnf.server.models.Hello; +import com.ericsson.testvnf.server.models.RpcData; +import com.ericsson.testvnf.server.models.SchemaDetails; +import com.ericsson.testvnf.server.requestqueue.RequestQueueHandler; + +/* + * Parses the xml requests and populates netconf related data to do operations + */ +public class CustomParser extends DefaultHandler2 { + + private Log log = LogFactory.getLog(CustomParser.class); + private RequestQueueHandler requestQueueHandler; + + private Hello hello; + private RpcData rpcData; + private boolean nextIsOperationTag = false; + private boolean insideOperationTag = false; + private String operationTagValue = ""; + private StringBuilder operationTagContent = new StringBuilder(); + private boolean insideConfigurationDatastore = false; + private boolean insideSchemaDetailsTag = false; + private StringBuilder individualSchemaDetailsTagContent = new StringBuilder(); + private SchemaDetails schemaDetails; + private boolean insideTargetNameTag = false; + private StringBuilder targetNameContent = new StringBuilder(); + + @Override + public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { + super.startElement(uri, localName, qName, attributes); + String messageId; + if (nextIsOperationTag) { + insideOperationTag = true; + rpcData.setOperation(localName); + operationTagValue = localName; + nextIsOperationTag = false; + if (localName.equalsIgnoreCase("get-schema")) { + insideSchemaDetailsTag = true; + schemaDetails = new SchemaDetails(); + } + } + + if (insideOperationTag) { + populateStartElementData(localName, attributes); + } + + if (localName.equalsIgnoreCase("hello")) { + hello = new Hello(); + } else if (localName.equalsIgnoreCase("rpc")) { + rpcData = new RpcData(); + + messageId = attributes.getValue("message-id"); + if (messageId == null) + throw new SAXException("Received <rpc> message without a message ID"); + + rpcData.setMessageId(messageId); + nextIsOperationTag = true; + } + + } + + @Override + public void characters(char[] ch, int start, int length) throws SAXException { + super.characters(ch, start, length); + + if (insideOperationTag) { + operationTagContent.append(ch, start, length); + if (insideSchemaDetailsTag) { + individualSchemaDetailsTagContent.append(ch, start, length); + }else if (insideTargetNameTag) { + targetNameContent.append(ch, start, length); + } + } + } + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + super.endElement(uri, localName, qName); + + if (insideOperationTag) { + populateEndElementData(localName); + } + if (localName.equalsIgnoreCase("hello")) { + requestQueueHandler.addToQueue(hello); + hello = null; + /* Query tags and operations */ + } else if (localName.equalsIgnoreCase("rpc")) { + requestQueueHandler.addToQueue(rpcData); + rpcData = null; + }else if(operationTagValue.equals(localName)) { + rpcData.setOperationTagContent(operationTagContent.toString()); + insideOperationTag = false; + operationTagContent = new StringBuilder(); + if (localName.equalsIgnoreCase("get-schema")) { + insideSchemaDetailsTag = false; + rpcData.setSchemaDetails(schemaDetails); + schemaDetails = new SchemaDetails(); + } + } + } + + private void populateStartElementData(String localName, Attributes attributes) { + if (insideConfigurationDatastore) { + rpcData.setConfigurationDatastore(localName); + } + if (localName.equalsIgnoreCase("target") || localName.equalsIgnoreCase("source")) { + insideConfigurationDatastore = true; + } else if(localName.equalsIgnoreCase("target-name")) { + insideTargetNameTag = true; + } + operationTagContent.append("<" + localName); + for (int i = 0; i < attributes.getLength(); i++) { + operationTagContent.append(" " + attributes.getQName(i) + "=\"" + attributes.getValue(i) + "\""); + } + operationTagContent.append(">"); + } + + private void populateEndElementData(String localName) { + if (localName.equalsIgnoreCase("target") || localName.equalsIgnoreCase("source")) { + insideConfigurationDatastore = false; + } else if(localName.equalsIgnoreCase("target-name")) { + insideTargetNameTag = false; + rpcData.setTargetName(targetNameContent.toString()); + targetNameContent = new StringBuilder(); + } else if (insideSchemaDetailsTag) { + if(localName.equalsIgnoreCase("identifier")) { + schemaDetails.setIdentifier(individualSchemaDetailsTagContent.toString().trim()); + individualSchemaDetailsTagContent = new StringBuilder(); + } else if(localName.equalsIgnoreCase("version")) { + schemaDetails.setVersion(individualSchemaDetailsTagContent.toString().trim()); + individualSchemaDetailsTagContent = new StringBuilder(); + } + } + operationTagContent.append("</" + localName + ">"); + } + + public void setRequestQueueHandler(RequestQueueHandler queue) { + this.requestQueueHandler = queue; + } + + @Override + public void error(SAXParseException e) throws SAXException { + log.warn(e.getMessage()); + } + + @Override + public void fatalError(SAXParseException e) throws SAXException { + log.warn(e.getMessage()); + } +}
\ No newline at end of file diff --git a/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/HelperUtils.java b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/HelperUtils.java new file mode 100644 index 00000000..cec61354 --- /dev/null +++ b/vnfs/TestVNF/netconfserver/src/main/java/com/ericsson/testvnf/server/helper/HelperUtils.java @@ -0,0 +1,92 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package com.ericsson.testvnf.server.helper; + +import java.io.File; +import java.io.IOException; +import java.io.OutputStream; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Map; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import com.ericsson.testvnf.server.models.NetconfMessage; + +import groovy.lang.Binding; +import groovy.util.GroovyScriptEngine; + +/* + * The utils class + */ +public class HelperUtils{ + + private static final Log log = LogFactory.getLog(HelperUtils.class); + + private HelperUtils() { + super(); + } + + // executes the groovy file specified in the path + public static String executeGroovy(String groovyFilePath, NetconfMessage data, Map<String, Boolean> connectionResetMap) { + + Object result = ""; + try { + log.info("groovy path------" + groovyFilePath); + File file = new File(groovyFilePath); + GroovyScriptEngine engine = new GroovyScriptEngine(file.getParent()); + Binding binding = new Binding(); + binding.setVariable("RpcData", data); + binding.setVariable("connectionResetMap", connectionResetMap); + log.info("binding " + binding + " " + file.getParent() + " " + file.getName()); + result = engine.run(file.getName(), binding); + } catch (Exception e) { + log.error("Exception while trying to execute groovy file", e); + } + return result.toString(); + } + + // send bytes to output stream + public static void sendAsBytesToOutput(byte[] buffer, OutputStream out){ + try { + log.info("Sending message as bytes..\n"); + int len = buffer.length; + out.write(buffer, 0, len); + String tail = "]]>]]>"; + out.write(tail.getBytes(), 0, tail.getBytes().length); + out.flush(); + }catch(Exception e) { + log.info("Error while sending response message as bytes: "+e); + } + } + + // the method is used to read the contents of the file specified + public static String readFile(String filename) { + String fileAsString= ""; + try { + fileAsString = new String(Files.readAllBytes(Paths.get(filename))); + } catch (IOException e) { + log.error("Error reading file: "+ filename); + } + return fileAsString; + } +}
\ No newline at end of file |