org.apache.maven.plugin.assembly.mojos

Class AbstractAssemblyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.assembly.mojos.AbstractAssemblyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDirectoryMojo, AssemblyMojo, AttachedAssemblyMojo, SingleAssemblyMojo

public abstract class AbstractAssemblyMojo
extends org.apache.maven.plugin.AbstractMojo
implements AssemblerConfigurationSource

Version:

$Id: AbstractAssemblyMojo.java 1601216 2014-06-08 11:58:09Z khmarbaise $

Author:

Brett Porter, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendAssemblyId Set to false to exclude the assembly id from the assembly final name.
protected String	descriptor Deprecated. Please use descriptors instead
protected String	descriptorId Deprecated. Please use descriptorRefs instead
protected String	encoding The character encoding scheme to be applied when filtering resources.
protected String	escapeString Expressions preceded with this String won't be interpolated.
protected List<String>	filters The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
protected boolean	ignoreMissingDescriptor Set to true in order to not fail when a descriptor is missing.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAssemblyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Create the binary distribution.
File	getArchiveBaseDirectory()
String	getArchiverConfig()
protected AssemblyArchiver	getAssemblyArchiver()
protected AssemblyReader	getAssemblyReader()
File	getBasedir()
String	getClassifier()
String	getDescriptor() Deprecated. This has been replaced by getDescriptors()
String	getDescriptorId() Deprecated. This has been replaced by getDescriptorReferences()
String[]	getDescriptorReferences()
String[]	getDescriptors()
File	getDescriptorSourceDirectory()
String	getEncoding()
String	getEscapeString()
List<String>	getFilters()
String	getFinalName()
org.apache.maven.archiver.MavenArchiveConfiguration	getJarArchiveConfiguration()
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
org.apache.maven.shared.filtering.MavenFileFilter	getMavenFileFilter()
org.apache.maven.execution.MavenSession	getMavenSession()
File	getOutputDirectory()
abstract org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.project.MavenProjectHelper	getProjectHelper()
List<org.apache.maven.project.MavenProject>	getReactorProjects()
List<org.apache.maven.artifact.repository.ArtifactRepository>	getRemoteRepositories()
File	getSiteDirectory()
String	getTarLongFileMode()
File	getTemporaryRootDirectory()
File	getWorkingDirectory()
boolean	isAssemblyIdAppended()
boolean	isDryRun()
boolean	isIgnoreDirFormatExtensions()
boolean	isIgnoreMissingDescriptor()
boolean	isIgnorePermissions()
protected boolean	isRecompressZippedFiles()
boolean	isSiteIncluded()
protected boolean	isThisTheExecutionRoot() Returns true if the current project is located at the Execution Root Directory (where mvn was launched)
boolean	isUpdateOnly()
boolean	isUseJvmChmod()
void	setAppendAssemblyId(boolean appendAssemblyId)
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
void	setArchiveBaseDirectory(File archiveBaseDirectory)
void	setAssemblyArchiver(AssemblyArchiver assemblyArchiver)
void	setAssemblyReader(AssemblyReader assemblyReader)
void	setBasedir(File basedir)
void	setClassifier(String classifier)
void	setDescriptor(String descriptor) Deprecated. This has been replaced by setDescriptors(String[])
void	setDescriptorId(String descriptorId) Deprecated. This has been replaced by setDescriptorRefs(String[])
void	setDescriptorRefs(String[] descriptorRefs)
void	setDescriptors(String[] descriptors)
void	setDescriptorSourceDirectory(File descriptorSourceDirectory)
void	setFilters(List<String> filters)
void	setFinalName(String finalName)
void	setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)
void	setIncludeSite(boolean includeSite)
void	setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
void	setOutputDirectory(File outputDirectory)
void	setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)
void	setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)
void	setSiteDirectory(File siteDirectory)
void	setTarLongFileMode(String tarLongFileMode)
void	setTempRoot(File tempRoot)
void	setWorkDirectory(File workDirectory)

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

