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
-
Constructor Summary
Constructors Constructor Description AbstractAssemblyMojo()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 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 stuffList<String>
getDelimiters()
String[]
getDescriptorReferences()
String[]
getDescriptors()
File
getDescriptorSourceDirectory()
String
getEncoding()
org.codehaus.plexus.interpolation.fixed.FixedStringSearchInterpolator
getEnvInterpolator()
Gets an interpolator from environment variables and stuffString
getEscapeString()
List<String>
getFilters()
String
getFinalName()
org.apache.maven.archiver.MavenArchiveConfiguration
getJarArchiveConfiguration()
org.apache.maven.artifact.repository.ArtifactRepository
getLocalRepository()
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()
abstract org.apache.maven.project.MavenProject
getProject()
List<org.apache.maven.project.MavenProject>
getReactorProjects()
List<org.apache.maven.artifact.repository.ArtifactRepository>
getRemoteRepositories()
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
isUpdateOnly()
boolean
isUseJvmChmod()
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
setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
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)
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 interfaceorg.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-
getBasedir
public File getBasedir()
- Specified by:
getBasedir
in interfaceAssemblerConfigurationSource
- Returns:
- The base directory.
-
setBasedir
public void setBasedir(File basedir)
-
getDescriptorReferences
public String[] getDescriptorReferences()
- Specified by:
getDescriptorReferences
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptor references.
-
getDescriptorSourceDirectory
public File getDescriptorSourceDirectory()
- Specified by:
getDescriptorSourceDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptor source directory.
-
getDescriptors
public String[] getDescriptors()
- Specified by:
getDescriptors
in interfaceAssemblerConfigurationSource
- Returns:
- The descriptors.
-
setDescriptors
public void setDescriptors(String[] descriptors)
-
getProject
public abstract org.apache.maven.project.MavenProject getProject()
- Specified by:
getProject
in interfaceAssemblerConfigurationSource
- Returns:
- The Maven Project.
-
getSiteDirectory
public File getSiteDirectory()
- Specified by:
getSiteDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The site directory.
-
setSiteDirectory
public void setSiteDirectory(File siteDirectory)
-
getFinalName
public String getFinalName()
- Specified by:
getFinalName
in interfaceAssemblerConfigurationSource
- Returns:
- The final name.
-
setFinalName
public void setFinalName(String finalName)
-
isAssemblyIdAppended
public boolean isAssemblyIdAppended()
- Specified by:
isAssemblyIdAppended
in interfaceAssemblerConfigurationSource
- Returns:
- append the assembly id.
-
getTarLongFileMode
public String getTarLongFileMode()
- Specified by:
getTarLongFileMode
in interfaceAssemblerConfigurationSource
- Returns:
- Tar long file mode.
-
setTarLongFileMode
public void setTarLongFileMode(String tarLongFileMode)
-
getOutputDirectory
public File getOutputDirectory()
- Specified by:
getOutputDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The output directory.
-
setOutputDirectory
public void setOutputDirectory(File outputDirectory)
-
getJarArchiveConfiguration
public org.apache.maven.archiver.MavenArchiveConfiguration getJarArchiveConfiguration()
- Specified by:
getJarArchiveConfiguration
in interfaceAssemblerConfigurationSource
- Returns:
- the jar archive configuration.
-
getWorkingDirectory
public File getWorkingDirectory()
- Specified by:
getWorkingDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The working directory.
-
getLocalRepository
public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
- Specified by:
getLocalRepository
in interfaceAssemblerConfigurationSource
- Returns:
- The local repository.
-
setLocalRepository
public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
-
getTemporaryRootDirectory
public File getTemporaryRootDirectory()
- Specified by:
getTemporaryRootDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The temporary root directory.
-
getArchiveBaseDirectory
public File getArchiveBaseDirectory()
- Specified by:
getArchiveBaseDirectory
in interfaceAssemblerConfigurationSource
- Returns:
- The archive base directory.
-
getFilters
public List<String> getFilters()
- Specified by:
getFilters
in interfaceAssemblerConfigurationSource
- Returns:
- The filters.
-
getAdditionalProperties
public Properties 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
public List<org.apache.maven.project.MavenProject> getReactorProjects()
- Specified by:
getReactorProjects
in interfaceAssemblerConfigurationSource
- 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)
-
getRemoteRepositories
public List<org.apache.maven.artifact.repository.ArtifactRepository> 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
public String 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 public boolean 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
public String getEncoding()
- Specified by:
getEncoding
in interfaceAssemblerConfigurationSource
- Returns:
- The current encoding.
-
getMergeManifestMode
public String getMergeManifestMode()
-
getEscapeString
public String getEscapeString()
- Specified by:
getEscapeString
in interfaceAssemblerConfigurationSource
- Returns:
- The escape string.
-
getDelimiters
public List<String> getDelimiters()
- Specified by:
getDelimiters
in interfaceAssemblerConfigurationSource
- Returns:
- The list of 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 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
public Integer getOverrideUid()
- Specified by:
getOverrideUid
in interfaceAssemblerConfigurationSource
- Returns:
- Override UID.
-
getOverrideUserName
public String getOverrideUserName()
- Specified by:
getOverrideUserName
in interfaceAssemblerConfigurationSource
- Returns:
- Override user name.
-
getOverrideGid
public Integer getOverrideGid()
- Specified by:
getOverrideGid
in interfaceAssemblerConfigurationSource
- Returns:
- Override GID.
-
getOverrideGroupName
public String getOverrideGroupName()
- Specified by:
getOverrideGroupName
in interfaceAssemblerConfigurationSource
- Returns:
- Override group name.
-
-