DefaultAssemblyArchiver (Apache Maven Assembly Plugin 3.0.0 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.plugins.assembly.archive.DefaultAssemblyArchiver

All Implemented Interfaces:

AssemblyArchiver, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
```
@Component(role=AssemblyArchiver.class,
           instantiationStrategy="per-lookup")
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 .archive.phase.AssemblyArchiverPhase instances to interpret the various sections of the assembly descriptor and determine which files to add, and other associated activities.

Version:

$Id: DefaultAssemblyArchiver.html 1000516 2016-11-05 01:04:48Z olamy $

Field Summary
- Fields inherited from interface org.apache.maven.plugins.assembly.archive.AssemblyArchiver
  ROLE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DefaultAssemblyArchiver()`
`protected`	`DefaultAssemblyArchiver(ArchiverManager archiverManager, List<AssemblyArchiverPhase> assemblyPhases)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`contextualize(org.codehaus.plexus.context.Context context)`
`File`	`createArchive(Assembly assembly, String fullName, String format, AssemblerConfigurationSource configSource, boolean recompressZippedFiles, String mergeManifestMode)` Create the assembly archive.
`protected Archiver`	`createArchiver(String format, boolean includeBaseDir, String finalName, AssemblerConfigurationSource configSource, List<ContainerDescriptorHandler> containerHandlers, boolean recompressZippedFiles, String mergeManifestMode)` Creates the necessary archiver to build the distribution file.
`protected Archiver`	`createTarArchiver(String format, TarLongFileMode tarLongFileMode)`
`protected 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(ArchiverManager archiverManager,
                       List<AssemblyArchiverPhase> assemblyPhases)
```
    Parameters:
    archiverManager - The archive manager.
    assemblyPhases - The list of AssemblyArchiverPhase
- Method Detail
  - createArchive
```
public File createArchive(Assembly assembly,
                 String fullName,
                 String format,
                 AssemblerConfigurationSource configSource,
                 boolean recompressZippedFiles,
                 String mergeManifestMode)
                   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
    
    Parameters:
    assembly - The Assembly
    fullName - The full name.
    format - The format.
    configSource - The AssemblerConfigurationSource
    recompressZippedFiles - recompress zipped files.
    mergeManifestMode - How to handle already existing Manifest files (skip, merge, mergewithoutmain)
    
    Returns:
    The resulting archive file.
    
    Throws:
    
    ArchiveCreationException - when creation fails
    
    AssemblyFormattingException - when formatting fails
    
    InvalidAssemblerConfigurationException - when the configurationis bad
  - createArchiver
```
protected Archiver createArchiver(String format,
                      boolean includeBaseDir,
                      String finalName,
                      AssemblerConfigurationSource configSource,
                      List<ContainerDescriptorHandler> containerHandlers,
                      boolean recompressZippedFiles,
                      String mergeManifestMode)
                           throws NoSuchArchiverException
```
    Creates the necessary archiver to build the distribution file.
    
    Parameters:
    format - Archive format
    includeBaseDir - the base directory for include.
    finalName - The final name.
    configSource - AssemblerConfigurationSource
    containerHandlers - The list of ContainerDescriptorHandler
    recompressZippedFiles - recompress zipped files.
    mergeManifestMode - how to handle already existing Manifest files
    
    Returns:
    archiver Archiver generated
    
    Throws:
    
    ArchiverException
    
    NoSuchArchiverException
  - createWarArchiver
```
protected Archiver createWarArchiver()
                              throws NoSuchArchiverException
```
    Throws:
    
    NoSuchArchiverException
  - createTarArchiver
```
protected Archiver createTarArchiver(String format,
                         TarLongFileMode tarLongFileMode)
                              throws NoSuchArchiverException
```
    Throws:
    
    NoSuchArchiverException
  - 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)
```

Class DefaultAssemblyArchiver

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DefaultAssemblyArchiver

DefaultAssemblyArchiver

Method Detail

createArchive

createArchiver

createWarArchiver

createTarArchiver

contextualize

setContainer