org.apache.maven.plugin.assembly.archive

Class DefaultAssemblyArchiver

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.plugin.assembly.archive.DefaultAssemblyArchiver

All Implemented Interfaces:

AssemblyArchiver, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

public class DefaultAssemblyArchiver
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements AssemblyArchiver, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Controller component designed to organize the many activities involved in creating an assembly archive. This includes locating and configuring Archiver instances, executing multiple AssemblyArchiverPhase instances to interpret the various sections of the assembly descriptor and determine which files to add, and other associated activities.

Version:

$Id: DefaultAssemblyArchiver.java 1002307 2010-09-28 18:13:44Z jdcasey $

Field Summary

Fields inherited from interface org.apache.maven.plugin.assembly.archive.AssemblyArchiver

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultAssemblyArchiver()
protected	DefaultAssemblyArchiver(org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, DependencyResolver resolver, java.util.List<AssemblyArchiverPhase> assemblyPhases)

Method Summary

Methods

Modifier and Type	Method and Description
void	contextualize(org.codehaus.plexus.context.Context context)
java.io.File	createArchive(Assembly assembly, java.lang.String fullName, java.lang.String format, AssemblerConfigurationSource configSource) Create the assembly archive.
protected org.codehaus.plexus.archiver.Archiver	createArchiver(java.lang.String format, boolean includeBaseDir, java.lang.String finalName, AssemblerConfigurationSource configSource, java.util.List<ContainerDescriptorHandler> containerHandlers) Creates the necessary archiver to build the distribution file.
protected org.codehaus.plexus.archiver.Archiver	createTarArchiver(java.lang.String format, java.lang.String tarLongFileMode)
protected org.codehaus.plexus.archiver.Archiver	createWarArchiver()
protected void	setContainer(org.codehaus.plexus.PlexusContainer container)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAssemblyArchiver

public DefaultAssemblyArchiver()

DefaultAssemblyArchiver

protected DefaultAssemblyArchiver(org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
                       DependencyResolver resolver,
                       java.util.List<AssemblyArchiverPhase> assemblyPhases)

Method Detail

createArchive

public java.io.File createArchive(Assembly assembly,
                         java.lang.String fullName,
                         java.lang.String format,
                         AssemblerConfigurationSource configSource)
                           throws ArchiveCreationException,
                                  AssemblyFormattingException,
                                  InvalidAssemblerConfigurationException

Create the assembly archive. Generally:

1. Setup any directory structures for temporary files
2. Calculate the output directory/file for the assembly
3. Setup any handler components for special descriptor files we may encounter
4. Lookup and configure the Archiver to be used
5. Determine what, if any, dependency resolution will be required, and resolve any dependency-version conflicts up front to produce a managed-version map for the whole assembly process.
6. Iterate through the available AssemblyArchiverPhase instances, executing each to handle a different top-level section of the assembly descriptor, if that section is present.

Specified by:

createArchive in interface AssemblyArchiver

Throws:

ArchiveCreationException

AssemblyFormattingException

InvalidAssemblerConfigurationException

createArchiver

protected org.codehaus.plexus.archiver.Archiver createArchiver(java.lang.String format,
                                                   boolean includeBaseDir,
                                                   java.lang.String finalName,
                                                   AssemblerConfigurationSource configSource,
                                                   java.util.List<ContainerDescriptorHandler> containerHandlers)
                                                        throws org.codehaus.plexus.archiver.ArchiverException,
                                                               org.codehaus.plexus.archiver.manager.NoSuchArchiverException

Creates the necessary archiver to build the distribution file.

Parameters:

format - Archive format

includeBaseDir -

finalName -

configSource -

containerHandlers -

Returns:

archiver Archiver generated

Throws:

org.codehaus.plexus.archiver.ArchiverException

org.codehaus.plexus.archiver.manager.NoSuchArchiverException

createWarArchiver

protected org.codehaus.plexus.archiver.Archiver createWarArchiver()
                                                           throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException

Throws:

org.codehaus.plexus.archiver.manager.NoSuchArchiverException

createTarArchiver

protected org.codehaus.plexus.archiver.Archiver createTarArchiver(java.lang.String format,
                                                      java.lang.String tarLongFileMode)
                                                           throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException,
                                                                  org.codehaus.plexus.archiver.ArchiverException

Throws:

org.codehaus.plexus.archiver.manager.NoSuchArchiverException

org.codehaus.plexus.archiver.ArchiverException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

setContainer

protected void setContainer(org.codehaus.plexus.PlexusContainer container)