Package org.apache.camel.maven.packaging

Class PrepareCatalogMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.maven.packaging.PrepareCatalogMojo

All Implemented Interfaces:

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

@Mojo(name="prepare-catalog",
      threadSafe=true)
public class PrepareCatalogMojo
extends org.apache.maven.plugin.AbstractMojo

Prepares the camel catalog to include component, data format, and eip descriptors, and generates a report.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADOC
protected File	beansOutDir	The output directory for pojo beans catalog
protected File	componentsDir	The components directory where all the Apache Camel components are
protected File	componentsOutDir	The output directory for components catalog
protected File	consolesOutDir	The output directory for dev-consoles catalog
protected File	coreDir	The camel-core directory
protected File	dataFormatsOutDir	The output directory for dataformats catalog
protected File	dslDir	The DSL directory
protected File	languagesDir	The camel-core-languages directory
protected File	languagesOutDir	The output directory for languages catalog
protected File	mainDir	The directory where the camel-main metadata are
protected File	mainOutDir	The output directory for main
protected File	modelDir	The camel-model directory
protected File	modelsAppOutDir	The output directory for models-app catalog
protected File	modelsOutDir	The output directory for models catalog
protected File	othersOutDir	The output directory for others catalog
protected org.apache.maven.project.MavenProject	project	The maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper	Maven ProjectHelper.
protected File	schemasOutDir	The output directory for XML schemas catalog
static final String	SEPARATOR
protected boolean	skip	Skip the execution of this mojo
protected File	springDir	The directory where the camel-spring XML models are
protected File	springSchemaDir	The directory where the camel-spring XML schema are
static final String	SRC_GENERATED_RESOURCES
protected File	transformersOutDir	The output directory for transformers catalog
protected Boolean	validate	Whether to validate if the components, data formats, and languages are properly documented and have all the needed details.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PrepareCatalogMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute goal.
protected Set<String>	executeBeans()
protected Set<String>	executeComponents()
protected Set<String>	executeDataFormats()
protected Set<String>	executeDevConsoles()
protected void	executeDocuments(Set<String> components, Set<String> dataformats, Set<String> languages, Set<String> others)
protected Set<String>	executeLanguages()
protected void	executeMain()
protected void	executeModel()
protected void	executeModelApps()
protected Set<String>	executeTransformers()
protected void	executeXmlSchemas()

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 Details

SEPARATOR

public static final String SEPARATOR

See Also:

• Constant Field Values

ADOC

public static final String ADOC

See Also:

• Constant Field Values

SRC_GENERATED_RESOURCES

public static final String SRC_GENERATED_RESOURCES

See Also:

• Constant Field Values

project

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

The maven project.

validate

@Parameter(defaultValue="true")
protected Boolean validate

Whether to validate if the components, data formats, and languages are properly documented and have all the needed details.

componentsOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/components")
protected File componentsOutDir

The output directory for components catalog

dataFormatsOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/dataformats")
protected File dataFormatsOutDir

The output directory for dataformats catalog

languagesOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/languages")
protected File languagesOutDir

The output directory for languages catalog

transformersOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/transformers")
protected File transformersOutDir

The output directory for transformers catalog

beansOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/beans")
protected File beansOutDir

The output directory for pojo beans catalog

consolesOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/dev-consoles")
protected File consolesOutDir

The output directory for dev-consoles catalog

othersOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/others")
protected File othersOutDir

The output directory for others catalog

modelsOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/models")
protected File modelsOutDir

The output directory for models catalog

modelsAppOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/models-app")
protected File modelsAppOutDir

The output directory for models-app catalog

schemasOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/schemas")
protected File schemasOutDir

The output directory for XML schemas catalog

mainOutDir

@Parameter(defaultValue="${project.basedir}/src/generated/resources/org/apache/camel/catalog/main")
protected File mainOutDir

The output directory for main

componentsDir

@Parameter(defaultValue="${project.basedir}/../../components")
protected File componentsDir

The components directory where all the Apache Camel components are

coreDir

@Parameter(defaultValue="${project.basedir}/../../core/")
protected File coreDir

The camel-core directory

modelDir

@Parameter(defaultValue="${project.basedir}/../../core/camel-core-model")
protected File modelDir

The camel-model directory

dslDir

@Parameter(defaultValue="${project.basedir}/../../dsl")
protected File dslDir

The DSL directory

languagesDir

@Parameter(defaultValue="${project.basedir}/../../core/camel-core-languages")
protected File languagesDir

The camel-core-languages directory

springDir

@Parameter(defaultValue="${project.basedir}/../../components/camel-spring-xml")
protected File springDir

The directory where the camel-spring XML models are

springSchemaDir

@Parameter(defaultValue="${project.basedir}/../../components/camel-spring-xml/target/schema")
protected File springSchemaDir

The directory where the camel-spring XML schema are

mainDir

@Parameter(defaultValue="${project.basedir}/../../core/camel-main/target/classes/META-INF")
protected File mainDir

The directory where the camel-main metadata are

skip

@Parameter(defaultValue="false",
           property="camel.prepare-catalog.skip")
protected boolean skip

Skip the execution of this mojo

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

Maven ProjectHelper.

Constructor Details

PrepareCatalogMojo

public PrepareCatalogMojo()

Method Details

execute

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

Execute goal.

Throws:

org.apache.maven.plugin.MojoExecutionException - execution of the main class or one of the threads it generated failed.

org.apache.maven.plugin.MojoFailureException - something bad happened...

executeModel

protected void executeModel()
                     throws Exception

Throws:

Exception

executeModelApps

protected void executeModelApps()
                         throws Exception

Throws:

Exception

executeComponents

protected Set<String> executeComponents()
                                 throws Exception

Throws:

Exception

executeDataFormats

protected Set<String> executeDataFormats()
                                  throws Exception

Throws:

Exception

executeLanguages

protected Set<String> executeLanguages()
                                throws Exception

Throws:

Exception

executeTransformers

protected Set<String> executeTransformers()
                                   throws Exception

Throws:

Exception

executeBeans

protected Set<String> executeBeans()
                            throws Exception

Throws:

Exception

executeDevConsoles

protected Set<String> executeDevConsoles()
                                  throws Exception

Throws:

Exception

executeXmlSchemas

protected void executeXmlSchemas()
                          throws Exception

Throws:

Exception

executeMain

protected void executeMain()
                    throws Exception

Throws:

Exception

executeDocuments

protected void executeDocuments(Set<String> components,
 Set<String> dataformats,
 Set<String> languages,
 Set<String> others)