encoding

@Parameter(property="encoding",
           defaultValue="${project.build.sourceEncoding}")
protected String encoding

The character encoding scheme to be applied when filtering resources.

escapeString

@Parameter(property="assembly.escapeString")
protected String escapeString

Expressions preceded with this String won't be interpolated. If you use "\" as the escape string then \${foo} will be replaced with ${foo}.

Since:

2.4

descriptorId

@Deprecated
@Parameter(property="descriptorId")
protected String descriptorId

Deprecated. Please use descriptorRefs instead

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

descriptor

@Deprecated
@Parameter(property="descriptor")
protected String descriptor

Deprecated. Please use descriptors instead

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

appendAssemblyId

@Parameter(property="assembly.appendAssemblyId",
           defaultValue="true")
protected boolean appendAssemblyId

Set to false to exclude the assembly id from the assembly final name.

ignoreMissingDescriptor

@Parameter(property="assembly.ignoreMissingDescriptor",
           defaultValue="false")
protected boolean ignoreMissingDescriptor

Set to true in order to not fail when a descriptor is missing.

filters

@Parameter
protected List<String> filters

The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
Normally, these will be configured from a plugin's execution section, to provide a different set of filters for a particular execution.

Constructor Detail

AbstractAssemblyMojo

public AbstractAssemblyMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Create the binary distribution.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isThisTheExecutionRoot

protected boolean isThisTheExecutionRoot()

Returns true if the current project is located at the Execution Root Directory (where mvn was launched)

Returns:

getAssemblyArchiver

protected AssemblyArchiver getAssemblyArchiver()

getAssemblyReader

protected AssemblyReader getAssemblyReader()

getBasedir

public File getBasedir()

Specified by:

getBasedir in interface AssemblerConfigurationSource

getDescriptor

@Deprecated
public String getDescriptor()

Deprecated. This has been replaced by getDescriptors()

Specified by:

getDescriptor in interface AssemblerConfigurationSource

getDescriptorId

@Deprecated
public String getDescriptorId()

Deprecated. This has been replaced by getDescriptorReferences()

Specified by:

getDescriptorId in interface AssemblerConfigurationSource

getDescriptorReferences

public String[] getDescriptorReferences()

Specified by:

getDescriptorReferences in interface AssemblerConfigurationSource

getDescriptorSourceDirectory

public File getDescriptorSourceDirectory()

Specified by:

getDescriptorSourceDirectory in interface AssemblerConfigurationSource

getDescriptors

public String[] getDescriptors()

Specified by:

getDescriptors in interface AssemblerConfigurationSource

getProject

public abstract org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in interface AssemblerConfigurationSource

getSiteDirectory

public File getSiteDirectory()

Specified by:

getSiteDirectory in interface AssemblerConfigurationSource

isSiteIncluded

public boolean isSiteIncluded()

Specified by:

isSiteIncluded in interface AssemblerConfigurationSource

getFinalName

public String getFinalName()

Specified by:

getFinalName in interface AssemblerConfigurationSource

isAssemblyIdAppended

public boolean isAssemblyIdAppended()

Specified by:

isAssemblyIdAppended in interface AssemblerConfigurationSource

getTarLongFileMode

public String getTarLongFileMode()

Specified by:

getTarLongFileMode in interface AssemblerConfigurationSource

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in interface AssemblerConfigurationSource

getJarArchiveConfiguration

public org.apache.maven.archiver.MavenArchiveConfiguration getJarArchiveConfiguration()

Specified by:

getJarArchiveConfiguration in interface AssemblerConfigurationSource

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface AssemblerConfigurationSource

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

Specified by:

getLocalRepository in interface AssemblerConfigurationSource

getTemporaryRootDirectory

public File getTemporaryRootDirectory()

Specified by:

