Package org.apache.maven.plugins.assembly.archive.phase

Class ModuleSetAssemblyPhase

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.plugins.assembly.archive.phase.ModuleSetAssemblyPhase

All Implemented Interfaces:

AssemblyArchiverPhase, PhaseOrder, org.codehaus.plexus.logging.LogEnabled

@Component(role=AssemblyArchiverPhase.class,
           hint="module-sets")
public class ModuleSetAssemblyPhase
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements AssemblyArchiverPhase, PhaseOrder

Handles the <moduleSets/> top-level section of the assembly descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager
private DependencyResolver	dependencyResolver
private static java.lang.String	LINE_SEPARATOR	The line separator.
private org.apache.maven.project.ProjectBuilder	projectBuilder

Fields inherited from interface org.apache.maven.plugins.assembly.archive.phase.AssemblyArchiverPhase

ROLE

Constructor Summary

Constructors

Constructor	Description
ModuleSetAssemblyPhase()	Create an instance.
ModuleSetAssemblyPhase(org.apache.maven.project.ProjectBuilder projectBuilder, DependencyResolver dependencyResolver, org.codehaus.plexus.logging.Logger logger)

Method Summary

Modifier and Type	Method	Description
(package private) void	addModuleArtifact(org.apache.maven.artifact.Artifact artifact, org.apache.maven.project.MavenProject project, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource, ModuleBinaries binaries)
(package private) void	addModuleBinaries(Assembly assembly, ModuleSet moduleSet, ModuleBinaries binaries, java.util.Set<org.apache.maven.project.MavenProject> projects, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)
(package private) void	addModuleSourceFileSets(ModuleSources sources, java.util.Set<org.apache.maven.project.MavenProject> moduleProjects, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)
(package private) FileSet	createFileSet(FileSet fileSet, ModuleSources sources, org.apache.maven.project.MavenProject moduleProject, AssemblerConfigurationSource configSource)
void	execute(Assembly assembly, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)	Handle the associated section of the assembly descriptor.
static java.util.List<DependencySet>	getDependencySets(ModuleBinaries binaries)
static java.util.Set<org.apache.maven.project.MavenProject>	getModuleProjects(ModuleSet moduleSet, AssemblerConfigurationSource configSource, org.codehaus.plexus.logging.Logger logger)
(package private) boolean	isDeprecatedModuleSourcesConfigPresent(ModuleSources sources)	Determine whether the deprecated file-set configuration directly within the ModuleSources object is present.
int	order()
private void	validate(ModuleSet moduleSet, AssemblerConfigurationSource configSource)
private java.util.List<org.apache.maven.project.MavenProject>	validateModuleVersions(java.util.Set<org.apache.maven.project.MavenProject> moduleProjects)

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

Field Detail

LINE_SEPARATOR

private static final java.lang.String LINE_SEPARATOR

The line separator.

projectBuilder

@Requirement
private org.apache.maven.project.ProjectBuilder projectBuilder

archiverManager

@Requirement
private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

dependencyResolver

@Requirement
private DependencyResolver dependencyResolver

Constructor Detail

ModuleSetAssemblyPhase

public ModuleSetAssemblyPhase()

Create an instance.

ModuleSetAssemblyPhase

public ModuleSetAssemblyPhase(org.apache.maven.project.ProjectBuilder projectBuilder,
                              DependencyResolver dependencyResolver,
                              org.codehaus.plexus.logging.Logger logger)

Parameters:

projectBuilder - The project builder.

logger - The logger.

Method Detail

getDependencySets

public static java.util.List<DependencySet> getDependencySets(ModuleBinaries binaries)

getModuleProjects

@Nonnull
public static java.util.Set<org.apache.maven.project.MavenProject> getModuleProjects(ModuleSet moduleSet,
                                                                                     AssemblerConfigurationSource configSource,
                                                                                     org.codehaus.plexus.logging.Logger logger)
                                                                              throws ArchiveCreationException

Throws:

ArchiveCreationException

execute

public void execute(Assembly assembly,
                    org.codehaus.plexus.archiver.Archiver archiver,
                    AssemblerConfigurationSource configSource)
             throws ArchiveCreationException,
                    AssemblyFormattingException,
                    InvalidAssemblerConfigurationException,
                    DependencyResolutionException

Handle the associated section of the assembly descriptor.

Specified by:

execute in interface AssemblyArchiverPhase

Parameters:

assembly - The assembly descriptor to use

archiver - The archiver used to create the assembly archive, to which files/directories/artifacts are added

configSource - The configuration for this assembly build, normally derived from the plugin that launched the assembly process.

Throws:

ArchiveCreationException - in case of an archive creation error.

AssemblyFormattingException - in case of a assembly formatting exception.

InvalidAssemblerConfigurationException - in case of an invalid assembler configuration.

DependencyResolutionException

validate

private void validate(ModuleSet moduleSet,
                      AssemblerConfigurationSource configSource)

addModuleBinaries

void addModuleBinaries(Assembly assembly,
                       ModuleSet moduleSet,
                       ModuleBinaries binaries,
                       java.util.Set<org.apache.maven.project.MavenProject> projects,
                       org.codehaus.plexus.archiver.Archiver archiver,
                       AssemblerConfigurationSource configSource)
                throws ArchiveCreationException,
                       AssemblyFormattingException,
                       InvalidAssemblerConfigurationException,
                       DependencyResolutionException

Throws:

ArchiveCreationException

AssemblyFormattingException

InvalidAssemblerConfigurationException

DependencyResolutionException

validateModuleVersions

private java.util.List<org.apache.maven.project.MavenProject> validateModuleVersions(java.util.Set<org.apache.maven.project.MavenProject> moduleProjects)

addModuleArtifact

void addModuleArtifact(org.apache.maven.artifact.Artifact artifact,
                       org.apache.maven.project.MavenProject project,
                       org.codehaus.plexus.archiver.Archiver archiver,
                       AssemblerConfigurationSource configSource,
                       ModuleBinaries binaries)
                throws ArchiveCreationException,
                       AssemblyFormattingException

Throws:

ArchiveCreationException

AssemblyFormattingException

addModuleSourceFileSets

void addModuleSourceFileSets(ModuleSources sources,
                             java.util.Set<org.apache.maven.project.MavenProject> moduleProjects,
                             org.codehaus.plexus.archiver.Archiver archiver,
                             AssemblerConfigurationSource configSource)
                      throws ArchiveCreationException,
                             AssemblyFormattingException

Throws:

ArchiveCreationException

AssemblyFormattingException

isDeprecatedModuleSourcesConfigPresent

boolean isDeprecatedModuleSourcesConfigPresent(@Nonnull
                                               ModuleSources sources)

Determine whether the deprecated file-set configuration directly within the ModuleSources object is present.

createFileSet

@Nonnull
FileSet createFileSet(@Nonnull
                      FileSet fileSet,
                      @Nonnull
                      ModuleSources sources,
                      @Nonnull
                      org.apache.maven.project.MavenProject moduleProject,
                      @Nonnull
                      AssemblerConfigurationSource configSource)
               throws AssemblyFormattingException

Throws:

AssemblyFormattingException

order

public int order()

Specified by:

order in interface PhaseOrder