org.apache.camel.maven

Class EipDocumentationEnricherMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.EipDocumentationEnricherMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="eip-documentation-enricher",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=PREPARE_PACKAGE)
public class EipDocumentationEnricherMojo
extends org.apache.maven.plugin.AbstractMojo

Injects EIP documentation to camel schema.

Field Summary

Fields

Modifier and Type	Field and Description
File	camelCoreDir Path to camel core-engine project root directory.
File	camelCoreXmlDir Path to camel core xml project root directory.
File	camelSpringDir Path to camel spring project root directory.
String	deleteFilesAfterRun Optional file pattern to delete files after the documentation enrichment is complete.
File	inputCamelSchemaFile Path to camel EIP schema.
File	outputCamelSchemaFile Path to camel EIP schema with enriched documentation.
String	pathToCoreXmlModelDir Sub path from camel core xml directory to model directory with generated json files for components.
String	pathToModelDir Sub path from camel core directory to model directory with generated json files for components.
String	pathToSpringModelDir Sub path from camel spring directory to model directory with generated json files for components.
protected org.apache.maven.project.MavenProject	project The maven project.
String	targetDir Sub path to itself

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
EipDocumentationEnricherMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inputCamelSchemaFile

@Parameter(required=true)
public File inputCamelSchemaFile

Path to camel EIP schema.

outputCamelSchemaFile

@Parameter(required=true)
public File outputCamelSchemaFile

Path to camel EIP schema with enriched documentation.

camelCoreDir

@Parameter(defaultValue="${project.build.directory}/sources/camel-core-engine")
public File camelCoreDir

Path to camel core-engine project root directory.

camelCoreXmlDir

@Parameter(defaultValue="${project.build.directory}/sources/camel-core-xml")
public File camelCoreXmlDir

Path to camel core xml project root directory.

camelSpringDir

@Parameter(defaultValue="${project.build.directory}/sources/camel-spring")
public File camelSpringDir

Path to camel spring project root directory.

targetDir

@Parameter(defaultValue="${project.build.directory}/classes")
public String targetDir

Sub path to itself

pathToModelDir

@Parameter(defaultValue="org/apache/camel/model")
public String pathToModelDir

Sub path from camel core directory to model directory with generated json files for components.

pathToCoreXmlModelDir

@Parameter(defaultValue="org/apache/camel/core/xml")
public String pathToCoreXmlModelDir

Sub path from camel core xml directory to model directory with generated json files for components.

pathToSpringModelDir

@Parameter(defaultValue="org/apache/camel/spring")
public String pathToSpringModelDir

Sub path from camel spring directory to model directory with generated json files for components.

deleteFilesAfterRun

@Parameter
public String deleteFilesAfterRun

Optional file pattern to delete files after the documentation enrichment is complete.

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The maven project.

Constructor Detail

EipDocumentationEnricherMojo

public EipDocumentationEnricherMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException