org.duraspace.bagit

Class BagProfile

java.lang.Object

org.duraspace.bagit.BagProfile

public class BagProfile
extends Object

A BagProfile contains the entire contents of a BagIt profile specified through the profile's json.

Since:

2016-12-12

Author:

mikejritter, escowles

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BagProfile.BuiltIn Enum of the built in profiles which are provided with bagit-support
static class	BagProfile.Serialization

Constructor Summary

Constructors

Constructor and Description
BagProfile(BagProfile.BuiltIn builtInProfile) Load a BagProfile from a BagProfile.BuiltIn profile type
BagProfile(InputStream in) Create a BagProfile from a given InputStream

Method Summary

Modifier and Type	Method and Description
Set<String>	getAcceptedBagItVersions() Get the supported BagIt versions
Set<String>	getAcceptedSerializations() Get the supported serialization formats If getSerialization() has a value of required or optional, at least one value is needed.
Set<String>	getAllowedPayloadAlgorithms() Get the payload algorithms which are allowed When specified along with getPayloadDigestAlgorithms(), this must include at least all of the manifest types listed in getPayloadDigestAlgorithms().
Set<String>	getAllowedTagAlgorithms() Get the tag manifest algorithms which are allowed.
String	getIdentifier() Retrieve the BagIt-Profile-Identifier for this profile
Map<String,ProfileFieldRule>	getMetadataFields() Get the required Bag-Info metadata fields.
Map<String,ProfileFieldRule>	getMetadataFields(String tagFile) Get the required tags for the extra tag file
Set<String>	getPayloadDigestAlgorithms() Get the required digest algorithms for payload manifests.
Map<String,String>	getProfileMetadata() Get the BagIt-Profile-Info section describing the BagIt Profile
Set<String>	getSectionNames() Get all the section names in this profile, which can be used with getMetadataFields().
BagProfile.Serialization	getSerialization() Get the support of serialization for a Bag.
Set<String>	getTagDigestAlgorithms() Get the required digest algorithms for tag manifests.
Set<String>	getTagFilesAllowed() Get the names of allowed tag files; supports unix style globbing All the tag files listed in getTagFilesRequired() must be in included in this
Set<String>	getTagFilesRequired() Get the tag files which are required to exist
boolean	isAllowFetch() Boolean flag allowing a fetch.txt file
void	validateBag(gov.loc.repository.bagit.domain.Bag bag) Validate a given Bag against the current profile
void	validateConfig(BagConfig config) Validate a given BagConfig against the current profile
void	validateTagFiles(Map<String,Map<String,String>> config) Validate a configuration for tag files based on a mapping of BagIt tag filenames to key-value pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

BagProfile

public BagProfile(BagProfile.BuiltIn builtInProfile)
           throws IOException

Load a BagProfile from a BagProfile.BuiltIn profile type

Parameters:

builtInProfile - the supported profile to load

Throws:

IOException - if there is an error reading the json

BagProfile

public BagProfile(InputStream in)
           throws IOException

Create a BagProfile from a given InputStream

Parameters:

in - InputStream containing the Bag profile JSON document

Throws:

IOException - when there is an I/O error reading JSON

Method Detail

getIdentifier

public String getIdentifier()

Retrieve the BagIt-Profile-Identifier for this profile

Returns:

the BagIt-Profile-Identifier, or an empty string if none is found

isAllowFetch

public boolean isAllowFetch()

Boolean flag allowing a fetch.txt file

Returns:

true if fetch.txt is allowed, false otherwise

getSerialization

public BagProfile.Serialization getSerialization()

Get the support of serialization for a Bag. Allowed values are: forbidden, required, and optional

Returns:

String value of "forbidden", "required", or "optional"

getAcceptedBagItVersions

public Set<String> getAcceptedBagItVersions()

Get the supported BagIt versions

Returns:

Set of BagIt version numbers

getAcceptedSerializations

public Set<String> getAcceptedSerializations()

Get the supported serialization formats If getSerialization() has a value of required or optional, at least one value is needed. If getSerialization() is forbidden, this has no meaning

Returns:

Set of serialization formats

getTagFilesAllowed

public Set<String> getTagFilesAllowed()

Get the names of allowed tag files; supports unix style globbing All the tag files listed in getTagFilesRequired() must be in included in this

Returns:

Set of allowed tag files

getTagFilesRequired

public Set<String> getTagFilesRequired()

Get the tag files which are required to exist

Returns:

Set of tag filenames

getAllowedPayloadAlgorithms

public Set<String> getAllowedPayloadAlgorithms()

Get the payload algorithms which are allowed When specified along with getPayloadDigestAlgorithms(), this must include at least all of the manifest types listed in getPayloadDigestAlgorithms().

Returns:

Set of digest algorithm names

getAllowedTagAlgorithms

public Set<String> getAllowedTagAlgorithms()

Get the tag manifest algorithms which are allowed. When specified along with getTagDigestAlgorithms(), this must include at least all of the tag manifest types listed in getTagDigestAlgorithms().

Returns:

Set of digest algorithm names

getPayloadDigestAlgorithms

public Set<String> getPayloadDigestAlgorithms()

Get the required digest algorithms for payload manifests.

Returns:

Set of digest algorithm names

getTagDigestAlgorithms

public Set<String> getTagDigestAlgorithms()

Get the required digest algorithms for tag manifests.

Returns:

Set of digest algorithm names

getMetadataFields

public Map<String,ProfileFieldRule> getMetadataFields()

Get the required Bag-Info metadata fields.

Returns:

A map of field names to a ProfileFieldRule containing acceptance criteria

getMetadataFields

public Map<String,ProfileFieldRule> getMetadataFields(String tagFile)

Get the required tags for the extra tag file

Parameters:

tagFile - the tag file to get tags for

Returns:

map of tag = set of acceptable values, or null if tagFile doesn't exist

getSectionNames

public Set<String> getSectionNames()

Get all the section names in this profile, which can be used with getMetadataFields().

Returns:

set of section names

getProfileMetadata

public Map<String,String> getProfileMetadata()

Get the BagIt-Profile-Info section describing the BagIt Profile

Returns:

map of fields names to text descriptions

validateConfig

public void validateConfig(BagConfig config)

Validate a given BagConfig against the current profile

Parameters:

config - the BagConfig

validateTagFiles

public void validateTagFiles(Map<String,Map<String,String>> config)

Validate a configuration for tag files based on a mapping of BagIt tag filenames to key-value pairs. e.g. the filename "bag-info.txt" could contain the pairs "Source-Organization: DuraSpace" and "Organization-Address: The Cloud"

Parameters:

config - the Map containing the configuration of BagIt tag files

validateBag

public void validateBag(gov.loc.repository.bagit.domain.Bag bag)

Validate a given Bag against the current profile

Parameters:

bag - the Bag