org.apache.maven.plugin.assembly.archive
Interface AssemblyArchiver

All Known Implementing Classes:

DefaultAssemblyArchiver

public interface AssemblyArchiver

Creates an archive

Version:

$Id: AssemblyArchiver.java 1641677 2014-11-25 19:44:07Z krosenvold $

ROLE

static final String ROLE

createArchive

File createArchive(Assembly assembly,
                   String fullName,
                   String format,
                   AssemblerConfigurationSource configSource,
                   boolean recompressZippedFiles)
                   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.

Parameters:

assembly - The Assembly

fullName - The full name.

format - The format.

configSource - The AssemblerConfigurationSource

recompressZippedFiles - recompress zipped files.

Returns:

The resulting archive file.

Throws:

ArchiveCreationException - when creation fails

AssemblyFormattingException - when formatting fails

InvalidAssemblerConfigurationException - when the configurationis bad