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.
  • Field Details

    • overlay

      private final Overlay overlay
  • 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