gov.loc.repository.bagit.reader

Class FetchReader

java.lang.Object

gov.loc.repository.bagit.reader.FetchReader

public final class FetchReader
extends java.lang.Object

This class is responsible for reading and parsing fetch.txt file from the filesystem

Method Summary

Modifier and Type	Method and Description
static java.util.List<FetchItem>	readFetch(java.nio.file.Path fetchFile, java.nio.charset.Charset encoding, java.nio.file.Path bagRootDir) Reads a fetch.txt file

Methods inherited from class java.lang.Object

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

Method Detail

readFetch

public static java.util.List<FetchItem> readFetch(java.nio.file.Path fetchFile,
                                                  java.nio.charset.Charset encoding,
                                                  java.nio.file.Path bagRootDir)
                                           throws java.io.IOException,
                                                  MaliciousPathException,
                                                  InvalidBagitFileFormatException

Reads a fetch.txt file

Parameters:

fetchFile - the specific fetch file

encoding - the encoding to read the file with

bagRootDir - the root directory of the bag

Returns:

a list of items to fetch

Throws:

java.io.IOException - if there is a problem reading a file

MaliciousPathException - if the path was crafted to point outside the bag directory

InvalidBagitFileFormatException - if the fetch format does not follow the bagit specification