All Classes and Interfaces
Class
Description
An implementation of the
SimpleFileVisitor class that optionally avoids hidden files.Implements
SimpleFileVisitor to ensure that the encountered file is in one of the manifests.The main representation of the bagit spec.
Responsible for creating a bag in place.
This class is used to define elements in a bag-info.txt file used by a bagit-profile.
Implement this interface if you need to be able to use other algorithms than the
StandardSupportedAlgorithmsResponsible for writing the bagit.txt to the filesystem
POJO for all the bagit profile fields.
Deserialize bagit profile json to a
BagitProfileThis class is responsible for reading and parsing bagit.txt files from the filesystem
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.
Responsible for checking a bag and providing insight into how it cause problems.
Responsible for checking a bag against a profile
Responsible for reading a bag from the filesystem.
Responsible for verifying if a bag is valid, complete
responsible for writing out a
BagA simple task to check if a file exists on the filesystem.
Checks a give file to make sure the given checksum hash matches the computed checksum hash.
Class to represent an error when the calculated checksum is different than the manifest specified checksum.
Creates the payload manifests by walking the payload files and calculating their checksums
Mainly used in
BagCreatorCreates the tag manifests by walking the tag files and calculating their checksums
Mainly used in
BagCreatorPart 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 ensure that the encountered file is in one of the manifests.Class 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.
Convenience class for generating a HEX formatted string of the checksum hash.
The annotation conveys following information:
The API is fairly new and we would appreciate your feedback.
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
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
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 and their corresponding checksum with the algorithm used to generate that checksum
Part of the BagIt conformance suite.
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 class to represent the bag-info.txt (and package-info.txt in older versions)
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.
Convenience class for dealing with various path issues
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.Responsible for writing out the bag payload to the filesystem
responsible for all things related to quick verification.
Convenience class for writing a relative path
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
BagitProfileProvides a mapping between bagit algorithm names and
SupportedAlgorithmThe standard algorithms that are supported "out of the box" in bagit
Easy way to convert between bagit manifest spec and
See
MessageDigestSee
StandardSupportedAlgorithms for a list of defaultsConvenience class for reading tag files from the filesystem
If the version string in the bagit.txt file was not in the form <MAJOR>.<MINOR>
When the bag uses an checksum algorithm that is not supported by
MessageDigest.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.