Adding plugins-event module to apex-pdp

Adding plugins-event module to apex-pdp
Fix a minor bug in TextFileUtils

Change-Id: I393c5f5809d078850d6669d22759ba9fa1b4f0e6
Issue-ID: POLICY-862
Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>

5 files changed, 443 insertions, 0 deletions

diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XMLEventConverter.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XMLEventConverter.java
new file mode 100644
index 000000000..01a57caf6
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/Apex2XMLEventConverter.java
@@ -0,0 +1,206 @@
+/*-
+ * ============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 org.onap.policy.apex.plugins.event.protocol.xml;
+
+import java.io.ByteArrayInputStream;
+import java.io.StringWriter;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map.Entry;
+
+import javax.xml.XMLConstants;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBElement;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Marshaller;
+import javax.xml.bind.Unmarshaller;
+import javax.xml.transform.stream.StreamSource;
+import javax.xml.validation.Schema;
+import javax.xml.validation.SchemaFactory;
+
+import org.onap.policy.apex.model.utilities.ResourceUtils;
+import org.onap.policy.apex.plugins.event.protocol.xml.jaxb.ObjectFactory;
+import org.onap.policy.apex.plugins.event.protocol.xml.jaxb.XMLApexEvent;
+import org.onap.policy.apex.plugins.event.protocol.xml.jaxb.XMLApexEventData;
+import org.onap.policy.apex.service.engine.event.ApexEvent;
+import org.onap.policy.apex.service.engine.event.ApexEventException;
+import org.onap.policy.apex.service.engine.event.ApexEventProtocolConverter;
+import org.onap.policy.apex.service.engine.event.ApexEventRuntimeException;
+import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
+import org.slf4j.ext.XLogger;
+import org.slf4j.ext.XLoggerFactory;
+import org.xml.sax.SAXException;
+
+/**
+ * The Class Apex2XMLEventConverter converts {@link ApexEvent} instances into string instances of {@link XMLApexEvent}
+ * that are XML representations of Apex events defined in JAXB.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public final class Apex2XMLEventConverter implements ApexEventProtocolConverter {
+    private static final XLogger LOGGER = XLoggerFactory.getXLogger(Apex2XMLEventConverter.class);
+
+    private static final String MODEL_SCHEMA_NAME = "xml/apex-event.xsd";
+
+    // XML Unmarshaller and marshaller and object factory for events
+    private Unmarshaller unmarshaller;
+    private Marshaller marshaller;
+    private ObjectFactory objectFactory = new ObjectFactory();
+
+    /**
+     * Constructor to create the Apex to XML converter.
+     *
+     * @throws ApexEventException the apex event exception
+     */
+    public Apex2XMLEventConverter() throws ApexEventException {
+        try {
+            final URL schemaURL = ResourceUtils.getURLResource(MODEL_SCHEMA_NAME);
+            final Schema apexEventSchema =
+                    SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI).newSchema(schemaURL);
+
+            final JAXBContext jaxbContext = JAXBContext.newInstance(XMLApexEvent.class);
+
+            // Set up the unmarshaller to carry out validation
+            unmarshaller = jaxbContext.createUnmarshaller();
+            unmarshaller.setEventHandler(new javax.xml.bind.helpers.DefaultValidationEventHandler());
+            unmarshaller.setSchema(apexEventSchema);
+
+            // Set up the marshaller
+            marshaller = jaxbContext.createMarshaller();
+            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
+            marshaller.setSchema(apexEventSchema);
+        } catch (JAXBException | SAXException e) {
+            LOGGER.error("Unable to set up marshalling and unmarshalling for XML events", e);
+            throw new ApexEventException("Unable to set up marshalling and unmarshalling for XML events", e);
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see org.onap.policy.apex.service.engine.event.ApexEventProtocolConverter#init(org.onap.policy.apex.service.
+     * parameters. eventprotocol.EventProtocolParameters)
+     */
+    @Override
+    public void init(final EventProtocolParameters parameters) {}
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see org.onap.policy.apex.service.engine.event.ApexEventConverter#toApexEvent(java.lang.String, java.lang.Object)
+     */
+    @Override
+    public List<ApexEvent> toApexEvent(final String eventName, final Object eventObject) throws ApexEventException {
+        // Check the XML event
+        if (eventObject == null) {
+            LOGGER.warn("event processing failed, XML event is null");
+            throw new ApexEventException("event processing failed, XML event is null");
+        }
+
+        // Cast the event to a string, if our conversion is correctly configured, this cast should always work
+        String xmlEventString = null;
+        try {
+            xmlEventString = (String) eventObject;
+        } catch (final Exception e) {
+            final String errorMessage = "error converting event \"" + eventObject + "\" to a string";
+            LOGGER.debug(errorMessage, e);
+            throw new ApexEventRuntimeException(errorMessage, e);
+        }
+
+        // The XML event
+        XMLApexEvent xmlApexEvent = null;
+
+        // Use JAXB to read and verify the event from the XML string
+        try {
+            final StreamSource source = new StreamSource(new ByteArrayInputStream(xmlEventString.getBytes()));
+            final JAXBElement<XMLApexEvent> rootElement = unmarshaller.unmarshal(source, XMLApexEvent.class);
+            xmlApexEvent = rootElement.getValue();
+        } catch (final JAXBException e) {
+            LOGGER.warn("Unable to unmarshal Apex XML event\n" + xmlEventString, e);
+            throw new ApexEventException("Unable to unmarshal Apex XML event\n" + xmlEventString, e);
+        }
+
+        // Create the Apex event
+        final ApexEvent apexEvent = new ApexEvent(xmlApexEvent.getName(), xmlApexEvent.getVersion(),
+                xmlApexEvent.getNameSpace(), xmlApexEvent.getSource(), xmlApexEvent.getTarget());
+
+        // Set the data on the apex event
+        for (final XMLApexEventData xmlData : xmlApexEvent.getData()) {
+            apexEvent.put(xmlData.getKey(), xmlData.getValue());
+        }
+
+        // Return the event in a single element
+        final ArrayList<ApexEvent> eventList = new ArrayList<ApexEvent>();
+        eventList.add(apexEvent);
+        return eventList;
+    }
+
+    /*
+     * (non-Javadoc)
+     *
+     * @see
+     * org.onap.policy.apex.service.engine.event.ApexEventConverter#fromApexEvent(org.onap.policy.apex.service.engine.
+     * event. ApexEvent)
+     */
+    @Override
+    public String fromApexEvent(final ApexEvent apexEvent) throws ApexEventException {
+        // Check the Apex event
+        if (apexEvent == null) {
+            LOGGER.warn("event processing failed, Apex event is null");
+            throw new ApexEventException("event processing failed, Apex event is null");
+        }
+
+        // Get the Apex event data
+        final List<XMLApexEventData> xmlDataList = new ArrayList<XMLApexEventData>();
+
+        try {
+            for (final Entry<String, Object> apexDataEntry : apexEvent.entrySet()) {
+                // Add an XML event data item
+                if (apexDataEntry.getValue() != null) {
+                    xmlDataList.add(new XMLApexEventData(apexDataEntry.getKey(), apexDataEntry.getValue().toString()));
+                } else {
+                    xmlDataList.add(new XMLApexEventData(apexDataEntry.getKey(), ""));
+                }
+            }
+        } catch (final Exception e) {
+            LOGGER.warn("Unable to transfer Apex event data to XML\n" + apexEvent, e);
+            throw new ApexEventException("Unable to transfer Apex event data to XML\n" + apexEvent, e);
+        }
+
+        // Create the XML event
+        final XMLApexEvent xmlApexEvent = new XMLApexEvent(apexEvent.getName(), apexEvent.getVersion(),
+                apexEvent.getNameSpace(), apexEvent.getSource(), apexEvent.getTarget(), xmlDataList);
+
+        // Write the event into a DOM document
+        try {
+            // Marshal the event into XML
+            final StringWriter writer = new StringWriter();
+            marshaller.marshal(objectFactory.createXmlApexEvent(xmlApexEvent), writer);
+
+            // Return the event as XML in a string
+            return writer.toString();
+        } catch (final JAXBException e) {
+            LOGGER.warn("Unable to unmarshal Apex event to XML\n" + apexEvent, e);
+            throw new ApexEventException("Unable to unmarshal Apex event to XML\n" + apexEvent, e);
+        }
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/XMLEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/XMLEventProtocolParameters.java
new file mode 100644
index 000000000..e96a3f5d5
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/XMLEventProtocolParameters.java
@@ -0,0 +1,53 @@
+/*-
+ * ============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 org.onap.policy.apex.plugins.event.protocol.xml;
+
+import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextTokenDelimitedParameters;
+
+/**
+ * Event protocol parameters for XML as an event protocol.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+public class XMLEventProtocolParameters extends EventProtocolTextTokenDelimitedParameters {
+    /** The label of this carrier technology. */
+    public static final String XML_EVENT_PROTOCOL_LABEL = "XML";
+
+    // Constants for the text delimiter token
+    private static final String XML_TEXT_DELIMITER_TOKEN = "<?xml";
+
+    /**
+     * Constructor to create a JSON event protocol parameter instance and register the instance with the parameter
+     * service.
+     */
+    public XMLEventProtocolParameters() {
+        super(XMLEventProtocolParameters.class.getCanonicalName());
+
+        // Set the event protocol properties for the XML event protocol
+        this.setLabel(XML_EVENT_PROTOCOL_LABEL);
+
+        // Set the starting and ending delimiters for text blocks of XML events
+        this.setDelimiterToken(XML_TEXT_DELIMITER_TOKEN);
+
+        // Set the event protocol plugin class
+        this.setEventProtocolPluginClass(Apex2XMLEventConverter.class.getCanonicalName());
+    }
+}
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/package-info.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/package-info.java
new file mode 100644
index 000000000..4f972657f
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/java/org/onap/policy/apex/plugins/event/protocol/xml/package-info.java
@@ -0,0 +1,26 @@
+/*
+ * ============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=========================================================
+ */
+
+/**
+ * Contains the implementation of the APEX event protocol converter plugin for events in XML format.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+package org.onap.policy.apex.plugins.event.protocol.xml;
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xjb b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xjb
new file mode 100644
index 000000000..fa334c413
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xjb
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ============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=========================================================
+-->
+
+<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
+	xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:annox="http://annox.dev.java.net"
+	xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
+	version="2.1">
+
+	<!--jaxb:globalBindings generateIsSetMethod="true">
+		<xjc:serializable uid="1" />
+		<xjc:javaType name="java.lang.String" xmlType="xs:string"
+			adapter="org.onap.policy.apex.core.model.xml.StringTrimAdapter" />
+	</jaxb:globalBindings-->
+
+	<jaxb:bindings schemaLocation="apex-event.xsd" node="/xs:schema">
+		<jaxb:bindings node="xs:complexType[@name='XMLApexEvent']"> <annox:annotate> 
+			<annox:annotate annox:class="java.lang.SuppressWarnings" value="all" /> </annox:annotate> 
+			</jaxb:bindings>
+	</jaxb:bindings>
+</jaxb:bindings>
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xsd b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xsd
new file mode 100644
index 000000000..c8314550a
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-xml/src/main/resources/xml/apex-event.xsd
@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ============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=========================================================
+-->
+
+<schema targetNamespace="http://www.onap.org/policy/apex-pdp/apexevent" elementFormDefault="qualified"
+    xmlns="http://www.w3.org/2001/XMLSchema" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
+    xmlns:basic="http://jaxb2-commons.dev.java.net/basic"
+    xmlns:copyable="http://jaxb2-commons.dev.java.net/basic/copyable"
+    xmlns:equals="http://jaxb2-commons.dev.java.net/basic/equals"
+    xmlns:hashCode="http://jaxb2-commons.dev.java.net/basic/hashCode"
+    xmlns:mergeable="http://jaxb2-commons.dev.java.net/basic/mergeable"
+    xmlns:toString="http://jaxb2-commons.dev.java.net/basic/toString"
+    jaxb:extensionBindingPrefixes="xjc basic copyable equals hashCode mergeable toString"
+    xmlns:apexev="http://www.onap.org/policy/apex-pdp/apexevent" xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
+    jaxb:version="2.0">
+
+    <annotation>
+        <documentation>An event that comes into or is emitted out of an Apex system.
+        </documentation>
+    </annotation>
+
+    <annotation>
+        <appinfo>
+            <jaxb:globalBindings generateIsSetMethod="true">
+                <xjc:serializable uid="1" />
+            </jaxb:globalBindings>
+        </appinfo>
+    </annotation>
+
+    <complexType name="XMLApexEvent">
+        <annotation>
+            <documentation>An event that comes into or goes out of an Apex system</documentation>
+        </annotation>
+        <sequence>
+            <element name="name" maxOccurs="1" minOccurs="1">
+                <simpleType>
+                    <restriction base="string">
+                        <pattern value="[A-Za-z0-9\-_:]+"></pattern>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="version" maxOccurs="1" minOccurs="1">
+                <simpleType>
+                    <restriction base="string">
+                        <pattern value="[0-9.]+"></pattern>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="nameSpace" maxOccurs="1" minOccurs="1">
+                <simpleType>
+                    <restriction base="string">
+                        <minLength value="1"></minLength>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="source" maxOccurs="1" minOccurs="0">
+                <simpleType>
+                    <restriction base="string">
+                        <minLength value="0"></minLength>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="target" maxOccurs="1" minOccurs="0">
+                <simpleType>
+                    <restriction base="string">
+                        <minLength value="0"></minLength>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="data" type="apexev:XMLApexEventData" maxOccurs="unbounded" minOccurs="0">
+            </element>
+        </sequence>
+    </complexType>
+
+    <element name="xmlApexEvent" type="apexev:XMLApexEvent"></element>
+
+    <complexType name="XMLApexEventData">
+        <annotation>
+            <documentation>
+                A single data item of an Apex event.
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="key" maxOccurs="1" minOccurs="1">
+                <simpleType>
+                    <restriction base="string">
+                        <pattern value="[A-Za-z0-9\-_:]+"></pattern>
+                    </restriction>
+                </simpleType>
+            </element>
+            <element name="value" maxOccurs="1" minOccurs="1">
+                <simpleType>
+                    <restriction base="string">
+                        <minLength value="0"></minLength>
+                    </restriction>
+                </simpleType>
+            </element>
+        </sequence>
+    </complexType>
+
+
+</schema>