org.apache.maven.plugin.war.packaging
Class OverlayPackagingTask

java.lang.Object
  org.apache.maven.plugin.war.packaging.AbstractWarPackagingTask
      org.apache.maven.plugin.war.packaging.OverlayPackagingTask

All Implemented Interfaces:

WarPackagingTask

public class OverlayPackagingTask

extends AbstractWarPackagingTask

Handles an overlay.

Version:

$Id: OverlayPackagingTask.java 682924 2008-08-05 20:16:53Z hboutemy $

Author:

Stephane Nicoll

Field Summary

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

CLASSES_PATH, DEFAULT_INCLUDES, LIB_PATH, META_INF_PATH, WEB_INF_PATH

Constructor Summary

OverlayPackagingTask(Overlay overlay)

Method Summary

protected java.io.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 java.io.File	unpackOverlay(WarPackagingContext context, Overlay overlay) Unpacks the specified overlay.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OverlayPackagingTask

public OverlayPackagingTask(Overlay overlay)

Method Detail

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 java.io.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 java.io.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