org.apache.camel.maven.EipDocumentationEnricherMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-eip-documentation-enricher-maven-plugin Show documentation
Show all versions of camel-eip-documentation-enricher-maven-plugin Show documentation
Adds documentation to camel xsd schema
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.camel.maven;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathExpressionException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.apache.camel.util.FileUtil;
import org.apache.commons.lang.StringUtils;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
/**
* Injects EIP documentation to camel schema.
*/
@Mojo(name = "eip-documentation-enricher", requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
defaultPhase = LifecyclePhase.PREPARE_PACKAGE)
public class EipDocumentationEnricherMojo extends AbstractMojo {
/**
* Path to camel EIP schema.
*/
@Parameter(required = true)
public File inputCamelSchemaFile;
/**
* Path to camel EIP schema with enriched documentation.
*/
@Parameter(required = true)
public File outputCamelSchemaFile;
/**
* Path to camel core project root directory.
*/
@Parameter(defaultValue = "${project.build.directory}/../../../camel-core")
public File camelCoreDir;
/**
* Path to camel core xml project root directory.
*/
@Parameter(defaultValue = "${project.build.directory}/../../../components/camel-core-xml")
public File camelCoreXmlDir;
/**
* Path to camel spring project root directory.
*/
@Parameter(defaultValue = "${project.build.directory}/../../../components/camel-spring")
public File camelSpringDir;
/**
* Sub path from camel core directory to model directory with generated json files for components.
*/
@Parameter(defaultValue = "target/classes/org/apache/camel/model")
public String pathToModelDir;
/**
* Sub path from camel core xml directory to model directory with generated json files for components.
*/
@Parameter(defaultValue = "target/classes/org/apache/camel/core/xml")
public String pathToCoreXmlModelDir;
/**
* Sub path from camel spring directory to model directory with generated json files for components.
*/
@Parameter(defaultValue = "target/classes/org/apache/camel/spring")
public String pathToSpringModelDir;
/**
* Optional file pattern to delete files after the documentation enrichment is complete.
*/
@Parameter
public String deleteFilesAfterRun;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (pathToModelDir == null) {
throw new MojoExecutionException("pathToModelDir parameter must not be null");
}
// skip if input file does not exists
if (inputCamelSchemaFile == null || !inputCamelSchemaFile.exists()) {
getLog().info("Input Camel schema file: " + inputCamelSchemaFile + " does not exist. Skip EIP document enrichment");
return;
}
validateExists(inputCamelSchemaFile, "inputCamelSchemaFile");
validateIsFile(inputCamelSchemaFile, "inputCamelSchemaFile");
validateExists(camelCoreDir, "camelCoreDir");
validateExists(camelCoreXmlDir, "camelCoreXmlDir");
validateExists(camelSpringDir, "camelSpringDir");
validateIsDirectory(camelCoreDir, "camelCoreDir");
validateIsDirectory(camelCoreXmlDir, "camelCoreXmlDir");
validateIsDirectory(camelSpringDir, "camelSpringDir");
try {
runPlugin();
} catch (Exception e) {
throw new MojoExecutionException("Error during plugin execution", e);
}
if (deleteFilesAfterRun != null) {
deleteFilesAfterDone(deleteFilesAfterRun);
}
}
private void runPlugin() throws Exception {
Document document = XmlHelper.buildNamespaceAwareDocument(inputCamelSchemaFile);
XPath xPath = XmlHelper.buildXPath(new CamelSpringNamespace());
DomFinder domFinder = new DomFinder(document, xPath);
DocumentationEnricher documentationEnricher = new DocumentationEnricher(document);
// include schema files from camel-core, camel-corem-xml and from camel-spring
File rootDir = new File(camelCoreDir, pathToModelDir);
Map jsonFiles = PackageHelper.findJsonFiles(rootDir);
File rootDir2 = new File(camelCoreXmlDir, pathToCoreXmlModelDir);
Map jsonFiles2 = PackageHelper.findJsonFiles(rootDir2);
File rootDir3 = new File(camelSpringDir, pathToSpringModelDir);
Map jsonFiles3 = PackageHelper.findJsonFiles(rootDir3);
// merge the json files together
jsonFiles.putAll(jsonFiles2);
jsonFiles.putAll(jsonFiles3);
NodeList elementsAndTypes = domFinder.findElementsAndTypes();
documentationEnricher.enrichTopLevelElementsDocumentation(elementsAndTypes, jsonFiles);
Map typeToNameMap = buildTypeToNameMap(elementsAndTypes);
Set injectedTypes = new LinkedHashSet();
getLog().info("Found " + typeToNameMap.size() + " models to use when enriching the XSD schema");
for (Map.Entry entry : typeToNameMap.entrySet()) {
String elementType = entry.getKey();
String elementName = entry.getValue();
if (jsonFileExistsForElement(jsonFiles, elementName)) {
getLog().debug("Enriching " + elementName);
File file = jsonFiles.get(elementName);
injectAttributesDocumentation(domFinder, documentationEnricher, file, elementType, injectedTypes);
}
}
saveToFile(document, outputCamelSchemaFile, XmlHelper.buildTransformer());
}
private boolean jsonFileExistsForElement(Map jsonFiles,
String elementName) {
return jsonFiles.containsKey(elementName);
}
private void deleteFilesAfterDone(String deleteFiles) {
String[] names = deleteFiles.split(",");
for (String name : names) {
File file = new File(name);
FileUtil.deleteFile(file);
}
}
/**
* Recursively injects documentation to complex type attributes and it's parents.
*/
private void injectAttributesDocumentation(DomFinder domFinder,
DocumentationEnricher documentationEnricher,
File jsonFile,
String type,
Set injectedTypes) throws XPathExpressionException, IOException {
if (injectedTypes.contains(type)) {
return;
}
injectedTypes.add(type);
NodeList attributeElements = domFinder.findAttributesElements(type);
if (attributeElements.getLength() > 0) {
documentationEnricher.enrichTypeAttributesDocumentation(getLog(), attributeElements, jsonFile);
}
String baseType = domFinder.findBaseType(type);
if (baseType != null && !StringUtils.isEmpty(baseType)) {
baseType = truncateTypeNamespace(baseType);
injectAttributesDocumentation(domFinder, documentationEnricher, jsonFile, baseType, injectedTypes);
}
}
private Map buildTypeToNameMap(NodeList elementsAndTypes) {
Map typeToNameMap = new LinkedHashMap();
for (int i = 0; i < elementsAndTypes.getLength(); i++) {
Element item = (Element) elementsAndTypes.item(i);
String name = item.getAttribute(Constants.NAME_ATTRIBUTE_NAME);
String type = item.getAttribute(Constants.TYPE_ATTRIBUTE_NAME);
if (name != null && type != null) {
type = truncateTypeNamespace(type);
if (getLog().isDebugEnabled()) {
getLog().debug(String.format("Putting attributes type:'%s', name:'%s'", name, type));
}
typeToNameMap.put(type, name);
}
}
return typeToNameMap;
}
private String truncateTypeNamespace(String baseType) {
return baseType.replaceAll("tns:", "");
}
private void saveToFile(Document document, File outputFile, Transformer transformer) throws FileNotFoundException, TransformerException {
StreamResult result = new StreamResult(new FileOutputStream(outputFile));
DOMSource source = new DOMSource(document);
transformer.transform(source, result);
}
private void validateIsFile(File file, String name) throws MojoExecutionException {
if (!file.isFile()) {
throw new MojoExecutionException(name + "is not a file");
}
}
private void validateIsDirectory(File file, String name) throws MojoExecutionException {
if (!file.isDirectory()) {
throw new MojoExecutionException(name + "is not a directory");
}
}
private void validateExists(File file, String name) throws MojoExecutionException {
if (file == null || !file.exists()) {
throw new MojoExecutionException(name + " does not exist");
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy