Module com.aoapps.ant.tasks

Package com.aoapps.ant.tasks

Class ZipTimestampMerge

java.lang.Object

com.aoapps.ant.tasks.ZipTimestampMerge

public final class ZipTimestampMerge
extends Object

Standalone implementation of ZIP-file timestamp merging.

Note: This task should be performed before GenerateJavadocSitemap in order to have correct timestamps inside the generated sitemaps.

This does not have any direct Ant dependencies. If only using this class, it is permissible to exclude the ant dependencies.

See The structure of a PKZip file.

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
static void	mergeDirectory(Instant outputTimestamp, boolean buildReproducible, boolean requireLastBuild, File lastBuildDirectory, File buildDirectory)	Merges all *.aar, *.jar, *.war, and *.zip files between lastBuildDirectory and buildDirectory.
static void	mergeFile(Instant outputTimestamp, boolean buildReproducible, File lastBuildArtifact, File buildArtifact)	Creates a ZIP file with contents matching buildArtifact but with timestamps derived from lastBuildArtifact.

Methods inherited from class java.lang.Object

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

Method Details

mergeFile

public static void mergeFile(Instant outputTimestamp,
 boolean buildReproducible,
 File lastBuildArtifact,
 File buildArtifact)
                      throws IOException

Creates a ZIP file with contents matching buildArtifact but with timestamps derived from lastBuildArtifact.

For each entry, if the content is byte-for-byte equal, maintains the time.

Parameters:

outputTimestamp - See ZipTimestampMergeTask.setOutputTimestamp(java.lang.String)

buildReproducible - See ZipTimestampMergeTask.setBuildReproducible(boolean)

lastBuildArtifact - The ZIP file from the last successful build

buildArtifact - The ZIP file from the current build

Throws:

IOException

mergeDirectory

public static void mergeDirectory(Instant outputTimestamp,
 boolean buildReproducible,
 boolean requireLastBuild,
 File lastBuildDirectory,
 File buildDirectory)
                           throws IOException,
ParseException

Merges all *.aar, *.jar, *.war, and *.zip files between lastBuildDirectory and buildDirectory. Artifacts in buildDirectory are overwritten in-place only when altered.

Identifies the one-to-one mappings by matching artifactId, classifier (optional), and type. These are parsed from the filenames and make the following assumptions:

1. All fields are separated by hyphens '-'
2. Version number begins with [0-9]
3. Type is everything after the final period and contains only [a-zA-Z]
4. Classifier is before the final period and contains only [a-z-]

There must be only one possible mapping per unique (artifactId, classifier, type). When requireLastBuild = true, there must be a one-to-one mapping in both directions between lastBuildDirectory and buildDirectory. No file may be added or missing.

Each mappings are resolved, calls mergeFile(java.time.Instant, boolean, java.io.File, java.io.File) for each pair of files.

Parameters:

outputTimestamp - See ZipTimestampMergeTask.setOutputTimestamp(java.lang.String)

buildReproducible - See ZipTimestampMergeTask.setBuildReproducible(boolean)

requireLastBuild - See ZipTimestampMergeTask.setRequireLastBuild(boolean)

lastBuildDirectory - See ZipTimestampMergeTask.setLastBuildDirectory(java.lang.String)

buildDirectory - See ZipTimestampMergeTask.setBuildDirectory(java.lang.String)

Throws:

IOException

ParseException