gov.loc.repository.bagit.verify

Class Verifier

java.lang.Object

gov.loc.repository.bagit.verify.Verifier

public class Verifier
extends java.lang.Object

Responsible for verifying if a bag is valid, complete

Constructor Summary

Constructors

Constructor and Description
Verifier()

Method Summary

Modifier and Type	Method and Description
protected static void	checkAllFilesInPayloadDirAreListedInAManifest(java.util.Set<java.io.File> filesListedInManifests, java.io.File rootDir, boolean ignoreHiddenFiles)
protected static void	checkAllFilesListedInManifestExist(java.util.Set<java.io.File> files)
protected static void	checkBagitFileExists(java.io.File rootDir)
protected static void	checkHashes(Manifest manifest)
protected static void	checkIfAtLeastOnePayloadManifestsExist(java.io.File rootDir)
protected static void	checkPayloadDirectoryExists(java.io.File rootDir)
protected static java.util.Set<java.io.File>	getAllFilesListedInManifests(Bag bag)
static void	isComplete(Bag bag, boolean ignoreHiddenFiles) See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3 A bag is complete if every element is present every file in the payload manifest(s) are present every file in the tag manifest(s) are present.
static void	isValid(Bag bag, boolean ignoreHiddenFiles) See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3 A bag is valid if the bag is complete and every checksum has been verified against the contents of its corresponding file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Verifier

public Verifier()

Method Detail

isValid

public static void isValid(Bag bag,
                           boolean ignoreHiddenFiles)
                    throws java.lang.Exception

See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3
A bag is valid if the bag is complete and every checksum has been verified against the contents of its corresponding file.

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

FileNotInPayloadDirectoryException

MissingPayloadDirectoryException

MissingBagitFileException

MissingPayloadManifestException

CorruptChecksumException

java.lang.InterruptedException

java.lang.Exception

checkHashes

protected static void checkHashes(Manifest manifest)
                           throws java.lang.Exception

Throws:

CorruptChecksumException - if any of the files computed checksum is different than the manifest supplied checksum

java.lang.Exception

isComplete

public static void isComplete(Bag bag,
                              boolean ignoreHiddenFiles)
                       throws java.io.IOException,
                              MissingPayloadManifestException,
                              MissingBagitFileException,
                              MissingPayloadDirectoryException,
                              FileNotInPayloadDirectoryException,
                              java.lang.InterruptedException

See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3
A bag is complete if

• every element is present
• every file in the payload manifest(s) are present
• every file in the tag manifest(s) are present. Tag files not listed in a tag manifest may be present.
• every file in the data directory must be listed in at least one payload manifest
• each element must comply with the bagit spec

Throws:

java.io.IOException - if there was an error with the file

MissingPayloadManifestException - if there is not at least one payload manifest

MissingBagitFileException - if there is no bagit.txt file

MissingPayloadDirectoryException - if there is no /data directory

FileNotInPayloadDirectoryException - if a manifest lists a file but it is not in the payload directory

java.lang.InterruptedException

checkBagitFileExists

protected static void checkBagitFileExists(java.io.File rootDir)
                                    throws MissingBagitFileException

Throws:

MissingBagitFileException

checkPayloadDirectoryExists

protected static void checkPayloadDirectoryExists(java.io.File rootDir)
                                           throws MissingPayloadDirectoryException

Throws:

MissingPayloadDirectoryException

checkIfAtLeastOnePayloadManifestsExist

protected static void checkIfAtLeastOnePayloadManifestsExist(java.io.File rootDir)
                                                      throws MissingPayloadManifestException

Throws:

MissingPayloadManifestException

getAllFilesListedInManifests

protected static java.util.Set<java.io.File> getAllFilesListedInManifests(Bag bag)
                                                                   throws java.io.IOException

Throws:

java.io.IOException

checkAllFilesListedInManifestExist

protected static void checkAllFilesListedInManifestExist(java.util.Set<java.io.File> files)
                                                  throws FileNotInPayloadDirectoryException,
                                                         java.lang.InterruptedException

Throws:

FileNotInPayloadDirectoryException

java.lang.InterruptedException

checkAllFilesInPayloadDirAreListedInAManifest

protected static void checkAllFilesInPayloadDirAreListedInAManifest(java.util.Set<java.io.File> filesListedInManifests,
                                                                    java.io.File rootDir,
                                                                    boolean ignoreHiddenFiles)
                                                             throws java.io.IOException

Throws:

java.io.IOException