org.mule.extension.maven

Class ExtensionDescriptorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.plugin.maven.AbstractMuleMojo

org.mule.extension.maven.ExtensionDescriptorMojo

All Implemented Interfaces:

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

@Mojo(name="extension-descriptor",
      defaultPhase=COMPILE,
      threadSafe=true)
public class ExtensionDescriptorMojo
extends AbstractMuleMojo

Mojo responsible of looking for an existing AbstractMuleMojo.MULE_ARTIFACT_JSON in META-INF folder.

If it doesn't exists, it assumes it's a scenario, to which it will try to generate one with the following conventions:

1. Will scan the /classes looking for anything that starts with PREFIX_SMART_CONNECTOR_NAME and ends with SUFFIX_SMART_CONNECTOR_NAME
2. For each element found, it will open it and look if they are valid XML files and their root elements matches to MODULE_ROOT_ELEMENT
3. There must be one, and only one, file in the /classes that match the previous rules. If not, fails.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_XML
static String	SNAPSHOT_SUFFIX
static String	VALIDATE_XML
static String	XML_BASED_EXTENSION_MODEL_LOADER

Fields inherited from class org.mule.plugin.maven.AbstractMuleMojo

appDirectory, finalName, MULE_ARTIFACT, MULE_ARTIFACT_JSON, MULE_ARTIFACT_TYPE, MULE_PLUGIN_JSON_JAR_DESTINATION, outputDirectory, project, RESERVED_DESTINATION_REPOSITORY, RESERVED_FOLDER_MULE_ARTIFACT

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ExtensionDescriptorMojo()

Method Summary

Modifier and Type	Method and Description
static Path	autoGeneratedDescriptorPath(File outputDirectory) Returns a Path to an auto generated descriptor.
static Path	descriptorPathOrFail(File outputDirectory) Returns a Path to an existing descriptor file or fails.
void	execute()

Methods inherited from class org.mule.plugin.maven.AbstractMuleMojo

getMuleArtifactFile

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

XML_BASED_EXTENSION_MODEL_LOADER

public static final String XML_BASED_EXTENSION_MODEL_LOADER

See Also:

Constant Field Values

RESOURCE_XML

public static final String RESOURCE_XML

See Also:

Constant Field Values

VALIDATE_XML

public static final String VALIDATE_XML

See Also:

Constant Field Values

SNAPSHOT_SUFFIX

public static final String SNAPSHOT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ExtensionDescriptorMojo

public ExtensionDescriptorMojo()

Method Detail

descriptorPathOrFail

public static Path descriptorPathOrFail(File outputDirectory)
                                 throws org.apache.maven.plugin.MojoFailureException

Returns a Path to an existing descriptor file or fails.

Parameters:

outputDirectory - to look for the current output directory

Returns:

an existing Path to a descriptor file

Throws:

org.apache.maven.plugin.MojoFailureException - if the descriptor file is absent (probably because this Mojo hasn't been executed)

autoGeneratedDescriptorPath

public static Path autoGeneratedDescriptorPath(File outputDirectory)
                                        throws org.apache.maven.plugin.MojoFailureException

Returns a Path to an auto generated descriptor.

Parameters:

outputDirectory - to look for the current output directory

Returns:

an existing Path to a descriptor

Throws:

org.apache.maven.plugin.MojoFailureException

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