org.alfresco.maven.plugin.amp.packaging
Class OverlayPackagingTask

java.lang.Object
  org.alfresco.maven.plugin.amp.packaging.AbstractAmpPackagingTask
      org.alfresco.maven.plugin.amp.packaging.OverlayPackagingTask

All Implemented Interfaces:

AmpPackagingTask

public class OverlayPackagingTask
extends AbstractAmpPackagingTask

Handles an overlay.

Author:

Stephane Nicoll

Field Summary

Fields inherited from class org.alfresco.maven.plugin.amp.packaging.AbstractAmpPackagingTask

DEFAULT_INCLUDES, META_INF_PATH

Constructor Summary

OverlayPackagingTask(Overlay overlay)

Method Summary

protected File	getOverlayTempDirectory(AmpPackagingContext context, Overlay overlay) Returns the directory to use to unpack the specified overlay.
void	performPackaging(AmpPackagingContext context) Performs the packaging for the specified task.
protected File	unpackOverlay(AmpPackagingContext context, Overlay overlay) Unpacks the specified overlay.

Methods inherited from class org.alfresco.maven.plugin.amp.packaging.AbstractAmpPackagingTask

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(AmpPackagingContext context)
                      throws org.apache.maven.plugin.MojoExecutionException

Description copied from interface: AmpPackagingTask

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 occured

unpackOverlay

protected File unpackOverlay(AmpPackagingContext 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 occured while unpacking the overlay

getOverlayTempDirectory

protected File getOverlayTempDirectory(AmpPackagingContext 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