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 489631 2006-12-22 12:02:32Z kenney $

Author:

Brett Porter, Vincent Siveton

Field Summary

protected boolean	appendAssemblyId Set to false to exclude the assembly id from the assembly final name.
protected java.io.File	descriptor Deprecated. Please use descriptors instead
protected java.lang.String	descriptorId Deprecated. Please use descriptorRefs instead
protected java.util.List	filters

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

ROLE

Constructor Summary

AbstractAssemblyMojo()

Method Summary

void	execute() Create the binary distribution.
java.io.File	getArchiveBaseDirectory()
protected AssemblyArchiver	getAssemblyArchiver()
protected AssemblyReader	getAssemblyReader()
java.io.File	getBasedir()
java.lang.String	getClassifier()
java.io.File	getDescriptor()
java.lang.String	getDescriptorId()
java.lang.String[]	getDescriptorReferences()
java.io.File[]	getDescriptors()
java.io.File	getDescriptorSourceDirectory()
java.util.List	getFilters()
java.lang.String	getFinalName()
org.apache.maven.archiver.MavenArchiveConfiguration	getJarArchiveConfiguration()
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
java.io.File	getOutputDirectory()
abstract org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.project.MavenProjectHelper	getProjectHelper()
java.util.List	getReactorProjects()
java.util.List	getRemoteRepositories()
java.io.File	getSiteDirectory()
java.lang.String	getTarLongFileMode()
java.io.File	getTemporaryRootDirectory()
java.io.File	getWorkingDirectory()
boolean	isAssemblyIdAppended()
boolean	isSiteIncluded()
void	setAppendAssemblyId(boolean appendAssemblyId)
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
void	setArchiveBaseDirectory(java.io.File archiveBaseDirectory)
void	setAssemblyArchiver(AssemblyArchiver assemblyArchiver)
void	setAssemblyReader(AssemblyReader assemblyReader)
void	setBasedir(java.io.File basedir)
void	setClassifier(java.lang.String classifier)
void	setDescriptor(java.io.File descriptor)
void	setDescriptorId(java.lang.String descriptorId)
void	setDescriptorRefs(java.lang.String[] descriptorRefs)
void	setDescriptors(java.io.File[] descriptors)
void	setDescriptorSourceDirectory(java.io.File descriptorSourceDirectory)
void	setFilters(java.util.List filters)
void	setFinalName(java.lang.String finalName)
void	setIncludeSite(boolean includeSite)
void	setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
void	setOutputDirectory(java.io.File outputDirectory)
void	setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)
void	setReactorProjects(java.util.List reactorProjects)
void	setSiteDirectory(java.io.File siteDirectory)
void	setTarLongFileMode(java.lang.String tarLongFileMode)
void	setTempRoot(java.io.File tempRoot)
void	setWorkDirectory(java.io.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

descriptorId

protected java.lang.String descriptorId

Deprecated. Please use descriptorRefs instead

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

descriptor

protected java.io.File descriptor

Deprecated. Please use descriptors instead

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

appendAssemblyId

protected boolean appendAssemblyId

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

filters

protected java.util.List filters

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

getAssemblyArchiver

protected AssemblyArchiver getAssemblyArchiver()

getAssemblyReader

protected AssemblyReader getAssemblyReader()

getBasedir

public java.io.File getBasedir()

Specified by:

getBasedir in interface AssemblerConfigurationSource

getDescriptor

public java.io.File getDescriptor()

Specified by:

getDescriptor in interface AssemblerConfigurationSource

getDescriptorId

public java.lang.String getDescriptorId()

Specified by:

getDescriptorId in interface AssemblerConfigurationSource

getDescriptorReferences

public java.lang.String[] getDescriptorReferences()

Specified by:

getDescriptorReferences in interface AssemblerConfigurationSource

getDescriptorSourceDirectory

public java.io.File getDescriptorSourceDirectory()

Specified by:

getDescriptorSourceDirectory in interface AssemblerConfigurationSource

getDescriptors

public java.io.File[] getDescriptors()

Specified by:

getDescriptors in interface AssemblerConfigurationSource

getProject

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

Specified by:

getProject in interface AssemblerConfigurationSource

getSiteDirectory

public java.io.File getSiteDirectory()

Specified by:

getSiteDirectory in interface AssemblerConfigurationSource

isSiteIncluded

public boolean isSiteIncluded()

Specified by:

isSiteIncluded in interface AssemblerConfigurationSource

getFinalName

public java.lang.String getFinalName()

Specified by:

getFinalName in interface AssemblerConfigurationSource

isAssemblyIdAppended

public boolean isAssemblyIdAppended()

Specified by:

isAssemblyIdAppended in interface AssemblerConfigurationSource

getTarLongFileMode

public java.lang.String getTarLongFileMode()

Specified by:

getTarLongFileMode in interface AssemblerConfigurationSource

getOutputDirectory

public java.io.File getOutputDirectory()

Specified by:

getOutputDirectory in interface AssemblerConfigurationSource

getJarArchiveConfiguration

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

Specified by:

getJarArchiveConfiguration in interface AssemblerConfigurationSource

getWorkingDirectory

public java.io.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 java.io.File getTemporaryRootDirectory()

Specified by:

getTemporaryRootDirectory in interface AssemblerConfigurationSource

getArchiveBaseDirectory

public java.io.File getArchiveBaseDirectory()

Specified by:

getArchiveBaseDirectory in interface AssemblerConfigurationSource

getFilters

public java.util.List getFilters()

Specified by:

getFilters in interface AssemblerConfigurationSource

getReactorProjects

public java.util.List getReactorProjects()

Specified by:

getReactorProjects in interface AssemblerConfigurationSource

getClassifier

public java.lang.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(java.io.File archiveBaseDirectory)

setAssemblyArchiver

public void setAssemblyArchiver(AssemblyArchiver assemblyArchiver)

setAssemblyReader

public void setAssemblyReader(AssemblyReader assemblyReader)

setBasedir

public void setBasedir(java.io.File basedir)

setClassifier

public void setClassifier(java.lang.String classifier)

setDescriptor

public void setDescriptor(java.io.File descriptor)

setDescriptorId

public void setDescriptorId(java.lang.String descriptorId)

setDescriptorRefs

public void setDescriptorRefs(java.lang.String[] descriptorRefs)

setDescriptors

public void setDescriptors(java.io.File[] descriptors)

setDescriptorSourceDirectory

public void setDescriptorSourceDirectory(java.io.File descriptorSourceDirectory)

setFilters

public void setFilters(java.util.List filters)

setFinalName

public void setFinalName(java.lang.String finalName)

setIncludeSite

public void setIncludeSite(boolean includeSite)

setLocalRepository

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

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

setProjectHelper

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

setReactorProjects

public void setReactorProjects(java.util.List reactorProjects)

setSiteDirectory

public void setSiteDirectory(java.io.File siteDirectory)

setTarLongFileMode

public void setTarLongFileMode(java.lang.String tarLongFileMode)

setTempRoot

public void setTempRoot(java.io.File tempRoot)

setWorkDirectory

public void setWorkDirectory(java.io.File workDirectory)

getRemoteRepositories

public java.util.List getRemoteRepositories()

Specified by:

getRemoteRepositories in interface AssemblerConfigurationSource