gov.loc.repository.bagit.conformance

Class BagProfileChecker

java.lang.Object

gov.loc.repository.bagit.conformance.BagProfileChecker

public final class BagProfileChecker
extends java.lang.Object

Responsible for checking a bag against a profile

Method Summary

Modifier and Type	Method and Description
static void	bagConformsToProfile(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!

Methods inherited from class java.lang.Object

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

Method Detail

bagConformsToProfile

public static void bagConformsToProfile(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

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