gov.loc.repository.bagit.conformance

Class BagLinter

java.lang.Object

gov.loc.repository.bagit.conformance.BagLinter

public final class BagLinter
extends java.lang.Object

Responsible for checking a bag and providing insight into how it cause problems. This class is only to be used on VALID bags, using it on un-validated bags may result in exceptions being thrown (like IOException )

Method Summary

Modifier and Type	Method and Description
static void	checkAgainstProfile(java.io.InputStream jsonProfile, Bag bag) Check a bag against a bagit-profile as described by https://github.com/ruebot/bagit-profiles Note: This implementation does not check the Serialization part of the profile!
static java.util.Set<BagitWarning>	lintBag(java.nio.file.Path rootDir) The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged.
static java.util.Set<BagitWarning>	lintBag(java.nio.file.Path rootDir, java.util.Collection<BagitWarning> warningsToIgnore) The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged.

Methods inherited from class java.lang.Object

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

Method Detail

checkAgainstProfile

public static void checkAgainstProfile(java.io.InputStream jsonProfile,
                                       Bag bag)
                                throws com.fasterxml.jackson.core.JsonParseException,
                                       com.fasterxml.jackson.databind.JsonMappingException,
                                       java.io.IOException,
                                       FetchFileNotAllowedException,
                                       RequiredMetadataFieldNotPresentException,
                                       MetatdataValueIsNotAcceptableException,
                                       RequiredManifestNotPresentException,
                                       BagitVersionIsNotAcceptableException,
                                       RequiredTagFileNotPresentException,
                                       MetatdataValueIsNotRepeatableException

Check a bag against a bagit-profile as described by https://github.com/ruebot/bagit-profiles
Note: This implementation does not check the Serialization part of the profile!

Parameters:

jsonProfile - the input stream to the json string describing the profile

bag - the bag to check against the profile

Throws:

java.io.IOException - if there is a problem reading the profile or some of the bag files

com.fasterxml.jackson.databind.JsonMappingException - if there is a problem mapping the profile to the BagitProfile

com.fasterxml.jackson.core.JsonParseException - if there is a problem parsing the json while mapping to java object

FetchFileNotAllowedException - if there is a fetch file when the profile prohibits it

MetatdataValueIsNotAcceptableException - if a metadata value is not in the list of acceptable values

MetatdataValueIsNotRepeatableException - if a metadata value shows up more than once when not repeatable

RequiredMetadataFieldNotPresentException - if a metadata field is not present but it should be

RequiredManifestNotPresentException - if a payload or tag manifest type is not present but should be

BagitVersionIsNotAcceptableException - if the version of the bag is not in the list of acceptable versions

RequiredTagFileNotPresentException - if a tag file is not present but should be

lintBag

public static java.util.Set<BagitWarning> lintBag(java.nio.file.Path rootDir)
                                           throws java.io.IOException,
                                                  UnparsableVersionException,
                                                  InvalidBagMetadataException,
                                                  InvalidBagitFileFormatException,
                                                  MaliciousPathException,
                                                  UnsupportedAlgorithmException

The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged. This method checks a bag for potential problems, or other items that are allowed but discouraged. This does not validate a bag. See BagVerifier instead.

Parameters:

rootDir - the root directory of the bag

Returns:

a set of BagitWarning detailing all items that should be fixed.

Throws:

InvalidBagMetadataException - if the bag metadata does not conform to the bagit specification

UnparsableVersionException - if there is an error reading the bagit version

java.io.IOException - if there was an error reading a file

UnsupportedAlgorithmException - if there is an error while reading one of the manifests due to the algorithm being unsupported

MaliciousPathException - if the path is crafted to be malicious (overwrite non bag files)

InvalidBagitFileFormatException

lintBag

public static java.util.Set<BagitWarning> lintBag(java.nio.file.Path rootDir,
                                                  java.util.Collection<BagitWarning> warningsToIgnore)
                                           throws java.io.IOException,
                                                  UnparsableVersionException,
                                                  InvalidBagMetadataException,
                                                  InvalidBagitFileFormatException,
                                                  MaliciousPathException,
                                                  UnsupportedAlgorithmException

The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged. This method checks a bag for potential problems, or other items that are allowed but discouraged. This does not validate a bag. See BagVerifier instead.

Parameters:

rootDir - the root directory of the bag

warningsToIgnore - any BagitWarning to ignore when linting

Returns:

a set of BagitWarning detailing all items that should be fixed.

Throws:

InvalidBagMetadataException - if the bag metadata does not conform to the bagit specification

UnparsableVersionException - if there is an error reading the bagit version

java.io.IOException - if there was an error reading a file

UnsupportedAlgorithmException - if there is an error while reading one of the manifests due to the algorithm being unsupported

MaliciousPathException - if the path is crafted to be malicious (overwrite non bag files)

InvalidBagitFileFormatException