All Classes and Interfaces
Class
Description
A
MessageDigest
based hasher, where all you need to implement are the algorithm to bagit algorithm name mappingImplements
SimpleFileVisitor
to ensure that the encountered file is in one of the manifests.The main representation of the bagit spec.
Used to conveniently create a bag programmatically and incrementally
This class is used to define elements in a bag-info.txt file used by a
BagitProfile
.Responsible for mapping between the bagit algorithm name and the actual implementation of that checksum.
Responsible for writing the bagit.txt to the filesystem
An immutable object for all the bagit profile fields.
Used to create a bagit profile programmatically and incrementally
Deserialize bagit profile json to a
BagitProfile
This class is responsible for reading and parsing bagit.txt files from the filesystem
verifies that the bagit text file is formatted correctly to the specification
Class to represent when the bag's version is not in the acceptable list of versions
The BagIt specification is very flexible in what it allows.
The main class for checking if a bag conforms to the specified profile or has other problems
Part of the BagIt conformance suite.
Class to represent an error when the calculated checksum is different than the manifest specified checksum.
Part of the BagIt conformance suite.
Class to represent when a fetch file is found in a bag but is not allowed according to the bagit profile
An individual item to fetch as specified by
https://tools.ietf.org/html/draft-kunze-bagit-13#section-2.2.3
This class is responsible for reading and parsing fetch.txt file from the filesystem
Responsible for writing out the list of
FetchItem
to the fetch.txt file on the filesystemImplements
SimpleFileVisitor
to calculate the PayloadOxumClass to represent an error when a file is found in the payload directory but not in any manifest.
Class to represent an error when a file is not in the payload directory but is listed in a manifest.
The interface that any supported checksum algorithm must implement.
Class to represent an error when the initializing a new
Hasher
Class to represent an error when a specific bag file does not conform to its bagit specfication format
Class to represent an error when the bag metadata file does not conform to the bagit spec,
namely:
<KEY>:<VALUE>
or
<KEY>:<VALUE>
or
For when a bag has somehow been created and is in a undefined state
Class to represent an error when the calculated total bytes or number of files for
the payload-oxum is different than the supplied values.
Convenience class for reading key value pairs from a file
Part of the BagIt conformance suite.
Class to represent an error when the path in a manifest or fetch file has been crafted to point to a file or
directory outside the bag.
Responsible for checking all things related to mandatory files for the bagit specification
A manifest is a list of files,their corresponding checksum generated using
Hasher
, and their relative path in the bagProgrammatically build a manifest
Creates a manifest from the supplied starting point
Part of the BagIt conformance suite.
A Manifest Entry is a domain object meant to keep track of various parts needed so it can be listed in a manifest properly
Responsible for filtering out files that aren't manifests
This class is responsible for reading and parsing manifest files on the filesystem
Responsible for all things related to the manifest during verification.
Responsible for writing out a
Manifest
to the filesystemA default implementation for the MD5 checksum
A class to represent the bag-info.txt (and package-info.txt in older versions)
Programmatically and dynamically create metadata
Part of the BagIt conformance suite.
This class is responsible for reading and parsing bagit metadata files from the filesystem
Responsible for writing out the bag
Metadata
to the filesystemClass to represent when a metadata's value is not in the acceptable list of values
Class to represent when a metadata's value is not to be repeated
The bagit.txt file is a required file.
The payload directory is a required file.
A bagit bag needs at least one payload manifest.
A class to represent the bagit algorithm name is not mapped.
a convenience class for representing a file path and what its relative path should be
Responsible for providing some very basic functionality across multiple packages.
Implements
SimpleFileVisitor
to ensure that the encountered file is in one of the manifests.Implements
SimpleFileVisitor
to ensure that the encountered file is in one of the manifests.The
Bag
object should contain the Payload-Oxum metatdata key value pair,
this class represents the error when trying to calculate the payload-oxum and it doesn't exist on the bag object.a singleton used to generate the payload oxum for a bag
util class to format strings correctly
Class to represent when a specific manifest type is not found, such as md5, sha1, etc (payload or tag)
Class to represent when a specific metadata field is not found
Class to represent when a specific tag file is not found
The type of serialization required by a
BagitProfile
A default implementation for the SHA1 checksum
A default implementation for the SHA1 with 224 bit checksum
A default implementation for the SHA1 with 256 bit checksum
A default implementation for the SHA1 with 384 bit checksum
A default implementation for the SHA1 with 512 bit checksum
Convenience class for reading tag files from the filesystem
If the version string in the bagit.txt file was not in the form <MAJOR>.<MINOR>
Class to represent an generic exception that happened during verification.
The version of the bagit specification used to create the bag.
Part of the BagIt conformance suite.