org.mule.plugin.maven

Class AbstractPackagePluginMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.plugin.maven.AbstractMuleMojo

org.mule.plugin.maven.AbstractPackagePluginMojo

All Implemented Interfaces:

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

public abstract class AbstractPackagePluginMojo
extends AbstractMuleMojo

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULE_PLUGIN_CLASSIFIER

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

appDirectory, finalName, META_INF, 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
AbstractPackagePluginMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addArtifactProperties(ModuleArchiver moduleArchiver)
protected void	addClasses(ModuleArchiver archiver) Adds the complete structure under AbstractMuleMojo.outputDirectory/CLASSES to the archiver
protected void	addDependencies(ModuleArchiver archiver)
protected void	addPOMFile(ModuleArchiver archiver) Adds the pom file for this project into META-INF/maven/${groupId}/${artifactId}/.
protected void	addToArchiver(ModuleArchiver archiver)
protected void	createMulePlugin(File plugin)
protected abstract void	doAddArtifactProperties(File pluginPropertiesFile)
protected void	doExecute() Method to give the capability of contribute with the {@link AbstractPackagePluginMojo#execute()
void	execute()
protected String	getArtifactClassifier()
protected Set<String>	getPluginDependencies()
protected void	initialize() Method to give the capability of initialize implementations of this class as the first action of the execute()
protected void	walkWhileCopyingFolder(ModuleArchiver archiver, String destination, Path startPath) Copies the complete files encountered in AbstractMuleMojo.outputDirectory/folder, into the current archiver

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

MULE_PLUGIN_CLASSIFIER

public static final String MULE_PLUGIN_CLASSIFIER

See Also:

Constant Field Values

Constructor Detail

AbstractPackagePluginMojo

public AbstractPackagePluginMojo()

Method Detail

doAddArtifactProperties

protected abstract void doAddArtifactProperties(File pluginPropertiesFile)
                                         throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getArtifactClassifier

protected String getArtifactClassifier()

createMulePlugin

protected void createMulePlugin(File plugin)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException,
                                org.codehaus.plexus.archiver.ArchiverException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

org.codehaus.plexus.archiver.ArchiverException

addToArchiver

protected void addToArchiver(ModuleArchiver archiver)
                      throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addPOMFile

protected void addPOMFile(ModuleArchiver archiver)

Adds the pom file for this project into META-INF/maven/${groupId}/${artifactId}/.

Parameters:

archiver - to store the current dependency file

addArtifactProperties

protected void addArtifactProperties(ModuleArchiver moduleArchiver)
                              throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

addDependencies

protected void addDependencies(ModuleArchiver archiver)
                        throws org.codehaus.plexus.archiver.ArchiverException

Throws:

org.codehaus.plexus.archiver.ArchiverException

getPluginDependencies

protected Set<String> getPluginDependencies()

initialize

protected void initialize()
                   throws org.apache.maven.plugin.MojoFailureException,
                          org.apache.maven.plugin.MojoExecutionException

Method to give the capability of initialize implementations of this class as the first action of the execute()

Throws:

org.apache.maven.plugin.MojoFailureException - when an initialization failure occurs

org.apache.maven.plugin.MojoExecutionException - when an initialization error occurs

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoFailureException,
                         org.apache.maven.plugin.MojoExecutionException

Method to give the capability of contribute with the {@link AbstractPackagePluginMojo#execute()

Throws:

org.apache.maven.plugin.MojoFailureException - when an execution failure occurs

org.apache.maven.plugin.MojoExecutionException - when an execution error occurs

walkWhileCopyingFolder

protected void walkWhileCopyingFolder(ModuleArchiver archiver,
                                      String destination,
                                      Path startPath)

Copies the complete files encountered in AbstractMuleMojo.outputDirectory/folder, into the current archiver

Parameters:

archiver - to store all dependencies

destination - folder in which all found files will be stored inside of the archive file

startPath - path to introspect

Throws:

org.apache.maven.plugin.MojoFailureException - if there's an issue while working with the files under AbstractMuleMojo.outputDirectory/folder

addClasses

protected void addClasses(ModuleArchiver archiver)

Adds the complete structure under AbstractMuleMojo.outputDirectory/CLASSES to the archiver

Parameters:

archiver - to store the CLASSES structure