getTemporaryRootDirectory in interface AssemblerConfigurationSource

getArchiveBaseDirectory

public File getArchiveBaseDirectory()

Specified by:

getArchiveBaseDirectory in interface AssemblerConfigurationSource

getFilters

public List<String> getFilters()

Specified by:

getFilters in interface AssemblerConfigurationSource

getReactorProjects

public List<org.apache.maven.project.MavenProject> getReactorProjects()

Specified by:

getReactorProjects in interface AssemblerConfigurationSource

getClassifier

public String getClassifier()

Specified by:

getClassifier in interface AssemblerConfigurationSource

getProjectHelper

protected org.apache.maven.project.MavenProjectHelper getProjectHelper()

setAppendAssemblyId

public void setAppendAssemblyId(boolean appendAssemblyId)

setArchive

public void setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)

setArchiveBaseDirectory

public void setArchiveBaseDirectory(File archiveBaseDirectory)

setAssemblyArchiver

public void setAssemblyArchiver(AssemblyArchiver assemblyArchiver)

setAssemblyReader

public void setAssemblyReader(AssemblyReader assemblyReader)

setBasedir

public void setBasedir(File basedir)

setClassifier

public void setClassifier(String classifier)

setDescriptor

@Deprecated
public void setDescriptor(String descriptor)

Deprecated. This has been replaced by setDescriptors(String[])

setDescriptorId

@Deprecated
public void setDescriptorId(String descriptorId)

Deprecated. This has been replaced by setDescriptorRefs(String[])

setDescriptorRefs

public void setDescriptorRefs(String[] descriptorRefs)

setDescriptors

public void setDescriptors(String[] descriptors)

setDescriptorSourceDirectory

public void setDescriptorSourceDirectory(File descriptorSourceDirectory)

setFilters

public void setFilters(List<String> filters)

setFinalName

public void setFinalName(String finalName)

setIncludeSite

public void setIncludeSite(boolean includeSite)

setLocalRepository

public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

setProjectHelper

public void setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)

setReactorProjects

public void setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)

setSiteDirectory

public void setSiteDirectory(File siteDirectory)

setTarLongFileMode

public void setTarLongFileMode(String tarLongFileMode)

setTempRoot

public void setTempRoot(File tempRoot)

setWorkDirectory

public void setWorkDirectory(File workDirectory)

getRemoteRepositories

public List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()

Specified by:

getRemoteRepositories in interface AssemblerConfigurationSource

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface AssemblerConfigurationSource

isIgnoreDirFormatExtensions

public boolean isIgnoreDirFormatExtensions()

Specified by:

isIgnoreDirFormatExtensions in interface AssemblerConfigurationSource

isIgnoreMissingDescriptor

public boolean isIgnoreMissingDescriptor()

Specified by:

isIgnoreMissingDescriptor in interface AssemblerConfigurationSource

setIgnoreMissingDescriptor

public void setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)

getMavenSession

public org.apache.maven.execution.MavenSession getMavenSession()

Specified by:

getMavenSession in interface AssemblerConfigurationSource

getArchiverConfig

public String getArchiverConfig()

Specified by:

getArchiverConfig in interface AssemblerConfigurationSource

getMavenFileFilter

public org.apache.maven.shared.filtering.MavenFileFilter getMavenFileFilter()

Specified by:

getMavenFileFilter in interface AssemblerConfigurationSource

isUpdateOnly

public boolean isUpdateOnly()

Specified by:

isUpdateOnly in interface AssemblerConfigurationSource

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface AssemblerConfigurationSource

isIgnorePermissions

public boolean isIgnorePermissions()

Specified by:

isIgnorePermissions in interface AssemblerConfigurationSource

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface AssemblerConfigurationSource

isRecompressZippedFiles

protected boolean isRecompressZippedFiles()

getEscapeString

public String getEscapeString()

Specified by:

getEscapeString in interface AssemblerConfigurationSource