Package nl.knaw.dans.bagit.conformance

Class ManifestChecker

java.lang.Object

nl.knaw.dans.bagit.conformance.ManifestChecker

public final class ManifestChecker
extends Object

Part of the BagIt conformance suite. This checker checks for various problems related to the manifests in a bag.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DS_STORE_FILE
private static final String	FS_EVENTS_FILE
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages
private static final String	OS_FILES_REGEX
private static final String	SPOTLIGHT_FILE
private static final String	THUMBS_DB_FILE
private static final String	TRASHES_FILE
private static final Version	VERSION_1_0

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ManifestChecker()

Method Summary

Modifier and Type	Method	Description
(package private) static void	checkAlgorthm(String algorithm, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)
private static void	checkForBagWithinBag(String line, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore, boolean isPayloadManifest)
private static void	checkForDifferentCase(String path, Set<String> paths, Path manifestFile, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)
private static String	checkForManifestCreatedWithMD5SumTools(String path, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)
private static void	checkForOSSpecificFiles(String line, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore, Path manifestFile)
private static void	checkForRelativePaths(String line, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore, Path manifestFile)
private static boolean	checkManifest(Path file, List<Path> payloadManifests, List<Path> tagManifests, Charset encoding, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)
private static void	checkManifestPayload(Path manifestFile, Charset encoding, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore, boolean isPayloadManifest)
static void	checkManifests(Version version, Path bagitDir, Charset encoding, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)	Check for all the manifest specific potential problems
(package private) static void	checkManifestSets(Version version, List<Path> tagManifests, List<Path> payloadManifests, Set<BagitWarning> warnings, Charset encoding)
(package private) static void	checkManifestsListSameSetOfFiles(Set<BagitWarning> warnings, List<Path> manifestPaths, Charset charset)
private static void	checkNormalization(String path, Path rootDir, Set<BagitWarning> warnings, Collection<BagitWarning> warningsToIgnore)
(package private) static String	getOsFilesRegex()
(package private) static String	normalizePathToNFD(Path path)
(package private) static String	parsePath(String line)

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

THUMBS_DB_FILE

private static final String THUMBS_DB_FILE

See Also:

• Constant Field Values

DS_STORE_FILE

private static final String DS_STORE_FILE

See Also:

• Constant Field Values

SPOTLIGHT_FILE

private static final String SPOTLIGHT_FILE

See Also:

• Constant Field Values

TRASHES_FILE

private static final String TRASHES_FILE

See Also:

• Constant Field Values

FS_EVENTS_FILE

private static final String FS_EVENTS_FILE

See Also:

• Constant Field Values

OS_FILES_REGEX

private static final String OS_FILES_REGEX

See Also:

• Constant Field Values

VERSION_1_0

private static final Version VERSION_1_0

Constructor Details

ManifestChecker

private ManifestChecker()

Method Details

checkManifests

public static void checkManifests(Version version,
 Path bagitDir,
 Charset encoding,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)
                           throws IOException,
InvalidBagitFileFormatException,
MaliciousPathException,
UnsupportedAlgorithmException

Check for all the manifest specific potential problems

Parameters:

version - the version of the bag we are checking

bagitDir - the directory where the manifests are stored

encoding - the encoding of the manifests

warnings - the set of warnings that will be appended to while checking

warningsToIgnore - the set of warnings to ignore

Throws:

IOException - if there is a problem reading a file (because it doesn't exist)

InvalidBagitFileFormatException - if one (or more) of the files does not match the formatting as specified in the specification

MaliciousPathException - if someone crafted the bag to specifically try and write outside the bag directory

UnsupportedAlgorithmException - if a manifest uses an algorithm that the computer doesn't know how to use

checkManifest

private static boolean checkManifest(Path file,
 List<Path> payloadManifests,
 List<Path> tagManifests,
 Charset encoding,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)
                              throws IOException,
InvalidBagitFileFormatException

Throws:

IOException

InvalidBagitFileFormatException

checkManifestPayload

private static void checkManifestPayload(Path manifestFile,
 Charset encoding,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore,
 boolean isPayloadManifest)
                                  throws IOException,
InvalidBagitFileFormatException

Throws:

IOException

InvalidBagitFileFormatException

parsePath

static String parsePath(String line)
                 throws InvalidBagitFileFormatException

Throws:

InvalidBagitFileFormatException

checkForManifestCreatedWithMD5SumTools

private static String checkForManifestCreatedWithMD5SumTools(String path,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)

checkForDifferentCase

private static void checkForDifferentCase(String path,
 Set<String> paths,
 Path manifestFile,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)

checkNormalization

private static void checkNormalization(String path,
 Path rootDir,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)
                                throws IOException

Throws:

IOException

normalizePathToNFD

static String normalizePathToNFD(Path path)

checkForBagWithinBag

private static void checkForBagWithinBag(String line,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore,
 boolean isPayloadManifest)

checkForRelativePaths

private static void checkForRelativePaths(String line,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore,
 Path manifestFile)

checkForOSSpecificFiles

private static void checkForOSSpecificFiles(String line,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore,
 Path manifestFile)

checkAlgorthm

static void checkAlgorthm(String algorithm,
 Set<BagitWarning> warnings,
 Collection<BagitWarning> warningsToIgnore)

checkManifestSets

static void checkManifestSets(Version version,
 List<Path> tagManifests,
 List<Path> payloadManifests,
 Set<BagitWarning> warnings,
 Charset encoding)
                       throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Throws:

IOException

MaliciousPathException

UnsupportedAlgorithmException

InvalidBagitFileFormatException

checkManifestsListSameSetOfFiles

static void checkManifestsListSameSetOfFiles(Set<BagitWarning> warnings,
 List<Path> manifestPaths,
 Charset charset)
                                      throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Throws:

IOException

MaliciousPathException

UnsupportedAlgorithmException

InvalidBagitFileFormatException

getOsFilesRegex

static String getOsFilesRegex()