Package org.apache.maven.plugins.assembly.mojos

Class AbstractAssemblyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.assembly.mojos.AbstractAssemblyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

SingleAssemblyMojo

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

Author:

Brett Porter, Vincent Siveton

Field Summary

Fields

Modifier and Type	Field	Description
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	commandLinePropertiesInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	envInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	mainProjectInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	rootInterpolator

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractAssemblyMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Create the binary distribution.
Properties	getAdditionalProperties()
File	getArchiveBaseDirectory()
String	getArchiverConfig()
File	getBasedir()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getCommandLinePropsInterpolator()	Gets an interpolator from environment variables and stuff
List<String>	getDelimiters()
String[]	getDescriptorReferences()
String[]	getDescriptors()
File	getDescriptorSourceDirectory()
String	getEncoding()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getEnvInterpolator()	Gets an interpolator from environment variables and stuff
String	getEscapeString()
List<String>	getFilters()
String	getFinalName()
List<Assembly>	getInlineDescriptors()
org.apache.maven.archiver.MavenArchiveConfiguration	getJarArchiveConfiguration()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getMainProjectInterpolator()
org.apache.maven.shared.filtering.MavenReaderFilter	getMavenReaderFilter()	Maven shared filtering utility.
org.apache.maven.execution.MavenSession	getMavenSession()
String	getMergeManifestMode()
File	getOutputDirectory()
Integer	getOverrideGid()
String	getOverrideGroupName()
Integer	getOverrideUid()
String	getOverrideUserName()
List<org.apache.maven.project.MavenProject>	getReactorProjects()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	getRepositoryInterpolator()
File	getSiteDirectory()
String	getTarLongFileMode()
File	getTemporaryRootDirectory()
File	getWorkingDirectory()
boolean	isAssemblyIdAppended()
boolean	isDryRun()
boolean	isIgnoreDirFormatExtensions()
boolean	isIgnoreMissingDescriptor()
boolean	isIgnorePermissions()
boolean	isIncludeProjectBuildFilters()
boolean	isRecompressZippedFiles()
boolean	isUpdateOnly()
static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator	mainProjectInterpolator(org.apache.maven.project.MavenProject mainProject)
void	setAppendAssemblyId(boolean appendAssemblyId)
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
void	setBasedir(File basedir)
void	setDelimiters(List<String> delimiters)
void	setDescriptorRefs(String[] descriptorRefs)
void	setDescriptors(String[] descriptors)
void	setFilters(List<String> filters)
void	setFinalName(String finalName)
void	setOutputDirectory(File outputDirectory)
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

Methods inherited from interface org.apache.maven.plugins.assembly.AssemblerConfigurationSource

getProject

Field Details

commandLinePropertiesInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator commandLinePropertiesInterpolator

envInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator envInterpolator

mainProjectInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator mainProjectInterpolator

rootInterpolator

protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator rootInterpolator

Constructor Details

AbstractAssemblyMojo

public AbstractAssemblyMojo()

Method Details

mainProjectInterpolator

public static org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator mainProjectInterpolator(org.apache.maven.project.MavenProject mainProject)

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

getBasedir

public File getBasedir()

Specified by:

getBasedir in interface AssemblerConfigurationSource

Returns:

The base directory.

setBasedir

public void setBasedir(File basedir)

getDescriptorReferences

public String[] getDescriptorReferences()

Specified by:

getDescriptorReferences in interface AssemblerConfigurationSource

Returns:

The descriptor references.

getInlineDescriptors

public List<Assembly> getInlineDescriptors()

Specified by:

getInlineDescriptors in interface AssemblerConfigurationSource

Returns:

a list of inline descriptors.

getDescriptorSourceDirectory

public File getDescriptorSourceDirectory()

Specified by:

getDescriptorSourceDirectory in interface AssemblerConfigurationSource

Returns:

The descriptor source directory.

getDescriptors

public String[] getDescriptors()

Specified by:

getDescriptors in interface AssemblerConfigurationSource

Returns:

The descriptors.

setDescriptors

public void setDescriptors(String[] descriptors)

getSiteDirectory

public File getSiteDirectory()

Specified by:

getSiteDirectory in interface AssemblerConfigurationSource

Returns:

The site directory.

setSiteDirectory

public void setSiteDirectory(File siteDirectory)

getFinalName

public String getFinalName()

Specified by:

getFinalName in interface AssemblerConfigurationSource

Returns:

The final name.

setFinalName

public void setFinalName(String finalName)

isAssemblyIdAppended

public boolean isAssemblyIdAppended()

Specified by:

isAssemblyIdAppended in interface AssemblerConfigurationSource

Returns:

append the assembly id.

getTarLongFileMode

public String getTarLongFileMode()

Specified by:

getTarLongFileMode in interface AssemblerConfigurationSource

Returns:

Tar long file mode.

setTarLongFileMode

public void setTarLongFileMode(String tarLongFileMode)

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in interface AssemblerConfigurationSource

Returns:

The output directory.

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

getJarArchiveConfiguration

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

Specified by:

getJarArchiveConfiguration in interface AssemblerConfigurationSource

Returns:

the jar archive configuration.

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface AssemblerConfigurationSource

