public abstract class AbstractAssemblyMojo extends org.apache.maven.plugin.AbstractMojo implements AssemblerConfigurationSource
Modifier and Type | Field and Description |
---|---|
protected boolean |
appendAssemblyId
Set to false to exclude the assembly id from the assembly final name.
|
protected String |
descriptor
Deprecated.
Please use descriptors instead
|
protected String |
descriptorId
Deprecated.
Please use descriptorRefs instead
|
protected String |
encoding
The character encoding scheme to be applied when filtering resources.
|
protected String |
escapeString
Expressions preceded with this String won't be interpolated.
|
protected List<String> |
filters
The list of extra filter properties files to be used along with System properties, project
properties, and filter properties files specified in the POM build/filters section, which
should be used for the filtering during the current mojo execution.
|
protected boolean |
ignoreMissingDescriptor
Set to true in order to not fail when a descriptor is missing.
|
Constructor and Description |
---|
AbstractAssemblyMojo() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
Create the binary distribution.
|
File |
getArchiveBaseDirectory() |
String |
getArchiverConfig() |
protected AssemblyArchiver |
getAssemblyArchiver() |
protected AssemblyReader |
getAssemblyReader() |
File |
getBasedir() |
String |
getClassifier() |
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.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() |
protected boolean |
isRecompressZippedFiles() |
boolean |
isSiteIncluded() |
protected boolean |
isThisTheExecutionRoot()
Returns true if the current project is located at the Execution Root Directory (where mvn was launched)
|
boolean |
isUpdateOnly() |
boolean |
isUseJvmChmod() |
void |
setAppendAssemblyId(boolean appendAssemblyId) |
void |
setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive) |
void |
setArchiveBaseDirectory(File archiveBaseDirectory) |
void |
setAssemblyArchiver(AssemblyArchiver assemblyArchiver) |
void |
setAssemblyReader(AssemblyReader assemblyReader) |
void |
setBasedir(File basedir) |
void |
setClassifier(String classifier) |
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) |
@Parameter(property="encoding", defaultValue="${project.build.sourceEncoding}") protected String encoding
@Parameter(property="assembly.escapeString") protected String escapeString
@Deprecated @Parameter(property="descriptorId") protected String descriptorId
@Deprecated @Parameter(property="descriptor") protected String descriptor
@Parameter(property="assembly.appendAssemblyId", defaultValue="true") protected boolean appendAssemblyId
@Parameter(property="assembly.ignoreMissingDescriptor", defaultValue="false") protected boolean ignoreMissingDescriptor
@Parameter protected List<String> filters
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
protected boolean isThisTheExecutionRoot()
protected AssemblyArchiver getAssemblyArchiver()
protected AssemblyReader getAssemblyReader()
public File getBasedir()
getBasedir
in interface AssemblerConfigurationSource
@Deprecated public String getDescriptor()
getDescriptors()
getDescriptor
in interface AssemblerConfigurationSource
@Deprecated public String getDescriptorId()
getDescriptorReferences()
getDescriptorId
in interface AssemblerConfigurationSource
public String[] getDescriptorReferences()
getDescriptorReferences
in interface AssemblerConfigurationSource
public File getDescriptorSourceDirectory()
getDescriptorSourceDirectory
in interface AssemblerConfigurationSource
public String[] getDescriptors()
getDescriptors
in interface AssemblerConfigurationSource
public abstract org.apache.maven.project.MavenProject getProject()
getProject
in interface AssemblerConfigurationSource
public File getSiteDirectory()
getSiteDirectory
in interface AssemblerConfigurationSource
public boolean isSiteIncluded()
isSiteIncluded
in interface AssemblerConfigurationSource
public String getFinalName()
getFinalName
in interface AssemblerConfigurationSource
public boolean isAssemblyIdAppended()
isAssemblyIdAppended
in interface AssemblerConfigurationSource
public String getTarLongFileMode()
getTarLongFileMode
in interface AssemblerConfigurationSource
public File getOutputDirectory()
getOutputDirectory
in interface AssemblerConfigurationSource
public org.apache.maven.archiver.MavenArchiveConfiguration getJarArchiveConfiguration()
getJarArchiveConfiguration
in interface AssemblerConfigurationSource
public File getWorkingDirectory()
getWorkingDirectory
in interface AssemblerConfigurationSource
public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
getLocalRepository
in interface AssemblerConfigurationSource
public File getTemporaryRootDirectory()
getTemporaryRootDirectory
in interface AssemblerConfigurationSource
public File getArchiveBaseDirectory()
getArchiveBaseDirectory
in interface AssemblerConfigurationSource
public List<String> getFilters()
getFilters
in interface AssemblerConfigurationSource
public List<org.apache.maven.project.MavenProject> getReactorProjects()
getReactorProjects
in interface AssemblerConfigurationSource
public String getClassifier()
getClassifier
in interface AssemblerConfigurationSource
protected org.apache.maven.project.MavenProjectHelper getProjectHelper()
public void setAppendAssemblyId(boolean appendAssemblyId)
public void setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)
public void setArchiveBaseDirectory(File archiveBaseDirectory)
public void setAssemblyArchiver(AssemblyArchiver assemblyArchiver)
public void setAssemblyReader(AssemblyReader assemblyReader)
public void setBasedir(File basedir)
public void setClassifier(String classifier)
@Deprecated public void setDescriptor(String descriptor)
setDescriptors(String[])
@Deprecated public void setDescriptorId(String descriptorId)
setDescriptorRefs(String[])
public void setDescriptorRefs(String[] descriptorRefs)
public void setDescriptors(String[] descriptors)
public void setDescriptorSourceDirectory(File descriptorSourceDirectory)
public void setFinalName(String finalName)
public void setIncludeSite(boolean includeSite)
public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
public void setOutputDirectory(File outputDirectory)
public void setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)
public void setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)
public void setSiteDirectory(File siteDirectory)
public void setTarLongFileMode(String tarLongFileMode)
public void setTempRoot(File tempRoot)
public void setWorkDirectory(File workDirectory)
public List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()
getRemoteRepositories
in interface AssemblerConfigurationSource
public boolean isDryRun()
isDryRun
in interface AssemblerConfigurationSource
public boolean isIgnoreDirFormatExtensions()
isIgnoreDirFormatExtensions
in interface AssemblerConfigurationSource
public boolean isIgnoreMissingDescriptor()
isIgnoreMissingDescriptor
in interface AssemblerConfigurationSource
public void setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)
public org.apache.maven.execution.MavenSession getMavenSession()
getMavenSession
in interface AssemblerConfigurationSource
public String getArchiverConfig()
getArchiverConfig
in interface AssemblerConfigurationSource
public org.apache.maven.shared.filtering.MavenFileFilter getMavenFileFilter()
getMavenFileFilter
in interface AssemblerConfigurationSource
public boolean isUpdateOnly()
isUpdateOnly
in interface AssemblerConfigurationSource
public boolean isUseJvmChmod()
isUseJvmChmod
in interface AssemblerConfigurationSource
public boolean isIgnorePermissions()
isIgnorePermissions
in interface AssemblerConfigurationSource
public String getEncoding()
getEncoding
in interface AssemblerConfigurationSource
protected boolean isRecompressZippedFiles()
public String getEscapeString()
getEscapeString
in interface AssemblerConfigurationSource
Copyright © 2002-2017 The Apache Software Foundation. All Rights Reserved.