Package nl.knaw.dans.bagit.reader

Class BagReader

java.lang.Object

nl.knaw.dans.bagit.reader.BagReader

public final class BagReader
extends Object

Responsible for reading a bag from the filesystem.

Field Summary

Fields

Modifier and Type	Field	Description
private final BagitAlgorithmNameToSupportedAlgorithmMapping	nameMapping

Constructor Summary

Constructors

Constructor	Description
BagReader()
BagReader(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping)

Method Summary

Modifier and Type	Method	Description
BagitAlgorithmNameToSupportedAlgorithmMapping	getNameMapping()
Bag	read(Path rootDir)	Read the bag from the filesystem and create a bag object

Methods inherited from class java.lang.Object

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

Field Details

nameMapping

private final BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping

Constructor Details

BagReader

public BagReader()

BagReader

public BagReader(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping)

Method Details

read

public Bag read(Path rootDir)
         throws IOException,
UnparsableVersionException,
MaliciousPathException,
InvalidBagMetadataException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Read the bag from the filesystem and create a bag object

Parameters:

rootDir - the root directory of the bag

Returns:

a Bag object representing a bag on the filesystem

Throws:

IOException - if there is a problem reading a file

UnparsableVersionException - If there is a problem parsing the bagit version

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

InvalidBagMetadataException - if the metadata or bagit.txt file does not conform to the bagit spec

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

InvalidBagitFileFormatException - if the manifest or fetch file is not formatted properly

getNameMapping

public BagitAlgorithmNameToSupportedAlgorithmMapping getNameMapping()