Package org.apache.maven.plugins.war

Class WarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.war.AbstractWarMojo

org.apache.maven.plugins.war.WarMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="war",
      defaultPhase=PACKAGE,
      threadSafe=true,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class WarMojo
extends AbstractWarMojo

Build a WAR file.

Author:

Emmanuel Venisse

Field Summary

Fields inherited from class org.apache.maven.plugins.war.AbstractWarMojo

escapeString, failOnMissingWebXml, outputTimestamp, propertiesEncoding

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

ROLE

Constructor Summary

Constructors

Constructor	Description
WarMojo(org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter, org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the WarMojo on the current project.
String	getClassesClassifier()
String	getClassifier()
String	getOutputDirectory()
org.apache.maven.project.MavenProjectHelper	getProjectHelper()
protected File	getTargetClassesFile()
protected static File	getTargetFile(File basedir, String finalName, String classifier, String type)
protected File	getTargetWarFile()
org.codehaus.plexus.archiver.war.WarArchiver	getWarArchiver()
String	getWarName()
boolean	isAttachClasses()
boolean	isFailOnMissingWebXml()
boolean	isPrimaryArtifact()
boolean	isSkip()	Skip the mojo run
void	setAttachClasses(boolean attachClasses)
void	setClassesClassifier(String classesClassifier)
void	setClassifier(String classifier)
void	setFailOnMissingWebXml(boolean failOnMissingWebXml)
void	setOutputDirectory(String outputDirectory)
void	setPrimaryArtifact(boolean primaryArtifact)
void	setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)
void	setWarArchiver(org.codehaus.plexus.archiver.war.WarArchiver warArchiver)
void	setWarName(String warName)

Methods inherited from class org.apache.maven.plugins.war.AbstractWarMojo

addOverlay, buildExplodedWebapp, buildWebapp, getArchive, getArtifactFactory, getClassesDirectory, getContainerConfigXML, getCurrentProjectOverlay, getDependentWarExcludes, getDependentWarIncludes, getExcludes, getFilters, getIncludes, getJarArchiver, getNonFilteredFileExtensions, getOutputFileNameMapping, getOverlays, getPackagingExcludes, getPackagingIncludes, getProject, getSession, getWarSourceDirectory, getWarSourceExcludes, getWarSourceIncludes, getWebappDirectory, getWebResources, getWebXml, getWorkDirectory, isArchiveClasses, isIncludeEmptyDirectories, isRecompressZippedFiles, setClassesDirectory, setContainerConfigXML, setOutputFileNameMapping, setOverlays, setPackagingExcludes, setPackagingIncludes, setProject, setWarSourceDirectory, setWebappDirectory, setWebResources, setWebXml

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

Constructor Details

WarMojo

@Inject
public WarMojo(org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver,
 org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
 org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
 @Named("default")
 org.apache.maven.shared.filtering.MavenFileFilter mavenFileFilter,
 @Named("default")
 org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering)

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Executes the WarMojo on the current project.

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurred while building the webapp

org.apache.maven.plugin.MojoFailureException - if an error.

getTargetFile

protected static File getTargetFile(File basedir,
 String finalName,
 String classifier,
 String type)

Parameters:

basedir - The basedir

finalName - The finalName

classifier - The classifier.

type - The type.

Returns:

File

getTargetWarFile

protected File getTargetWarFile()

Returns:

The war File

getTargetClassesFile

protected File getTargetClassesFile()

Returns:

The target class File

getClassifier

public String getClassifier()

Returns:

classifier

setClassifier

public void setClassifier(String classifier)

Parameters:

classifier - classifier

getOutputDirectory

public String getOutputDirectory()

Returns:

outputDirectory

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Parameters:

outputDirectory - outputDirectory

getWarName

public String getWarName()

Returns:

warName

setWarName

public void setWarName(String warName)

Parameters:

warName - warName

getWarArchiver

public org.codehaus.plexus.archiver.war.WarArchiver getWarArchiver()

Returns:

warArchiver

setWarArchiver

public void setWarArchiver(org.codehaus.plexus.archiver.war.WarArchiver warArchiver)

Parameters:

warArchiver - warArchiver

getProjectHelper

public org.apache.maven.project.MavenProjectHelper getProjectHelper()

Returns:

projectHelper

setProjectHelper

public void setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)

Parameters:

projectHelper - projectHelper

isPrimaryArtifact

public boolean isPrimaryArtifact()

Returns:

primaryArtifact

setPrimaryArtifact

public void setPrimaryArtifact(boolean primaryArtifact)

Parameters:

primaryArtifact - primaryArtifact

isAttachClasses

public boolean isAttachClasses()

Returns:

attachClasses

setAttachClasses

public void setAttachClasses(boolean attachClasses)

Parameters:

attachClasses - attachClasses

getClassesClassifier

public String getClassesClassifier()

Returns:

classesClassifier

setClassesClassifier

public void setClassesClassifier(String classesClassifier)

Parameters:

classesClassifier - classesClassifier

isFailOnMissingWebXml

public boolean isFailOnMissingWebXml()

Returns:

AbstractWarMojo.failOnMissingWebXml

setFailOnMissingWebXml

public void setFailOnMissingWebXml(boolean failOnMissingWebXml)

Parameters:

failOnMissingWebXml - AbstractWarMojo.failOnMissingWebXml

isSkip

public boolean isSkip()

Skip the mojo run

Returns:

skip