org.apache.maven.plugin.assembly
Class AbstractAssemblyMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.assembly.AbstractUnpackingMojo
          org.apache.maven.plugin.assembly.AbstractAssemblyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDirectoryMojo, AssemblyMojo, AttachedAssemblyMojo, SingleAssemblyMojo

public abstract class AbstractAssemblyMojo
extends AbstractUnpackingMojo

Version:

$Id: AbstractAssemblyMojo.java 405468 2006-05-09 16:56:36Z dantran $

Author:

Brett Porter, Vincent Siveton

Field Summary

protected boolean	appendAssemblyId Set to false to exclude the assembly id from the assembly final name.
protected java.io.File	descriptor Deprecated. Please use descriptors instead
protected java.lang.String	descriptorId Deprecated. Please use descriptorRefs instead
protected java.util.List	filters

Fields inherited from class org.apache.maven.plugin.assembly.AbstractUnpackingMojo

archiverManager, artifactResolver, classifier, EMPTY_STRING_ARRAY, finalName, localRepository, outputDirectory, project, reactorProjects, workDirectory

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

ROLE

Constructor Summary

AbstractAssemblyMojo()

Method Summary

protected java.io.File	createArchive(org.codehaus.plexus.archiver.Archiver archiver, Assembly assembly, java.lang.String filename)
void	execute() Create the binary distribution.
protected java.lang.String	getDistributionName(Assembly assembly) Get the full name of the distribution artifact
protected void	processDependencySets(org.codehaus.plexus.archiver.Archiver archiver, java.util.List dependencySets, boolean includeBaseDirectory) Processes Dependency Sets
protected void	processFileList(org.codehaus.plexus.archiver.Archiver archiver, java.util.List fileList, boolean includeBaseDirecetory) Copy files to the distribution with option to change destination name
protected void	processFileSets(org.codehaus.plexus.archiver.Archiver archiver, java.util.List fileSets, boolean includeBaseDirecetory) Process Files that will be included in the distribution.
protected java.util.List	readAssemblies()

Methods inherited from class org.apache.maven.plugin.assembly.AbstractUnpackingMojo

getClassifier, getDependencies, getExecutedProject, unpack

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

descriptorId

protected java.lang.String descriptorId

Deprecated. Please use descriptorRefs instead

Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.

descriptor

protected java.io.File descriptor

Deprecated. Please use descriptors instead

Assembly XML Descriptor file. This must be the path to your customized descriptor file.

appendAssemblyId

protected boolean appendAssemblyId

Set to false to exclude the assembly id from the assembly final name.

filters

protected java.util.List filters

Constructor Detail

AbstractAssemblyMojo

public AbstractAssemblyMojo()

Method Detail

execute

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

Create the binary distribution.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDistributionName

protected java.lang.String getDistributionName(Assembly assembly)

Get the full name of the distribution artifact

Parameters:

assembly -

Returns:

the distribution name

createArchive

protected java.io.File createArchive(org.codehaus.plexus.archiver.Archiver archiver,
                                     Assembly assembly,
                                     java.lang.String filename)
                              throws org.apache.maven.plugin.MojoExecutionException,
                                     org.apache.maven.plugin.MojoFailureException,
                                     java.io.IOException,
                                     org.codehaus.plexus.archiver.ArchiverException,
                                     RepositoryAssemblyException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

java.io.IOException

org.codehaus.plexus.archiver.ArchiverException

RepositoryAssemblyException

readAssemblies

protected java.util.List readAssemblies()
                                 throws org.apache.maven.plugin.MojoFailureException,
                                        org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

processDependencySets

protected void processDependencySets(org.codehaus.plexus.archiver.Archiver archiver,
                                     java.util.List dependencySets,
                                     boolean includeBaseDirectory)
                              throws org.apache.maven.plugin.MojoExecutionException

Processes Dependency Sets

Parameters:

archiver -

dependencySets -

includeBaseDirectory -

Throws:

org.apache.maven.plugin.MojoExecutionException

processFileSets

protected void processFileSets(org.codehaus.plexus.archiver.Archiver archiver,
                               java.util.List fileSets,
                               boolean includeBaseDirecetory)
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Process Files that will be included in the distribution.

Parameters:

archiver -

fileSets -

includeBaseDirecetory -

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processFileList

protected void processFileList(org.codehaus.plexus.archiver.Archiver archiver,
                               java.util.List fileList,
                               boolean includeBaseDirecetory)
                        throws org.apache.maven.plugin.MojoExecutionException,
                               org.apache.maven.plugin.MojoFailureException

Copy files to the distribution with option to change destination name

Parameters:

archiver -

fileList -

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException