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 1633832 2014-10-23 15:03:47Z krosenvold $

Author:

Brett Porter, Vincent Siveton

Field Summary

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

ROLE

Constructor Summary

AbstractAssemblyMojo()

Method Summary

void	execute() Create the binary distribution.
File	getArchiveBaseDirectory()
String	getArchiverConfig()
File	getBasedir()
String	getClassifier()
List<String>	getDelimiters()
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.shared.filtering.MavenReaderFilter	getMavenReaderFilter() Maven shared filtering utility.
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()
boolean	isIncludeProjectBuildFilters()
boolean	isSiteIncluded()
boolean	isUpdateOnly()
boolean	isUseJvmChmod()
void	setAppendAssemblyId(boolean appendAssemblyId)
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
void	setBasedir(File basedir)
void	setClassifier(String classifier)
void	setDelimiters(List<String> delimiters)
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

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

getBasedir

public File getBasedir()

Specified by:

getBasedir in interface AssemblerConfigurationSource

Returns:

The base directory.

getDescriptor

@Deprecated
public String getDescriptor()

Deprecated. This has been replaced by getDescriptors()

Specified by:

getDescriptor in interface AssemblerConfigurationSource

Returns:

The descriptor.

getDescriptorId

@Deprecated
public String getDescriptorId()

Deprecated. This has been replaced by getDescriptorReferences()

Specified by:

getDescriptorId in interface AssemblerConfigurationSource

Returns:

The descriptor id.

getDescriptorReferences

public String[] getDescriptorReferences()

Specified by:

getDescriptorReferences in interface AssemblerConfigurationSource

Returns:

The descriptor references.

getDescriptorSourceDirectory

public File getDescriptorSourceDirectory()

Specified by:

getDescriptorSourceDirectory in interface AssemblerConfigurationSource

Returns:

The descriptor source direcotoy.

getDescriptors

public String[] getDescriptors()

Specified by:

getDescriptors in interface AssemblerConfigurationSource

Returns:

The descriptors.

getProject

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

Specified by:

getProject in interface AssemblerConfigurationSource

Returns:

The Maven Project.

getSiteDirectory

public File getSiteDirectory()

Specified by:

getSiteDirectory in interface AssemblerConfigurationSource

Returns:

The site directory.

isSiteIncluded

public boolean isSiteIncluded()

Specified by:

isSiteIncluded in interface AssemblerConfigurationSource

Returns:

Site included.

getFinalName

public String getFinalName()

Specified by:

getFinalName in interface AssemblerConfigurationSource

Returns:

The final name.

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.

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in interface AssemblerConfigurationSource

Returns:

The output directory.

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 direcotory.

getLocalRepository

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

Specified by:

getLocalRepository in interface AssemblerConfigurationSource

Returns:

The local repository.

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.

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.

getClassifier

public String getClassifier()

Specified by:

getClassifier in interface AssemblerConfigurationSource

Returns:

The classifier.

getProjectHelper

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

setAppendAssemblyId

public void setAppendAssemblyId(boolean appendAssemblyId)

setArchive

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

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

Returns:

The remote repositories.

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.

setIgnoreMissingDescriptor

public void setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)

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 configu.

getMavenFileFilter

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

Specified by:

getMavenFileFilter in interface AssemblerConfigurationSource

Returns:

The maven file filter.

getMavenReaderFilter

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

Description copied from interface: AssemblerConfigurationSource

Maven shared filtering utility.

Specified by:

getMavenReaderFilter in interface AssemblerConfigurationSource

isUpdateOnly

public boolean isUpdateOnly()

Specified by:

isUpdateOnly in interface AssemblerConfigurationSource

Returns:

Update only yes/no.

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface AssemblerConfigurationSource

Returns:

Use JVM chmod 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.

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)