Package nl.knaw.dans.bagit.reader

Class ManifestReader

java.lang.Object

nl.knaw.dans.bagit.reader.ManifestReader

public final class ManifestReader
extends Object

This class is responsible for reading and parsing manifest files on the filesystem

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ManifestReader()

Method Summary

Modifier and Type	Method	Description
private static DirectoryStream<Path>	getAllManifestFiles(Path rootDir)
(package private) static void	readAllManifests(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping, Path rootDir, Bag bag)	Finds and reads all manifest files in the rootDir and adds them to the given bag.
(package private) static Map<Path,String>	readChecksumFileMap(Path manifestFile, Path bagRootDir, Charset charset)
static Manifest	readManifest(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping, Path manifestFile, Path bagRootDir, Charset charset)	Reads a manifest file and converts it to a Manifest object.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

messages

private static final ResourceBundle messages

Constructor Details

ManifestReader

private ManifestReader()

Method Details

readAllManifests

static void readAllManifests(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping,
 Path rootDir,
 Bag bag)
                      throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Finds and reads all manifest files in the rootDir and adds them to the given bag.

Parameters:

nameMapping - a map between BagIt algorithm names and MessageDigest names

rootDir - the directory that contain the manifest(s)

bag - to update with the manifests

Throws:

IOException - if there is a problem reading a file

MaliciousPathException - if there is path that is referenced in the manifest that is outside the bag root directory

UnsupportedAlgorithmException - if the manifest uses a algorithm that isn't supported

InvalidBagitFileFormatException - if the manifest is not formatted properly

getAllManifestFiles

private static DirectoryStream<Path> getAllManifestFiles(Path rootDir)
                                                  throws IOException

Throws:

IOException

readManifest

public static Manifest readManifest(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping,
 Path manifestFile,
 Path bagRootDir,
 Charset charset)
                             throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Reads a manifest file and converts it to a Manifest object.

Parameters:

nameMapping - a map between BagIt algorithm names and MessageDigest names

manifestFile - a specific manifest file

bagRootDir - the root directory of the bag

charset - the encoding to use when reading the manifest file

Returns:

the converted manifest object from the file

Throws:

IOException - if there is a problem reading a file

MaliciousPathException - if there is path that is referenced in the manifest that is outside the bag root directory

UnsupportedAlgorithmException - if the manifest uses a algorithm that isn't supported

InvalidBagitFileFormatException - if the manifest is not formatted properly

readChecksumFileMap

static Map<Path,String> readChecksumFileMap(Path manifestFile,
 Path bagRootDir,
 Charset charset)
                                     throws IOException,
MaliciousPathException,
InvalidBagitFileFormatException

Throws:

IOException

MaliciousPathException

InvalidBagitFileFormatException