net.nicoulaj.maven.plugins.checksum.execution.target

Class ShasumSummaryFileTarget

java.lang.Object

net.nicoulaj.maven.plugins.checksum.execution.target.ShasumSummaryFileTarget

All Implemented Interfaces:

ExecutionTarget

public class ShasumSummaryFileTarget
extends Object
implements ExecutionTarget

An ExecutionTarget that writes digests to a shasum file compatible with "shasum -b -a <algo> <files> > sha.sum". For compatibility with shasum only SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512224 and SHA-512256 are supported. Only one algorithm may be used at a time.

Since:

1.3

Author:

Julien Nicoulaud, Mike Duigou

Field Summary

Fields

Modifier and Type	Field and Description
protected SortedSet<String>	algorithms The set of algorithms encountered.
protected Iterable<? extends ArtifactListener>	artifactListeners List of listeners which are notified every time a sum file is created.
protected Map<ChecksumFile,Map<String,String>>	filesHashcodes The association file => (algorithm,hashcode).
static String	LINE_SEPARATOR The line separator character.
static String	SHASUM_BINARY_FILE The shasum binary character.
static String	SHASUM_FIELD_SEPARATOR The shasum field separator (and file type binary identifier)
protected File	summaryFile The target file where the summary is written.

Constructor Summary

Constructors

Constructor and Description
ShasumSummaryFileTarget(File summaryFile, Iterable<? extends ArtifactListener> artifactListeners) Build a new instance of ShasumSummaryFileTarget.

Method Summary

Modifier and Type	Method and Description
void	close(String subPath) Close the target.
void	init() Initialize the target.
void	write(String digest, ChecksumFile file, String algorithm) Write the hashcode calculated for the given file and algorithm to the target.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

public static final String LINE_SEPARATOR

The line separator character.

SHASUM_FIELD_SEPARATOR

public static final String SHASUM_FIELD_SEPARATOR

The shasum field separator (and file type binary identifier)

See Also:

Constant Field Values

SHASUM_BINARY_FILE

public static final String SHASUM_BINARY_FILE

The shasum binary character.

See Also:

Constant Field Values

filesHashcodes

protected Map<ChecksumFile,Map<String,String>> filesHashcodes

The association file => (algorithm,hashcode).

algorithms

protected SortedSet<String> algorithms

The set of algorithms encountered.

summaryFile

protected File summaryFile

The target file where the summary is written.

artifactListeners

protected final Iterable<? extends ArtifactListener> artifactListeners

List of listeners which are notified every time a sum file is created.

Since:

1.3

Constructor Detail

ShasumSummaryFileTarget

public ShasumSummaryFileTarget(File summaryFile,
                               Iterable<? extends ArtifactListener> artifactListeners)

Build a new instance of ShasumSummaryFileTarget.

Parameters:

summaryFile - the file to which the summary should be written.

artifactListeners - listeners which are notified every time a CSV file is created

Method Detail

init

public void init()

Initialize the target.

Should be called before first call to ExecutionTarget.write(String, ChecksumFile, String).

Specified by:

init in interface ExecutionTarget

write

public void write(String digest,
                  ChecksumFile file,
                  String algorithm)

Write the hashcode calculated for the given file and algorithm to the target.

Specified by:

write in interface ExecutionTarget

Parameters:

digest - the digest to write.

file - the file for which the digest was calculated.

algorithm - the algorithm used to calculate the digest.

close

public void close(String subPath)
           throws ExecutionTargetCloseException

Close the target.

Should be called after last call to ExecutionTarget.write(String, ChecksumFile, String).

Specified by:

close in interface ExecutionTarget

Parameters:

subPath - part of relative path to exclude from file path

Throws:

ExecutionTargetCloseException - if an error occured while closing the target.