gov.loc.repository.bagit.reader

Class ManifestReader

java.lang.Object

gov.loc.repository.bagit.reader.ManifestReader

public final class ManifestReader
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
static Manifest	readManifest(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping, java.nio.file.Path manifestFile, java.nio.file.Path bagRootDir, java.nio.charset.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

Method Detail

readManifest

public static Manifest readManifest(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping,
                                    java.nio.file.Path manifestFile,
                                    java.nio.file.Path bagRootDir,
                                    java.nio.charset.Charset charset)
                             throws java.io.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:

java.io.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