org.apache.maven.plugin.assembly
Class AssemblyMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DirectoryMojo

public class AssemblyMojo
extends AbstractUnpackingMojo

Assemble an application bundle or distribution from an assembly descriptor.

Version:

$Id: AssemblyMojo.java 314779 2005-10-12 04:37:55Z brett $

Author:

Brett Porter, Vincent Siveton

Field Summary

protected java.io.File	descriptor Assembly XML Descriptor file.
protected java.lang.String	descriptorId Predefined Assembly Descriptor Id's.

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

archiverManager, dependencies, EMPTY_STRING_ARRAY, finalName, outputDirectory, workDirectory

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

ROLE

Constructor Summary

AssemblyMojo()

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 void	processDependencySets(org.codehaus.plexus.archiver.Archiver archiver, java.util.List dependencySets, boolean includeBaseDirectory) Processes Dependency Sets
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 Assembly	readAssembly()

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

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

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

descriptor

protected java.io.File descriptor

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

Constructor Detail

AssemblyMojo

public AssemblyMojo()

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

createArchive

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

Throws:

org.codehaus.plexus.archiver.ArchiverException

java.io.IOException

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

readAssembly

protected Assembly readAssembly()
                         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.codehaus.plexus.archiver.ArchiverException,
                                     java.io.IOException,
                                     org.apache.maven.plugin.MojoExecutionException,
                                     org.apache.maven.plugin.MojoFailureException

Processes Dependency Sets

Parameters:

archiver -

dependencySets -

includeBaseDirectory -

Throws:

org.codehaus.plexus.archiver.ArchiverException

java.io.IOException

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processFileSets

protected void processFileSets(org.codehaus.plexus.archiver.Archiver archiver,
                               java.util.List fileSets,
                               boolean includeBaseDirecetory)
                        throws org.codehaus.plexus.archiver.ArchiverException

Process Files that will be included in the distribution.

Parameters:

archiver -

fileSets -

includeBaseDirecetory -

Throws:

org.codehaus.plexus.archiver.ArchiverException