Returns:

The working directory.

getTemporaryRootDirectory

public File getTemporaryRootDirectory()

Specified by:

getTemporaryRootDirectory in interface AssemblerConfigurationSource

Returns:

The temporary root directory.

getArchiveBaseDirectory

public File getArchiveBaseDirectory()

Specified by:

getArchiveBaseDirectory in interface AssemblerConfigurationSource

Returns:

The archive base directory.

getFilters

public List<String> getFilters()

Specified by:

getFilters in interface AssemblerConfigurationSource

Returns:

The filters.

setFilters

public void setFilters(List<String> filters)

getAdditionalProperties

public Properties getAdditionalProperties()

Specified by:

getAdditionalProperties in interface AssemblerConfigurationSource

Returns:

the additional properties

isIncludeProjectBuildFilters

public boolean isIncludeProjectBuildFilters()

Specified by:

isIncludeProjectBuildFilters in interface AssemblerConfigurationSource

Returns:

include the project build filters or not.

getReactorProjects

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

Specified by:

getReactorProjects in interface AssemblerConfigurationSource

Returns:

The list of reactor projects.

setReactorProjects

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

setAppendAssemblyId

public void setAppendAssemblyId(boolean appendAssemblyId)

setArchive

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

setDescriptorRefs

public void setDescriptorRefs(String[] descriptorRefs)

setTempRoot

public void setTempRoot(File tempRoot)

setWorkDirectory

public void setWorkDirectory(File workDirectory)

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface AssemblerConfigurationSource

Returns:

Is this a test run.

isIgnoreDirFormatExtensions

public boolean isIgnoreDirFormatExtensions()

Specified by:

isIgnoreDirFormatExtensions in interface AssemblerConfigurationSource

Returns:

Ignore directory format extensions.

isIgnoreMissingDescriptor

public boolean isIgnoreMissingDescriptor()

Specified by:

isIgnoreMissingDescriptor in interface AssemblerConfigurationSource

Returns:

Ignore missing descriptor.

getMavenSession

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

Specified by:

getMavenSession in interface AssemblerConfigurationSource

Returns:

The maven session.

getArchiverConfig

public String getArchiverConfig()

Specified by:

getArchiverConfig in interface AssemblerConfigurationSource

Returns:

The archiver configuration.

getMavenReaderFilter

public org.apache.maven.shared.filtering.MavenReaderFilter getMavenReaderFilter()

Description copied from interface: AssemblerConfigurationSource

Maven shared filtering utility.

Specified by:

getMavenReaderFilter in interface AssemblerConfigurationSource

Returns:

the maven reader filter

isUpdateOnly

public boolean isUpdateOnly()

Specified by:

isUpdateOnly in interface AssemblerConfigurationSource

Returns:

Update only yes/no.

isIgnorePermissions

public boolean isIgnorePermissions()

Specified by:

isIgnorePermissions in interface AssemblerConfigurationSource

Returns:

Ignore permissions yes/no.

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface AssemblerConfigurationSource

Returns:

The current encoding.

isRecompressZippedFiles

public boolean isRecompressZippedFiles()

Specified by:

isRecompressZippedFiles in interface AssemblerConfigurationSource

Returns:

Indicates if zip archives being added to the assembly should be compressed again.

getMergeManifestMode

public String getMergeManifestMode()

Specified by:

getMergeManifestMode in interface AssemblerConfigurationSource

Returns:

the merge manifest mode in the JarArchiver

getEscapeString

public String getEscapeString()

Specified by:

getEscapeString in interface AssemblerConfigurationSource

Returns:

The escape string.

getDelimiters

public List<String> getDelimiters()

Specified by:

getDelimiters in interface AssemblerConfigurationSource

Returns:

The list of delimiters.

setDelimiters

public void setDelimiters(List<String> delimiters)

getCommandLinePropsInterpolator

public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getCommandLinePropsInterpolator()

Description copied from interface: AssemblerConfigurationSource

Gets an interpolator from environment variables and stuff

Specified by:

getCommandLinePropsInterpolator in interface AssemblerConfigurationSource

getEnvInterpolator

public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getEnvInterpolator()

Description copied from interface: AssemblerConfigurationSource

Gets an interpolator from environment variables and stuff

Specified by:

getEnvInterpolator in interface AssemblerConfigurationSource

getRepositoryInterpolator

public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getRepositoryInterpolator()

Specified by:

getRepositoryInterpolator in interface AssemblerConfigurationSource

getMainProjectInterpolator

public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getMainProjectInterpolator()

Specified by:

getMainProjectInterpolator in interface AssemblerConfigurationSource

getOverrideUid

public Integer getOverrideUid()

Specified by:

getOverrideUid in interface AssemblerConfigurationSource

Returns:

Override UID.

getOverrideUserName

public String getOverrideUserName()

Specified by:

getOverrideUserName in interface AssemblerConfigurationSource

Returns:

Override user name.

getOverrideGid

public Integer getOverrideGid()

Specified by:

getOverrideGid in interface AssemblerConfigurationSource

Returns:

Override GID.

getOverrideGroupName

public String getOverrideGroupName()

Specified by:

getOverrideGroupName in interface AssemblerConfigurationSource

Returns:

Override group name.