gov.loc.repository.bagit.verify

Class ManifestVerifier

java.lang.Object

gov.loc.repository.bagit.verify.ManifestVerifier

All Implemented Interfaces:

java.lang.AutoCloseable

public class ManifestVerifier
extends java.lang.Object
implements java.lang.AutoCloseable

Responsible for all things related to the manifest during verification.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
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

Constructor Detail

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(java.util.concurrent.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,
                        java.util.concurrent.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 Detail

close

public void close()
           throws java.lang.SecurityException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.SecurityException

verifyManifests

public void verifyManifests(Bag bag,
                            boolean ignoreHiddenFiles)
                     throws java.io.IOException,
                            MaliciousPathException,
                            UnsupportedAlgorithmException,
                            InvalidBagitFileFormatException,
                            FileNotInPayloadDirectoryException,
                            java.lang.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:

java.io.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

java.lang.InterruptedException - if a thread is interrupted while doing work