Package nl.knaw.dans.bagit.verify

Class ManifestVerifier

java.lang.Object

nl.knaw.dans.bagit.verify.ManifestVerifier

All Implemented Interfaces:

AutoCloseable

public class ManifestVerifier
extends Object
implements AutoCloseable

Responsible for all things related to the manifest during verification.

Field Summary

Fields

Modifier and Type	Field	Description
private final ExecutorService	executor
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages
private final BagitAlgorithmNameToSupportedAlgorithmMapping	nameMapping

Constructor Summary

Constructors

Constructor	Description
ManifestVerifier()	Create a PayloadVerifier using a cached thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping
ManifestVerifier(ExecutorService executor)	Create a PayloadVerifier using a custom thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping
ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping)	Create a PayloadVerifier using a cached thread pool and a custom mapping
ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping, ExecutorService executor)	Create a PayloadVerifier using a custom thread pool and a custom mapping

Method Summary

Modifier and Type	Method	Description
private static void	CheckAllFilesInPayloadDirAreListedInAllManifests(Set<Manifest> payLoadManifests, Path payloadDir, boolean ignoreHiddenFiles)
private static void	checkAllFilesInPayloadDirAreListedInAtLeastOneAManifest(Set<Path> filesListedInManifests, Path payloadDir, boolean ignoreHiddenFiles)
private void	checkAllFilesListedInManifestExist(Set<Path> files)
void	close()
private Set<Path>	getAllFilesListedInManifests(Bag bag)
void	verifyManifests(Bag bag, boolean ignoreHiddenFiles)	Verify that all the files in the payload directory are listed in the payload manifest and all files listed in all manifests exist.

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

nameMapping

private final transient BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping

executor

private final transient ExecutorService executor

Constructor Details

ManifestVerifier

public ManifestVerifier()

Create a PayloadVerifier using a cached thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping

ManifestVerifier

public ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping)

Create a PayloadVerifier using a cached thread pool and a custom mapping

Parameters:

nameMapping - the mapping between BagIt algorithm name and the java supported algorithm

ManifestVerifier

public ManifestVerifier(ExecutorService executor)

Create a PayloadVerifier using a custom thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping

Parameters:

executor - the thread pool to use when doing work

ManifestVerifier

public ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping nameMapping,
 ExecutorService executor)

Create a PayloadVerifier using a custom thread pool and a custom mapping

Parameters:

nameMapping - the mapping between BagIt algorithm name and the java supported algorithm

executor - the thread pool to use when doing work

Method Details

close

public void close()
           throws SecurityException

Specified by:

close in interface AutoCloseable

Throws:

SecurityException

verifyManifests

public void verifyManifests(Bag bag,
 boolean ignoreHiddenFiles)
                     throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException,
FileNotInPayloadDirectoryException,
InterruptedException

Verify that all the files in the payload directory are listed in the payload manifest and all files listed in all manifests exist.

Parameters:

bag - the bag to check to check

ignoreHiddenFiles - to ignore hidden files unless they are specifically listed in a manifest

Throws:

IOException - if there is a problem reading a file

MaliciousPathException - the path in the manifest was specifically crafted to cause harm

UnsupportedAlgorithmException - if the algorithm used for the manifest is unsupported

InvalidBagitFileFormatException - if any of the manifests don't conform to the bagit specification

FileNotInPayloadDirectoryException - if a file is listed in a manifest but doesn't exist in the payload directory

InterruptedException - if a thread is interrupted while doing work

getAllFilesListedInManifests

private Set<Path> getAllFilesListedInManifests(Bag bag)
                                        throws IOException,
MaliciousPathException,
UnsupportedAlgorithmException,
InvalidBagitFileFormatException

Throws:

IOException

MaliciousPathException

UnsupportedAlgorithmException

InvalidBagitFileFormatException

checkAllFilesListedInManifestExist

private void checkAllFilesListedInManifestExist(Set<Path> files)
                                         throws FileNotInPayloadDirectoryException,
InterruptedException

Throws:

FileNotInPayloadDirectoryException

InterruptedException

checkAllFilesInPayloadDirAreListedInAtLeastOneAManifest

private static void checkAllFilesInPayloadDirAreListedInAtLeastOneAManifest(Set<Path> filesListedInManifests,
 Path payloadDir,
 boolean ignoreHiddenFiles)
                                                                     throws IOException

Throws:

IOException

CheckAllFilesInPayloadDirAreListedInAllManifests

private static void CheckAllFilesInPayloadDirAreListedInAllManifests(Set<Manifest> payLoadManifests,
 Path payloadDir,
 boolean ignoreHiddenFiles)
                                                              throws IOException

Throws:

IOException