Package org.apache.maven.plugins.war.packaging

Class OverlayPackagingTask

java.lang.Object

org.apache.maven.plugins.war.packaging.AbstractWarPackagingTask

org.apache.maven.plugins.war.packaging.OverlayPackagingTask

All Implemented Interfaces:

WarPackagingTask

public class OverlayPackagingTask
extends AbstractWarPackagingTask

Handles an overlay.

Author:

Stephane Nicoll

Field Summary

Fields inherited from class org.apache.maven.plugins.war.packaging.AbstractWarPackagingTask

CLASSES_PATH, DEFAULT_INCLUDES, LIB_PATH, META_INF_PATH, WEB_INF_PATH

Constructor Summary

Constructors

Constructor	Description
OverlayPackagingTask(Overlay overlay, Overlay currentProjectOverlay)

Method Summary

Modifier and Type	Method	Description
protected File	getOverlayTempDirectory(WarPackagingContext context, Overlay overlay)	Returns the directory to use to unpack the specified overlay.
void	performPackaging(WarPackagingContext context)	Performs the packaging for the specified task.
protected File	unpackOverlay(WarPackagingContext context, Overlay overlay)	Unpacks the specified overlay.

Methods inherited from class org.apache.maven.plugins.war.packaging.AbstractWarPackagingTask

copyFile, copyFile, copyFiles, copyFiles, copyFilteredFile, doUnpack, getArtifactFinalName, getEncoding, getFilesToIncludes, getFilesToIncludes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OverlayPackagingTask

public OverlayPackagingTask(Overlay overlay,
 Overlay currentProjectOverlay)

Parameters:

overlay - overlay

currentProjectOverlay - current overlay.

Method Details

performPackaging

public void performPackaging(WarPackagingContext context)
                      throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: WarPackagingTask

Performs the packaging for the specified task. The task is responsible to update the packaging context, namely with the files that have been copied.

Parameters:

context - the packaging context

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurred

unpackOverlay

protected File unpackOverlay(WarPackagingContext context,
 Overlay overlay)
                      throws org.apache.maven.plugin.MojoExecutionException

Unpacks the specified overlay. Makes sure to skip the unpack process if the overlay has already been unpacked.

Parameters:

context - the packaging context

overlay - the overlay

Returns:

the directory containing the unpacked overlay

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurred while unpacking the overlay

getOverlayTempDirectory

protected File getOverlayTempDirectory(WarPackagingContext context,
 Overlay overlay)

Returns the directory to use to unpack the specified overlay.

Parameters:

context - the packaging context

overlay - the overlay

Returns:

the temp directory for the overlay