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
Modifier and TypeFieldDescriptionprotected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
protected org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Create the binary distribution.org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
Gets an interpolator from environment variables and stuffString[]
String[]
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
Gets an interpolator from environment variables and stufforg.apache.maven.archiver.MavenArchiveConfiguration
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
org.apache.maven.shared.filtering.MavenReaderFilter
Maven shared filtering utility.org.apache.maven.execution.MavenSession
abstract org.apache.maven.project.MavenProject
List<org.apache.maven.project.MavenProject>
List<org.apache.maven.artifact.repository.ArtifactRepository>
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
boolean
boolean
isDryRun()
boolean
boolean
boolean
boolean
boolean
boolean
Deprecated.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
-
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.MojoFailureExceptionCreate the binary distribution.- Specified by:
execute
in interfaceorg.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-
getBasedir
- Specified by:
getBasedir
in interfaceAssemblerConfigurationSource
- Returns:
- The base directory.
-
setBasedir
-
getDescriptorReferences
- Specified by:
getDescriptorReferences
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptor references.
-
getDescriptorSourceDirectory
- Specified by:
getDescriptorSourceDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptor source directory.
-
getDescriptors
- Specified by:
getDescriptors
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptors.
-
setDescriptors
-
getProject
public abstract org.apache.maven.project.MavenProject getProject()- Specified by:
getProject
in interfaceAssemblerConfigurationSource
- Returns:
- The Maven Project.
-
getSiteDirectory
- Specified by:
getSiteDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The site directory.
-
setSiteDirectory
-
getFinalName
- Specified by:
getFinalName
in interfaceAssemblerConfigurationSource
- Returns:
- The final name.
-
setFinalName
-
isAssemblyIdAppended
public boolean isAssemblyIdAppended()- Specified by:
isAssemblyIdAppended
in interfaceAssemblerConfigurationSource
- Returns:
- append the assembly id.
-
getTarLongFileMode
- Specified by:
getTarLongFileMode
in interfaceAssemblerConfigurationSource
- Returns:
- Tar long file mode.
-
setTarLongFileMode
-
getOutputDirectory
- Specified by:
getOutputDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The output directory.
-
setOutputDirectory
-
getJarArchiveConfiguration
public org.apache.maven.archiver.MavenArchiveConfiguration getJarArchiveConfiguration()- Specified by:
getJarArchiveConfiguration
in interfaceAssemblerConfigurationSource
- Returns:
- the jar archive configuration.
-
getWorkingDirectory
- Specified by:
getWorkingDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The working directory.
-
getTemporaryRootDirectory
- Specified by:
getTemporaryRootDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The temporary root directory.
-
getArchiveBaseDirectory
- Specified by:
getArchiveBaseDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The archive base directory.
-
getFilters
- Specified by:
getFilters
in interfaceAssemblerConfigurationSource
- Returns:
- The filters.
-
setFilters
-
getAdditionalProperties
- Specified by:
getAdditionalProperties
in interfaceAssemblerConfigurationSource
- Returns:
- the additional properties
-
isIncludeProjectBuildFilters
public boolean isIncludeProjectBuildFilters()- Specified by:
isIncludeProjectBuildFilters
in interfaceAssemblerConfigurationSource
- Returns:
- include the project build filters or not.
-
getReactorProjects
- Specified by:
getReactorProjects
in interfaceAssemblerConfigurationSource
- Returns:
- The list of reactor projects.
-
setReactorProjects
-
setAppendAssemblyId
public void setAppendAssemblyId(boolean appendAssemblyId) -
setArchive
public void setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive) -
setDescriptorRefs
-
setTempRoot
-
setWorkDirectory
-
getRemoteRepositories
- Specified by:
getRemoteRepositories
in interfaceAssemblerConfigurationSource
- Returns:
- The remote repositories.
-
isDryRun
public boolean isDryRun()- Specified by:
isDryRun
in interfaceAssemblerConfigurationSource
- Returns:
- Is this a test run.
-
isIgnoreDirFormatExtensions
public boolean isIgnoreDirFormatExtensions()- Specified by:
isIgnoreDirFormatExtensions
in interfaceAssemblerConfigurationSource
- Returns:
- Ignore directory format extensions.
-
isIgnoreMissingDescriptor
public boolean isIgnoreMissingDescriptor()- Specified by:
isIgnoreMissingDescriptor
in interfaceAssemblerConfigurationSource
- Returns:
- Ignore missing descriptor.
-
getMavenSession
public org.apache.maven.execution.MavenSession getMavenSession()- Specified by:
getMavenSession
in interfaceAssemblerConfigurationSource
- Returns:
- The maven session.
-
getArchiverConfig
- Specified by:
getArchiverConfig
in interfaceAssemblerConfigurationSource
- 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 interfaceAssemblerConfigurationSource
- Returns:
- the maven reader filter
-
isUpdateOnly
public boolean isUpdateOnly()- Specified by:
isUpdateOnly
in interfaceAssemblerConfigurationSource
- Returns:
- Update only yes/no.
-
isUseJvmChmod
Deprecated.- Specified by:
isUseJvmChmod
in interfaceAssemblerConfigurationSource
- Returns:
- Use JVM chmod yes/no.
-
isIgnorePermissions
public boolean isIgnorePermissions()- Specified by:
isIgnorePermissions
in interfaceAssemblerConfigurationSource
- Returns:
- Ignore permissions yes/no.
-
getEncoding
- Specified by:
getEncoding
in interfaceAssemblerConfigurationSource
- Returns:
- The current encoding.
-
getMergeManifestMode
-
getEscapeString
- Specified by:
getEscapeString
in interfaceAssemblerConfigurationSource
- Returns:
- The escape string.
-
getDelimiters
- Specified by:
getDelimiters
in interfaceAssemblerConfigurationSource
- Returns:
- The list of delimiters.
-
setDelimiters
-
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 interfaceAssemblerConfigurationSource
-
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 interfaceAssemblerConfigurationSource
-
getRepositoryInterpolator
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getRepositoryInterpolator()- Specified by:
getRepositoryInterpolator
in interfaceAssemblerConfigurationSource
-
getMainProjectInterpolator
public org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator getMainProjectInterpolator()- Specified by:
getMainProjectInterpolator
in interfaceAssemblerConfigurationSource
-
getOverrideUid
- Specified by:
getOverrideUid
in interfaceAssemblerConfigurationSource
- Returns:
- Override UID.
-
getOverrideUserName
- Specified by:
getOverrideUserName
in interfaceAssemblerConfigurationSource
- Returns:
- Override user name.
-
getOverrideGid
- Specified by:
getOverrideGid
in interfaceAssemblerConfigurationSource
- Returns:
- Override GID.
-
getOverrideGroupName
- Specified by:
getOverrideGroupName
in interfaceAssemblerConfigurationSource
- Returns:
- Override group name.
-