Package nl.knaw.dans.bagit.verify

Class MandatoryVerifier

java.lang.Object

nl.knaw.dans.bagit.verify.MandatoryVerifier

public final class MandatoryVerifier
extends Object

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MandatoryVerifier()

Method Summary

Modifier and Type	Method	Description
static void	checkBagitFileExists(Path rootDir, Version version)	make sure the bagit.txt file exists
static void	checkFetchItemsExist(List<FetchItem> items, Path bagDir)	make sure all the fetch items exist in the data directory
static void	checkIfAtLeastOnePayloadManifestsExist(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

Field Details

logger

private static final org.slf4j.Logger logger

messages

private static final ResourceBundle messages

DOT_BAGIT_DIR_NAME

private static final String DOT_BAGIT_DIR_NAME

See Also:

• Constant Field Values

Constructor Details

MandatoryVerifier

private MandatoryVerifier()

Method Details

checkFetchItemsExist

public static void checkFetchItemsExist(List<FetchItem> items,
 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(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(Path rootDir,
 Version version)
                                                   throws MissingPayloadManifestException,
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

IOException - if there was an error reading a file