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, ContextEnabled, Mojo

Direct Known Subclasses:

AbstractDirectoryMojo, AssemblyMojo, AttachedAssemblyMojo, SingleAssemblyMojo

public abstract class AbstractAssemblyMojo
extends AbstractMojo
implements AssemblerConfigurationSource

Version:

$Id: AbstractAssemblyMojo.java 1682730 2015-05-31 12:59:49Z krosenvold $

Author:

Brett Porter, Vincent Siveton

Mojo is thread safe:

true

commanndLinePropertiesInterpolator

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

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

AbstractAssemblyMojo

public AbstractAssemblyMojo()

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Create the binary distribution.

Specified by:

execute in interface Mojo

Throws:

MojoExecutionException

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 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 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 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<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 MavenProjectHelper getProjectHelper()

setAppendAssemblyId

public void setAppendAssemblyId(boolean appendAssemblyId)

setArchive

public void setArchive(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(ArtifactRepository localRepository)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

setProjectHelper

public void setProjectHelper(MavenProjectHelper projectHelper)

setReactorProjects

public void setReactorProjects(List<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<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 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.

getMavenReaderFilter

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

getCommandLinePropsInterpolator

@Nonnull
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

@Nonnull
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

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

Specified by:

getRepositoryInterpolator in interface AssemblerConfigurationSource

getMainProjectInterpolator

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

Specified by:

getMainProjectInterpolator in interface AssemblerConfigurationSource

mainProjectInterpolator

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

setDelimiters

public void setDelimiters(List<String> delimiters)