Package nz.org.riskscape.engine.pipeline

Class Manifest

java.lang.Object

nz.org.riskscape.engine.pipeline.Manifest

public class Manifest
extends Object

metadata from the execution of a pipeline

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Manifest.LocalInfo
static class	Manifest.OutputInfo
static class	Manifest.StepDescription
static class	Manifest.VersionInfo

Field Summary

Fields

Modifier and Type	Field	Description
LocalDateTime	finishTime
Manifest.LocalInfo	localInfo
static final String	MANIFEST_FILE	Filename of manifest file.
List<Manifest.OutputInfo>	outputs
String	pipelineDescription
String	pipelineId
LocalDateTime	startTime
List<Manifest.StepDescription>	steps
List<Manifest.VersionInfo>	versionInfo

Constructor Summary

Constructors

Constructor	Description
Manifest()
Manifest(RealizedPipeline realized)
Manifest(RealizedPipeline realized, LocalDateTime startTime)

Method Summary

Modifier and Type	Method	Description
void	add(Manifest.OutputInfo info)	Add Manifest.OutputInfo to this manifest.
static String	checksum(MessageDigest md)	Produces a checksum from the MessageDigest as a String.
static MessageDigest	getDigestInstance()	Get a new instance of a MessageDigest of the type used for Manifest checksums.
static void	verify(Path manifestFile, Formatter out)	Verifies that the output files contained in manifest.txt have not been tampered with.
void	write(OutputStream output)	Write the manifest to pipelineDirectory.
void	writeTo(Formatter f)	Write the manifest file describing a pipeline run.

Methods inherited from class java.lang.Object

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

Field Details

MANIFEST_FILE

public static final String MANIFEST_FILE

Filename of manifest file.

See Also:

• Constant Field Values

pipelineId

public String pipelineId

pipelineDescription

public String pipelineDescription

steps

public List<Manifest.StepDescription> steps

startTime

public LocalDateTime startTime

finishTime

public LocalDateTime finishTime

outputs

public List<Manifest.OutputInfo> outputs

versionInfo

public List<Manifest.VersionInfo> versionInfo

localInfo

public Manifest.LocalInfo localInfo

Constructor Details

Manifest

public Manifest()

Manifest

public Manifest(RealizedPipeline realized,
 LocalDateTime startTime)

Manifest

public Manifest(RealizedPipeline realized)

Method Details

verify

public static void verify(Path manifestFile,
 Formatter out)

Verifies that the output files contained in manifest.txt have not been tampered with.

Parameters:

manifestFile - path to the manifest file to verify, if this is a directory then MANIFEST_FILE is appended

out - Formatter to write verification results to.

getDigestInstance

public static MessageDigest getDigestInstance()

Get a new instance of a MessageDigest of the type used for Manifest checksums.

The returned MessageDigest may be used with DigestOutputStream to be updated as an output file is written.

Returns:

message digest

checksum

public static String checksum(MessageDigest md)

Produces a checksum from the MessageDigest as a String.

Parameters:

md - digest to checksum

Returns:

checksum from md as a string

write

public void write(OutputStream output)

Write the manifest to pipelineDirectory.

Parameters:

output - stream to write manifest bytes to. Expected to contain outputs.

writeTo

public void writeTo(Formatter f)

Write the manifest file describing a pipeline run.

Parameters:

f - Formatter to write to

add

public void add(Manifest.OutputInfo info)

Add Manifest.OutputInfo to this manifest.

Using this method is preferred as it takes care of concurrency.

Parameters:

info - output info to add