de.viadee.bpm.vPAV.output.XmlOutputWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of viadeeProcessApplicationValidator Show documentation

The tool checks Camunda projects for consistency and discovers errors in process-driven applications. Called as a Maven plugin or JUnit test, it discovers esp. inconsistencies of a given BPMN model in the classpath and the sourcecode of an underlying java project, such as a delegate reference to a non-existing java class or a non-existing Spring bean.

There is a newer version: 3.0.8

Show newest version

/**
 * BSD 3-Clause License
 *
 * Copyright © 2019, viadee Unternehmensberatung AG
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package de.viadee.bpm.vPAV.output;

import de.viadee.bpm.vPAV.constants.BpmnConstants;
import de.viadee.bpm.vPAV.constants.ConfigConstants;
import de.viadee.bpm.vPAV.processing.code.flow.BpmnElement;
import de.viadee.bpm.vPAV.processing.model.data.CheckerIssue;
import de.viadee.bpm.vPAV.processing.model.graph.Path;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.*;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * Ergebnisse aus dem Checker in ein definiertes XML-Format schreiben
 *
 */
public class XmlOutputWriter implements IssueOutputWriter {

    /**
     * Writes the result as XML to the vPAV output folder
     *
     * @param issues
     *            Contains the list of found issues
     * @throws OutputWriterException
     *             Occurs if output can not be written
     */
    @Override
    public void write(final Collection issues) throws OutputWriterException {

        Writer writer = null;
        try {
            writer = new BufferedWriter(new OutputStreamWriter(
                    new FileOutputStream(ConfigConstants.VALIDATION_XML_OUTPUT), "utf-8"));
            final JAXBContext context = JAXBContext.newInstance(XmlCheckerIssues.class);
            final Marshaller m = context.createMarshaller();
            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
            m.marshal(transformToXmlDatastructure(issues), writer);
        } catch (final UnsupportedEncodingException e) {
            throw new OutputWriterException("unsupported encoding");
        } catch (final FileNotFoundException e) {
            throw new OutputWriterException("output file couldn't be generated");
        } catch (final JAXBException e) {
            throw new OutputWriterException("xml output couldn't be generated (jaxb-error)");
        } finally {
            try {
                writer.close();
            } catch (Exception ex) {
                /* ignore */}
        }
    }

    /**
     * Transforms the given issues into XML datastructure
     *
     * @param issues
     * @return
     */
    private static XmlCheckerIssues transformToXmlDatastructure(
            final Collection issues) {
        XmlCheckerIssues xmlIssues = new XmlCheckerIssues();
        for (final CheckerIssue issue : issues) {
            final List xmlPaths = new ArrayList();
            final List invalidPaths = issue.getInvalidPaths();
            if (invalidPaths != null) {
                for (final Path path : invalidPaths) {
                    List elements = path.getElements();
                    List pathElements = new ArrayList();
                    for (final BpmnElement element : elements) {
                        String elementName = element.getBaseElement().getAttributeValue(BpmnConstants.ATTR_NAME);
                        if (elementName != null) {
                            // filter newlines
                            elementName = elementName.replace("\n", "");
                        }
                        pathElements.add(new XmlPathElement(element.getBaseElement().getId(), elementName));
                    }
                    xmlPaths.add(new XmlPath(pathElements));
                }
            }
            final String elementName = issue.getElementName();
            xmlIssues.addIssue(new XmlCheckerIssue(issue.getId(), issue.getRuleName(), issue.getRuleDescription(),
                    issue.getClassification().name(), issue.getBpmnFile(), issue.getResourceFile(),
                    issue.getElementId(), elementName == null ? null : elementName.replace("\n", ""),
                    issue.getMessage(), issue.getElementDescription(), issue.getVariable(),
                    issue.getAnomaly() == null ? null : issue.getAnomaly().getDescription(),
                    xmlPaths.isEmpty() ? null : xmlPaths));
        }
        return xmlIssues;
    }
}