Package nl.knaw.dans.bagit.conformance

Class BagProfileChecker

java.lang.Object

nl.knaw.dans.bagit.conformance.BagProfileChecker

public final class BagProfileChecker
extends Object

Responsible for checking a bag against a profile

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	logger
private static final ResourceBundle	messages

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BagProfileChecker()

Method Summary

Modifier and Type	Method	Description
static void	bagConformsToProfile(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!
private static void	checkFetch(Path rootDir, boolean allowFetchFile, List<FetchItem> itemsToFetch)
private static void	checkForAcceptableValues(Metadata bagMetadata, Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement)
private static void	checkForNoneRepeatableMetadata(Metadata bagMetadata, Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement, boolean metadataContainsKey)
private static void	checkIfMetadataEntryIsRequired(Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement, boolean metadataContainsKey)
private static void	checkMetadata(Metadata bagMetadata, Map<String,BagInfoRequirement> bagInfoEntryRequirements)
private static BagitProfile	parseBagitProfile(InputStream jsonProfile)
private static void	requiredManifestsExist(Set<Manifest> manifests, List<String> requiredManifestTypes, boolean isPayloadManifest)
private static void	requiredTagFilesExist(Path rootDir, List<String> requiredTagFilePaths)

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

Constructor Details

BagProfileChecker

private BagProfileChecker()

Method Details

bagConformsToProfile

public static void bagConformsToProfile(InputStream jsonProfile,
 Bag bag)
                                 throws com.fasterxml.jackson.core.JsonParseException,
com.fasterxml.jackson.databind.JsonMappingException,
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:

IOException - if there is a problem reading the profile

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

parseBagitProfile

private static BagitProfile parseBagitProfile(InputStream jsonProfile)
                                       throws com.fasterxml.jackson.core.JsonParseException,
com.fasterxml.jackson.databind.JsonMappingException,
IOException

Throws:

com.fasterxml.jackson.core.JsonParseException

com.fasterxml.jackson.databind.JsonMappingException

IOException

checkFetch

private static void checkFetch(Path rootDir,
 boolean allowFetchFile,
 List<FetchItem> itemsToFetch)
                        throws FetchFileNotAllowedException

Throws:

FetchFileNotAllowedException

checkMetadata

private static void checkMetadata(Metadata bagMetadata,
 Map<String,BagInfoRequirement> bagInfoEntryRequirements)
                           throws RequiredMetadataFieldNotPresentException,
MetatdataValueIsNotAcceptableException,
MetatdataValueIsNotRepeatableException

Throws:

RequiredMetadataFieldNotPresentException

MetatdataValueIsNotAcceptableException

MetatdataValueIsNotRepeatableException

checkIfMetadataEntryIsRequired

private static void checkIfMetadataEntryIsRequired(Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement,
 boolean metadataContainsKey)
                                            throws RequiredMetadataFieldNotPresentException

Throws:

RequiredMetadataFieldNotPresentException

checkForAcceptableValues

private static void checkForAcceptableValues(Metadata bagMetadata,
 Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement)
                                      throws MetatdataValueIsNotAcceptableException

Throws:

MetatdataValueIsNotAcceptableException

checkForNoneRepeatableMetadata

private static void checkForNoneRepeatableMetadata(Metadata bagMetadata,
 Map.Entry<String,BagInfoRequirement> bagInfoEntryRequirement,
 boolean metadataContainsKey)
                                            throws MetatdataValueIsNotRepeatableException

Throws:

MetatdataValueIsNotRepeatableException

requiredManifestsExist

private static void requiredManifestsExist(Set<Manifest> manifests,
 List<String> requiredManifestTypes,
 boolean isPayloadManifest)
                                    throws RequiredManifestNotPresentException

Throws:

RequiredManifestNotPresentException

requiredTagFilesExist

private static void requiredTagFilesExist(Path rootDir,
 List<String> requiredTagFilePaths)
                                   throws RequiredTagFileNotPresentException

Throws:

RequiredTagFileNotPresentException