org.duraspace.bagit

Class ProfileValidationUtil

java.lang.Object

org.duraspace.bagit.ProfileValidationUtil

public class ProfileValidationUtil
extends Object

Utility methods for validating profiles.

Since:

Dec 14, 2016

Author:

mikejritter, dbernstein

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	SYSTEM_GENERATED_FIELD_NAMES

Method Summary

Modifier and Type	Method and Description
static void	validate(String profileSection, Map<String,ProfileFieldRule> requiredFields, Map<String,String> fields) Validates the fields against a set of requiredFields and their constrained values.
static void	validate(String profileSection, Map<String,ProfileFieldRule> requiredFields, Path tag) Validates a tag file against a set of requiredFields and their constrained values.
static String	validateManifest(Set<gov.loc.repository.bagit.domain.Manifest> manifests, Set<String> required, Set<String> allowed, String type) Validate that a manifests found in a Bag are allowed according to both the required and allowed sets from a BagProfile.
static void	validateTagIsAllowed(Path tag, Set<String> allowedTags) Check if a given tag file is part of the allowed tags.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_GENERATED_FIELD_NAMES

protected static final Set<String> SYSTEM_GENERATED_FIELD_NAMES

Method Detail

validate

public static void validate(String profileSection,
                            Map<String,ProfileFieldRule> requiredFields,
                            Path tag)
                     throws ProfileValidationException,
                            IOException

Validates a tag file against a set of requiredFields and their constrained values.

Parameters:

profileSection - describes the section of the profile that is being validated.

requiredFields - the required fields and associated rule

tag - the path to the info file to read

Throws:

IOException - when the tag file cannot be read

ProfileValidationException - when the fields do not pass muster. The exception message contains a description of all validation errors found.

validate

public static void validate(String profileSection,
                            Map<String,ProfileFieldRule> requiredFields,
                            Map<String,String> fields)
                     throws ProfileValidationException

Validates the fields against a set of requiredFields and their constrained values. This is intended to be used in conjunction with BagConfig and will filter on certain fields defined by the SYSTEM_GENERATED_FIELD_NAMES constant.

Parameters:

profileSection - describes the section of the profile that is being validated.

requiredFields - the required fields and associated rule

fields - the key value pairs to be validated

Throws:

ProfileValidationException - when the fields do not pass muster. The exception message contains a description of all validation errors found.

validateManifest

public static String validateManifest(Set<gov.loc.repository.bagit.domain.Manifest> manifests,
                                      Set<String> required,
                                      Set<String> allowed,
                                      String type)

Validate that a manifests found in a Bag are allowed according to both the required and allowed sets from a BagProfile.

Parameters:

manifests - the manifests found in a Bag

required - the set of required manifest algorithms

allowed - the set of allowed manifest algorithms

type - the type of manifest being processed, normally 'tag' or 'payload'

Returns:

A String with any validation errors associated with the manifests

validateTagIsAllowed

public static void validateTagIsAllowed(Path tag,
                                        Set<String> allowedTags)
                                 throws ProfileValidationException

Check if a given tag file is part of the allowed tags. Should not be used against non-tag files such as the manifests or bagit.txt.

Parameters:

tag - the tag file to check

allowedTags - the list of allowed tag files, with unix style globbing allowed

Throws:

ProfileValidationException - when a tag file is not in the set of allowed tag filenames