AbstractWarMojo (Apache Maven WAR Plugin 3.2.3 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.war.AbstractWarMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

WarExplodedMojo, WarInPlaceMojo, WarMojo
```
public abstract class AbstractWarMojo
extends AbstractMojo
```
Contains common jobs for WAR mojos.

Version:

$Id$

Field Summary

Fields
Modifier and Type Field and Description

protected String escapeString
Expression preceded with this String won't be interpolated.
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Fields
Modifier and Type	Field and Description
`protected String`	`escapeString` Expression preceded with this String won't be interpolated.

Constructor Summary

Constructors
Constructor and Description

AbstractWarMojo()

Constructors
Constructor and Description
`AbstractWarMojo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOverlay(Overlay overlay)`
`void`	`buildExplodedWebapp(File webapplicationDirectory)`
`void`	`buildWebapp(MavenProject mavenProject, File webapplicationDirectory)` Builds the webapp for the specified project with the new packaging task thingy.
`MavenArchiveConfiguration`	`getArchive()`
`ArtifactFactory`	`getArtifactFactory()`
`File`	`getCacheFile()`
`File`	`getClassesDirectory()`
`File`	`getContainerConfigXML()`
`Overlay`	`getCurrentProjectOverlay()`
`protected String[]`	`getDependentWarExcludes()` Returns a string array of the excludes to be used when adding dependent WAR as an overlay onto this WAR.
`protected String[]`	`getDependentWarIncludes()` Returns a string array of the includes to be used when adding dependent WARs as an overlay onto this WAR.
`protected String[]`	`getExcludes()` Returns a string array of the excludes to be used when copying the content of the WAR source directory.
`List<String>`	`getFilters()`
`protected String[]`	`getIncludes()` Returns a string array of the includes to be used when assembling/copying the WAR.
`JarArchiver`	`getJarArchiver()`
`List<String>`	`getNonFilteredFileExtensions()`
`String`	`getOutputFileNameMapping()`
`List<Overlay>`	`getOverlays()`
`MavenProject`	`getProject()`
`protected MavenSession`	`getSession()`
`File`	`getWarSourceDirectory()`
`String`	`getWarSourceExcludes()`
`String`	`getWarSourceIncludes()`
`File`	`getWebappDirectory()`
`org.apache.maven.model.Resource[]`	`getWebResources()`
`File`	`getWebXml()`
`File`	`getWorkDirectory()`
`boolean`	`isArchiveClasses()`
`protected boolean`	`isIncludeEmptyDirectories()`
`protected boolean`	`isRecompressZippedFiles()`
`boolean`	`isUseCache()`
`void`	`setArchiveClasses(boolean archiveClasses)`
`void`	`setArtifactFactory(ArtifactFactory artifactFactory)`
`void`	`setCacheFile(File cacheFile)`
`void`	`setClassesDirectory(File classesDirectory)`
`void`	`setContainerConfigXML(File containerConfigXML)`
`void`	`setFilters(List<String> filters)`
`void`	`setJarArchiver(JarArchiver jarArchiver)`
`void`	`setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)`
`void`	`setOutputFileNameMapping(String outputFileNameMapping)`
`void`	`setOverlays(List<Overlay> overlays)`
`void`	`setProject(MavenProject project)`
`void`	`setUseCache(boolean useCache)`
`void`	`setWarSourceDirectory(File warSourceDirectory)`
`void`	`setWarSourceExcludes(String warSourceExcludes)`
`void`	`setWarSourceIncludes(String warSourceIncludes)`
`void`	`setWebappDirectory(File webappDirectory)`
`void`	`setWebResources(org.apache.maven.model.Resource[] webResources)`
`void`	`setWebXml(File webXml)`
`void`	`setWorkDirectory(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

Methods inherited from interface org.apache.maven.plugin.Mojo
execute

- Field Detail
  - escapeString
```
@Parameter
protected String escapeString
```
    Expression preceded with this String won't be interpolated. \${foo} will be replaced with ${foo}.
    
    Since:
    
    2.1-beta-1
- Constructor Detail
  - AbstractWarMojo
```
public AbstractWarMojo()
```
- Method Detail
  - getCurrentProjectOverlay
```
public Overlay getCurrentProjectOverlay()
```
    Returns:
    
    The current overlay.
  - getExcludes
```
protected String[] getExcludes()
```
    Returns a string array of the excludes to be used when copying the content of the WAR source directory.
    
    Returns:
    
    an array of tokens to exclude
  - getIncludes
```
protected String[] getIncludes()
```
    Returns a string array of the includes to be used when assembling/copying the WAR.
    
    Returns:
    
    an array of tokens to include
  - getDependentWarExcludes
```
protected String[] getDependentWarExcludes()
```
    Returns a string array of the excludes to be used when adding dependent WAR as an overlay onto this WAR.
    
    Returns:
    
    an array of tokens to exclude
  - getDependentWarIncludes
```
protected String[] getDependentWarIncludes()
```
    Returns a string array of the includes to be used when adding dependent WARs as an overlay onto this WAR.
    
    Returns:
    
    an array of tokens to include
  - buildExplodedWebapp
```
public void buildExplodedWebapp(File webapplicationDirectory)
                         throws MojoExecutionException,
                                MojoFailureException
```
    Parameters:
    
    webapplicationDirectory - The web application directory.
    
    Throws:
    
    MojoExecutionException - In case of failure.
    
    MojoFailureException - In case of failure.
  - buildWebapp
```
public void buildWebapp(MavenProject mavenProject,
                        File webapplicationDirectory)
                 throws MojoExecutionException,
                        MojoFailureException,
                        IOException
```
    Builds the webapp for the specified project with the new packaging task thingy. Classes, libraries and tld files are copied to the webappDirectory during this phase.
    
    Parameters:
    
    mavenProject - the maven project
    
    webapplicationDirectory - the target directory
    
    Throws:
    
    MojoExecutionException - if an error occurred while packaging the webapp
    
    MojoFailureException - if an unexpected error occurred while packaging the webapp
    
    IOException - if an error occurred while copying the files
  - getProject
```
public MavenProject getProject()
```
    Returns:
    
    The Maven Project.
  - setProject
```
public void setProject(MavenProject project)
```
    Parameters:
    
    project - The project to be set.
  - getClassesDirectory
```
public File getClassesDirectory()
```
    Returns:
    
    the classes directory.
  - setClassesDirectory
```
public void setClassesDirectory(File classesDirectory)
```
    Parameters:
    
    classesDirectory - The classes directory to be set.
  - getWebappDirectory
```
public File getWebappDirectory()
```
    Returns:
    
    webappDirectory
  - setWebappDirectory
```
public void setWebappDirectory(File webappDirectory)
```
    Parameters:
    
    webappDirectory - The web application directory.
  - getWarSourceDirectory
```
public File getWarSourceDirectory()
```
    Returns:
    
    warSourceDirectory
  - setWarSourceDirectory
```
public void setWarSourceDirectory(File warSourceDirectory)
```
    Parameters:
    
    warSourceDirectory - warSourceDirectory
  - getWebXml
```
public File getWebXml()
```
    Returns:
    
    The webXml
  - setWebXml
```
public void setWebXml(File webXml)
```
    Parameters:
    
    webXml - The webXml
  - getContainerConfigXML
```
public File getContainerConfigXML()
```
    Returns:
    
    containerConfigXML
  - setContainerConfigXML
```
public void setContainerConfigXML(File containerConfigXML)
```
    Parameters:
    
    containerConfigXML - containerConfigXML
  - getOutputFileNameMapping
```
public String getOutputFileNameMapping()
```
    Returns:
    
    outputFileNameMapping
  - setOutputFileNameMapping
```
public void setOutputFileNameMapping(String outputFileNameMapping)
```
    Parameters:
    
    outputFileNameMapping - outputFileNameMapping
  - getOverlays
```
public List<Overlay> getOverlays()
```
    Returns:
    
    overlays
  - setOverlays
```
public void setOverlays(List<Overlay> overlays)
```
    Parameters:
    
    overlays - overlays
  - addOverlay
```
public void addOverlay(Overlay overlay)
```
    Parameters:
    
    overlay - add overlays.
  - isArchiveClasses
```
public boolean isArchiveClasses()
```
    Returns:
    
    archiveClasses
  - setArchiveClasses
```
public void setArchiveClasses(boolean archiveClasses)
```
    Parameters:
    
    archiveClasses - archiveClasses
  - getJarArchiver
```
public JarArchiver getJarArchiver()
```
    Returns:
    
    JarArchiver
  - setJarArchiver
```
public void setJarArchiver(JarArchiver jarArchiver)
```
    Parameters:
    
    jarArchiver - JarArchiver
  - getWebResources
```
public org.apache.maven.model.Resource[] getWebResources()
```
    Returns:
    
    webResources.
  - setWebResources
```
public void setWebResources(org.apache.maven.model.Resource[] webResources)
```
    Parameters:
    
    webResources - webResources.
  - getFilters
```
public List<String> getFilters()
```
    Returns:
    
    filters
  - setFilters
```
public void setFilters(List<String> filters)
```
    Parameters:
    
    filters - filters
  - getWorkDirectory
```
public File getWorkDirectory()
```
    Returns:
    
    workDirectory
  - setWorkDirectory
```
public void setWorkDirectory(File workDirectory)
```
    Parameters:
    
    workDirectory - workDirectory
  - getCacheFile
```
public File getCacheFile()
```
    Returns:
    
    cacheFile
  - setCacheFile
```
public void setCacheFile(File cacheFile)
```
    Parameters:
    
    cacheFile - cacheFile
  - getWarSourceIncludes
```
public String getWarSourceIncludes()
```
    Returns:
    
    warSourceIncludes
  - setWarSourceIncludes
```
public void setWarSourceIncludes(String warSourceIncludes)
```
    Parameters:
    
    warSourceIncludes - warSourceIncludes
  - getWarSourceExcludes
```
public String getWarSourceExcludes()
```
    Returns:
    
    warSourceExcludes
  - setWarSourceExcludes
```
public void setWarSourceExcludes(String warSourceExcludes)
```
    Parameters:
    
    warSourceExcludes - warSourceExcludes
  - isUseCache
```
public boolean isUseCache()
```
    Returns:
    
    useCache
  - setUseCache
```
public void setUseCache(boolean useCache)
```
    Parameters:
    
    useCache - useCache
  - getArchive
```
public MavenArchiveConfiguration getArchive()
```
    Returns:
    
    archive
  - getNonFilteredFileExtensions
```
public List<String> getNonFilteredFileExtensions()
```
    Returns:
    
    nonFilteredFileExtensions
  - setNonFilteredFileExtensions
```
public void setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)
```
    Parameters:
    
    nonFilteredFileExtensions - nonFilteredFileExtensions
  - getArtifactFactory
```
public ArtifactFactory getArtifactFactory()
```
    Returns:
    
    artifactFactory
  - setArtifactFactory
```
public void setArtifactFactory(ArtifactFactory artifactFactory)
```
    Parameters:
    
    artifactFactory - artifactFactory
  - getSession
```
protected MavenSession getSession()
```
    Returns:
    
    session
  - isRecompressZippedFiles
```
protected boolean isRecompressZippedFiles()
```
    Returns:
    
    recompressZippedFiles
  - isIncludeEmptyDirectories
```
protected boolean isIncludeEmptyDirectories()
```
    Returns:
    
    includeEmptyDirectories

Class AbstractWarMojo

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

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

Field Detail

escapeString

Constructor Detail

AbstractWarMojo

Method Detail

getCurrentProjectOverlay

getExcludes

getIncludes

getDependentWarExcludes

getDependentWarIncludes

buildExplodedWebapp

buildWebapp

getProject

setProject

getClassesDirectory

setClassesDirectory

getWebappDirectory

setWebappDirectory

getWarSourceDirectory

setWarSourceDirectory

getWebXml

setWebXml

getContainerConfigXML

setContainerConfigXML

getOutputFileNameMapping

setOutputFileNameMapping

getOverlays

setOverlays

addOverlay

isArchiveClasses

setArchiveClasses

getJarArchiver

setJarArchiver

getWebResources

setWebResources

getFilters

setFilters

getWorkDirectory

setWorkDirectory

getCacheFile

setCacheFile

getWarSourceIncludes

setWarSourceIncludes

getWarSourceExcludes

setWarSourceExcludes

isUseCache

setUseCache

getArchive

getNonFilteredFileExtensions

setNonFilteredFileExtensions

getArtifactFactory

setArtifactFactory

getSession

isRecompressZippedFiles

isIncludeEmptyDirectories