gov.loc.repository.bagit.verify

Class MandatoryVerifier

java.lang.Object

gov.loc.repository.bagit.verify.MandatoryVerifier

public final class MandatoryVerifier
extends java.lang.Object

Responsible for checking all things related to mandatory files for the bagit specification

Method Summary

Modifier and Type	Method and Description
static void	checkBagitFileExists(java.nio.file.Path rootDir, Version version) make sure the bagit.txt file exists
static void	checkFetchItemsExist(java.util.List<FetchItem> items, java.nio.file.Path bagDir) make sure all the fetch items exist in the data directory
static void	checkIfAtLeastOnePayloadManifestsExist(java.nio.file.Path rootDir, Version version) Check to make sure the bag has at least one payload manifest (manifest-[ALGORITHM].txt)
static void	checkPayloadDirectoryExists(Bag bag) Make sure the payload directory exists

Methods inherited from class java.lang.Object

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

Method Detail

checkFetchItemsExist

public static void checkFetchItemsExist(java.util.List<FetchItem> items,
                                        java.nio.file.Path bagDir)
                                 throws FileNotInPayloadDirectoryException

make sure all the fetch items exist in the data directory

Parameters:

items - the items that needed to be fetched for the bag to be complete

bagDir - the root directory of the bag

Throws:

FileNotInPayloadDirectoryException - if one or more of the fetch items don't exist

checkBagitFileExists

public static void checkBagitFileExists(java.nio.file.Path rootDir,
                                        Version version)
                                 throws MissingBagitFileException

make sure the bagit.txt file exists

Parameters:

rootDir - the root directory of the bag

version - the version of the bag

Throws:

MissingBagitFileException - if the bag does not contain the bagit.txt file as required by the bagit specification

checkPayloadDirectoryExists

public static void checkPayloadDirectoryExists(Bag bag)
                                        throws MissingPayloadDirectoryException

Make sure the payload directory exists

Parameters:

bag - the bag to check

Throws:

MissingPayloadDirectoryException - if the bag does not contain the payload directory

checkIfAtLeastOnePayloadManifestsExist

public static void checkIfAtLeastOnePayloadManifestsExist(java.nio.file.Path rootDir,
                                                          Version version)
                                                   throws MissingPayloadManifestException,
                                                          java.io.IOException

Check to make sure the bag has at least one payload manifest (manifest-[ALGORITHM].txt)

Parameters:

rootDir - the root directory of the bag

version - the version of the bag

Throws:

MissingPayloadManifestException - if there are no payload manifests in the bag

java.io.IOException - if there was an error reading a file