A B C D E F G H I K L M P Q R S T U V W

A

AbstractCreateManifestsVistor - Class in gov.loc.repository.bagit.creator

An implementation of the SimpleFileVisitor class that optionally avoids hidden files.

AbstractCreateManifestsVistor(Map<Manifest, MessageDigest>, boolean) - Constructor for class gov.loc.repository.bagit.creator.AbstractCreateManifestsVistor

AbstractPayloadFileExistsInManifestsVistor - Class in gov.loc.repository.bagit.verify

Implements SimpleFileVisitor to ensure that the encountered file is in one of the manifests.

AbstractPayloadFileExistsInManifestsVistor(boolean) - Constructor for class gov.loc.repository.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

abstractPreVisitDirectory(Path, String) - Method in class gov.loc.repository.bagit.creator.AbstractCreateManifestsVistor

add(String, String) - Method in class gov.loc.repository.bagit.domain.Metadata

add a entry into the metadata or append a value if the label already exists

addAll(List<AbstractMap.SimpleImmutableEntry<String, String>>) - Method in class gov.loc.repository.bagit.domain.Metadata

add multiple metadata entries

B

Bag - Class in gov.loc.repository.bagit.domain

The main representation of the bagit spec.

Bag() - Constructor for class gov.loc.repository.bagit.domain.Bag

empty bag with an invalid version

Bag(Version) - Constructor for class gov.loc.repository.bagit.domain.Bag

empty bag with the specified bag version

Bag(Bag) - Constructor for class gov.loc.repository.bagit.domain.Bag

Create a new bag with the same values as the supplied bag

bagConformsToProfile(InputStream, Bag) - Static method in class gov.loc.repository.bagit.conformance.BagProfileChecker

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!

BagCreator - Class in gov.loc.repository.bagit.creator

Responsible for creating a bag in place.

BagInfoRequirement - Class in gov.loc.repository.bagit.conformance.profile

This class is used to define elements in a bag-info.txt file used by a bagit-profile.

BagInfoRequirement() - Constructor for class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

BagInfoRequirement(boolean, List<String>) - Constructor for class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

Constructs a new BagInfoRequirement setting BagInfoRequirement.repeatable to true (default).

BagInfoRequirement(boolean, List<String>, boolean) - Constructor for class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

Constructs a new BagInfoRequirement.

bagInPlace(Path, Collection<SupportedAlgorithm>, boolean) - Static method in class gov.loc.repository.bagit.creator.BagCreator

Creates a bag in place for version 0.97.

bagInPlace(Path, Collection<SupportedAlgorithm>, boolean, Metadata) - Static method in class gov.loc.repository.bagit.creator.BagCreator

Creates a bag in place for version 0.97.

BagitAlgorithmNameToSupportedAlgorithmMapping - Interface in gov.loc.repository.bagit.hash

Implement this interface if you need to be able to use other algorithms than the StandardSupportedAlgorithms

BagitFileWriter - Class in gov.loc.repository.bagit.writer

Responsible for writing the bagit.txt to the filesystem

BagitProfile - Class in gov.loc.repository.bagit.conformance.profile

POJO for all the bagit profile fields.

BagitProfile() - Constructor for class gov.loc.repository.bagit.conformance.profile.BagitProfile

BagitProfileDeserializer - Class in gov.loc.repository.bagit.conformance.profile

Deserialize bagit profile json to a BagitProfile

BagitProfileDeserializer() - Constructor for class gov.loc.repository.bagit.conformance.profile.BagitProfileDeserializer

BagitProfileDeserializer(Class<?>) - Constructor for class gov.loc.repository.bagit.conformance.profile.BagitProfileDeserializer

BagitTextFileReader - Class in gov.loc.repository.bagit.reader

This class is responsible for reading and parsing bagit.txt files from the filesystem

BagitVersionIsNotAcceptableException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when the bag's version is not in the acceptable list of versions

BagitVersionIsNotAcceptableException(String, Version, List<String>) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.BagitVersionIsNotAcceptableException

BagitWarning - Enum in gov.loc.repository.bagit.conformance

The BagIt specification is very flexible in what it allows.

BagLinter - Class in gov.loc.repository.bagit.conformance

Responsible for checking a bag and providing insight into how it cause problems.

BagProfileChecker - Class in gov.loc.repository.bagit.conformance

Responsible for checking a bag against a profile

BagReader - Class in gov.loc.repository.bagit.reader

Responsible for reading a bag from the filesystem.

BagReader() - Constructor for class gov.loc.repository.bagit.reader.BagReader

BagReader(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class gov.loc.repository.bagit.reader.BagReader

BagVerifier - Class in gov.loc.repository.bagit.verify

Responsible for verifying if a bag is valid, complete

BagVerifier() - Constructor for class gov.loc.repository.bagit.verify.BagVerifier

Create a BagVerifier with a cached thread pool and a StandardBagitAlgorithmNameToSupportedAlgorithmMapping

BagVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class gov.loc.repository.bagit.verify.BagVerifier

Create a BagVerifier with a cached thread pool and a custom mapping

BagVerifier(ExecutorService) - Constructor for class gov.loc.repository.bagit.verify.BagVerifier

Create a BagVerifier with a custom thread pool and a StandardBagitAlgorithmNameToSupportedAlgorithmMapping

BagVerifier(ExecutorService, BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class gov.loc.repository.bagit.verify.BagVerifier

Create a BagVerifier with a custom thread pool and a custom mapping

BagWriter - Class in gov.loc.repository.bagit.writer

responsible for writing out a Bag

C

canQuickVerify(Bag) - Static method in class gov.loc.repository.bagit.verify.BagVerifier

Determine if we can quickly verify by comparing the number of files and the total number of bytes expected

canQuickVerify(Bag) - Static method in class gov.loc.repository.bagit.verify.QuickVerifier

Determine if we can quickly verify by comparing the number of files and the total number of bytes expected

checkAgainstProfile(InputStream, Bag) - Static method in class gov.loc.repository.bagit.conformance.BagLinter

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!

checkBagitFileExists(Path, Version) - Static method in class gov.loc.repository.bagit.verify.MandatoryVerifier

make sure the bagit.txt file exists

checkBagMetadata(Path, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class gov.loc.repository.bagit.conformance.MetadataChecker

checkEncoding(Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in interface gov.loc.repository.bagit.conformance.EncodingChecker

checkFetchItemsExist(List<FetchItem>, Path) - Static method in class gov.loc.repository.bagit.verify.MandatoryVerifier

make sure all the fetch items exist in the data directory

checkIfAtLeastOnePayloadManifestsExist(Path, Version) - Static method in class gov.loc.repository.bagit.verify.MandatoryVerifier

Check to make sure the bag has at least one payload manifest (manifest-[ALGORITHM].txt)

CheckIfFileExistsTask - Class in gov.loc.repository.bagit.verify

A simple task to check if a file exists on the filesystem.

CheckIfFileExistsTask(Path, Set<Path>, CountDownLatch) - Constructor for class gov.loc.repository.bagit.verify.CheckIfFileExistsTask

checkManifestEntry(Map.Entry<Path, String>, MessageDigest, String) - Static method in class gov.loc.repository.bagit.verify.CheckManifestHashesTask

CheckManifestHashesTask - Class in gov.loc.repository.bagit.verify

Checks a give file to make sure the given checksum hash matches the computed checksum hash.

CheckManifestHashesTask(Map.Entry<Path, String>, String, CountDownLatch, Collection<Exception>) - Constructor for class gov.loc.repository.bagit.verify.CheckManifestHashesTask

checkManifests(Version, Path, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class gov.loc.repository.bagit.conformance.ManifestChecker

Check for all the manifest specific potential problems

checkPayloadDirectoryExists(Bag) - Static method in class gov.loc.repository.bagit.verify.MandatoryVerifier

Make sure the payload directory exists

checkVersion(Version, Set<BagitWarning>, Collection<BagitWarning>) - Static method in interface gov.loc.repository.bagit.conformance.VersionChecker

close() - Method in class gov.loc.repository.bagit.verify.BagVerifier

close() - Method in class gov.loc.repository.bagit.verify.ManifestVerifier

compareTo(Version) - Method in class gov.loc.repository.bagit.domain.Version

contains(String) - Method in class gov.loc.repository.bagit.domain.Metadata

check if the metadata contains a particular label(key)

CorruptChecksumException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when the calculated checksum is different than the manifest specified checksum.

CorruptChecksumException(String, Path, String, String, String) - Constructor for exception gov.loc.repository.bagit.exceptions.CorruptChecksumException

createDotBagit(Path, Collection<SupportedAlgorithm>, boolean) - Static method in class gov.loc.repository.bagit.creator.BagCreator

Creates a basic(only required elements) .bagit bag in place.

createDotBagit(Path, Collection<SupportedAlgorithm>, boolean, Metadata) - Static method in class gov.loc.repository.bagit.creator.BagCreator

Creates a basic(only required elements) .bagit bag in place.

createFileFromManifest(Path, String) - Static method in interface gov.loc.repository.bagit.reader.TagFileReader

createManifestToMessageDigestMap(Collection<SupportedAlgorithm>) - Static method in class gov.loc.repository.bagit.hash.Hasher

create a mapping between Manifest and MessageDigest for each each supplied SupportedAlgorithm

CreatePayloadManifestsVistor - Class in gov.loc.repository.bagit.creator

Creates the payload manifests by walking the payload files and calculating their checksums Mainly used in BagCreator

CreatePayloadManifestsVistor(Map<Manifest, MessageDigest>, boolean) - Constructor for class gov.loc.repository.bagit.creator.CreatePayloadManifestsVistor

CreateTagManifestsVistor - Class in gov.loc.repository.bagit.creator

Creates the tag manifests by walking the tag files and calculating their checksums Mainly used in BagCreator

CreateTagManifestsVistor(Map<Manifest, MessageDigest>, boolean) - Constructor for class gov.loc.repository.bagit.creator.CreateTagManifestsVistor

D

decodeFilname(String) - Static method in class gov.loc.repository.bagit.util.PathUtils

as per https://github.com/jkunze/bagitspec/commit/152d42f6298b31a4916ea3f8f644ca4490494070 decode percent encoded filenames

deserialize(JsonParser, DeserializationContext) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfileDeserializer

E

encodeFilename(Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

as per https://github.com/jkunze/bagitspec/commit/152d42f6298b31a4916ea3f8f644ca4490494070 encode any new lines or carriage returns

EncodingChecker - Interface in gov.loc.repository.bagit.conformance

Part of the BagIt conformance suite.

equals(Object) - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

equals(Object) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

equals(Object) - Method in class gov.loc.repository.bagit.domain.Bag

equals(Object) - Method in class gov.loc.repository.bagit.domain.FetchItem

equals(Object) - Method in class gov.loc.repository.bagit.domain.Manifest

equals(Object) - Method in class gov.loc.repository.bagit.domain.Metadata

equals(Object) - Method in class gov.loc.repository.bagit.domain.Version

ERROR_PREFIX - Static variable in interface gov.loc.repository.bagit.reader.TagFileReader

F

FetchFileNotAllowedException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a fetch file is found in a bag but is not allowed according to the bagit profile

FetchFileNotAllowedException(String, Path) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.FetchFileNotAllowedException

FetchItem - Class in gov.loc.repository.bagit.domain

An individual item to fetch as specified by https://tools.ietf.org/html/draft-kunze-bagit-13#section-2.2.3

FetchItem(URL, Long, Path) - Constructor for class gov.loc.repository.bagit.domain.FetchItem

FetchReader - Class in gov.loc.repository.bagit.reader

This class is responsible for reading and parsing fetch.txt file from the filesystem

FetchWriter - Class in gov.loc.repository.bagit.writer

Responsible for writing out the list of FetchItem to the fetch.txt file on the filesystem

FileCountAndTotalSizeVistor - Class in gov.loc.repository.bagit.verify

Implements SimpleFileVisitor to ensure that the encountered file is in one of the manifests.

FileCountAndTotalSizeVistor() - Constructor for class gov.loc.repository.bagit.verify.FileCountAndTotalSizeVistor

FileNotInManifestException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when a file is found in the payload directory but not in any manifest.

FileNotInManifestException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.FileNotInManifestException

FileNotInPayloadDirectoryException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when a file is not in the payload directory but is listed in a manifest.

FileNotInPayloadDirectoryException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.FileNotInPayloadDirectoryException

formatRelativePathString(Path, Path) - Static method in class gov.loc.repository.bagit.writer.RelativePathWriter

Create a relative path that has \ (windows) path separator replaced with / and encodes newlines

G

generatePayloadOxum(Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

Calculate the total file and byte count of the files in the payload directory

get(String) - Method in class gov.loc.repository.bagit.domain.Metadata

get all the values for a specific label (key)

getAcceptableBagitVersions() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getAcceptableMIMESerializationTypes() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getAcceptableValues() - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

getAlgorithm() - Method in class gov.loc.repository.bagit.domain.Manifest

getAll() - Method in class gov.loc.repository.bagit.domain.Metadata

all the metadata

getBagInfoRequirements() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getBagitDir(Bag) - Static method in class gov.loc.repository.bagit.util.PathUtils

With bagit version 2.0 (.bagit) bagit specific files are no longer at the bag root directory.

getBagitDir(Version, Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

With bagit version 2.0 (.bagit) bagit specific files are no longer at the bag root directory.

getBagitName() - Method in enum gov.loc.repository.bagit.hash.StandardSupportedAlgorithms

getBagitName() - Method in interface gov.loc.repository.bagit.hash.SupportedAlgorithm

getBagitProfileIdentifier() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getContactEmail() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getContactName() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getContactPhone() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getCount() - Method in class gov.loc.repository.bagit.verify.FileCountAndTotalSizeVistor

getDataDir(Bag) - Static method in class gov.loc.repository.bagit.util.PathUtils

With bagit version 2.0 (.bagit) payload files are no longer in the "data" directory.

getDataDir(Version, Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

With bagit version 2.0 (.bagit) payload files are no longer in the "data" directory.

getExecutor() - Method in class gov.loc.repository.bagit.verify.BagVerifier

getExternalDescription() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getFileEncoding() - Method in class gov.loc.repository.bagit.domain.Bag

getFilename(Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

Needed to get rid of findbugs "dodgy code warnings" in regards to getting the filename of a path as a string

getFileToChecksumMap() - Method in class gov.loc.repository.bagit.domain.Manifest

getItemsToFetch() - Method in class gov.loc.repository.bagit.domain.Bag

getLength() - Method in class gov.loc.repository.bagit.domain.FetchItem

getList() - Method in class gov.loc.repository.bagit.domain.Metadata

getMajor() - Method in class gov.loc.repository.bagit.domain.Version

getManifestTypesRequired() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getManifestVerifier() - Method in class gov.loc.repository.bagit.verify.BagVerifier

getMap() - Method in class gov.loc.repository.bagit.domain.Metadata

getMessageDigestName() - Method in enum gov.loc.repository.bagit.hash.StandardSupportedAlgorithms

getMessageDigestName() - Method in interface gov.loc.repository.bagit.hash.SupportedAlgorithm

getMetadata() - Method in class gov.loc.repository.bagit.domain.Bag

getMinor() - Method in class gov.loc.repository.bagit.domain.Version

getNameMapping() - Method in class gov.loc.repository.bagit.reader.BagReader

getPath() - Method in class gov.loc.repository.bagit.domain.FetchItem

getPayLoadManifests() - Method in class gov.loc.repository.bagit.domain.Bag

getReason() - Method in enum gov.loc.repository.bagit.conformance.BagitWarning

getRootDir() - Method in class gov.loc.repository.bagit.domain.Bag

getSerialization() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getSourceOrganization() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getSupportedAlgorithm(String) - Method in interface gov.loc.repository.bagit.hash.BagitAlgorithmNameToSupportedAlgorithmMapping

getSupportedAlgorithm(String) - Method in class gov.loc.repository.bagit.hash.StandardBagitAlgorithmNameToSupportedAlgorithmMapping

getTagFilesRequired() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getTagManifests() - Method in class gov.loc.repository.bagit.domain.Bag

getTagManifestTypesRequired() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getTotalSize() - Method in class gov.loc.repository.bagit.verify.FileCountAndTotalSizeVistor

getUrl() - Method in class gov.loc.repository.bagit.domain.FetchItem

getVersion() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

getVersion() - Method in class gov.loc.repository.bagit.domain.Bag

gov.loc.repository.bagit.annotation - package gov.loc.repository.bagit.annotation

gov.loc.repository.bagit.conformance - package gov.loc.repository.bagit.conformance

gov.loc.repository.bagit.conformance.profile - package gov.loc.repository.bagit.conformance.profile

gov.loc.repository.bagit.creator - package gov.loc.repository.bagit.creator

gov.loc.repository.bagit.domain - package gov.loc.repository.bagit.domain

gov.loc.repository.bagit.exceptions - package gov.loc.repository.bagit.exceptions

gov.loc.repository.bagit.exceptions.conformance - package gov.loc.repository.bagit.exceptions.conformance

gov.loc.repository.bagit.hash - package gov.loc.repository.bagit.hash

gov.loc.repository.bagit.reader - package gov.loc.repository.bagit.reader

gov.loc.repository.bagit.util - package gov.loc.repository.bagit.util

gov.loc.repository.bagit.verify - package gov.loc.repository.bagit.verify

gov.loc.repository.bagit.writer - package gov.loc.repository.bagit.writer

H

hash(Path, MessageDigest) - Static method in class gov.loc.repository.bagit.hash.Hasher

Create a HEX formatted string checksum hash of the file

hash(Path, Map<Manifest, MessageDigest>) - Static method in class gov.loc.repository.bagit.hash.Hasher

Update the Manifests with the file's hash

hashCode() - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

hashCode() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

hashCode() - Method in class gov.loc.repository.bagit.domain.Bag

hashCode() - Method in class gov.loc.repository.bagit.domain.FetchItem

hashCode() - Method in class gov.loc.repository.bagit.domain.Manifest

hashCode() - Method in class gov.loc.repository.bagit.domain.Metadata

hashCode() - Method in class gov.loc.repository.bagit.domain.Version

Hasher - Class in gov.loc.repository.bagit.hash

Convenience class for generating a HEX formatted string of the checksum hash.

I

ignoreHiddenFiles - Variable in class gov.loc.repository.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

includeHiddenFiles - Variable in class gov.loc.repository.bagit.creator.AbstractCreateManifestsVistor

Incubating - Annotation Type in gov.loc.repository.bagit.annotation

The annotation conveys following information: The API is fairly new and we would appreciate your feedback.

InvalidBagitFileFormatException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when a specific bag file does not conform to its bagit specfication format

InvalidBagitFileFormatException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.InvalidBagitFileFormatException

InvalidBagitFileFormatException(String, Exception) - Constructor for exception gov.loc.repository.bagit.exceptions.InvalidBagitFileFormatException

InvalidBagMetadataException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when the bag metadata file does not conform to the bagit spec, namely:
<KEY>:<VALUE>
or

InvalidBagMetadataException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.InvalidBagMetadataException

InvalidPayloadOxumException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an error when the calculated total bytes or number of files for the payload-oxum is different than the supplied values.

InvalidPayloadOxumException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.InvalidPayloadOxumException

isComplete(Bag, boolean) - Method in class gov.loc.repository.bagit.verify.BagVerifier

See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3
A bag is complete if
every element is present every file in the payload manifest(s) are present every file in the tag manifest(s) are present.

isEmpty() - Method in class gov.loc.repository.bagit.domain.Metadata

isFetchFileAllowed() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

isHidden(Path) - Static method in class gov.loc.repository.bagit.util.PathUtils

Due to the way that windows handles hidden files vs.

isNewer(Version) - Method in class gov.loc.repository.bagit.domain.Version

isOlder(Version) - Method in class gov.loc.repository.bagit.domain.Version

isRepeatable() - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

isRequired() - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

isSameOrNewer(Version) - Method in class gov.loc.repository.bagit.domain.Version

isSameOrOlder(Version) - Method in class gov.loc.repository.bagit.domain.Version

isValid(Bag, boolean) - Method in class gov.loc.repository.bagit.verify.BagVerifier

See https://tools.ietf.org/html/draft-kunze-bagit-13#section-3
A bag is valid if the bag is complete and every checksum has been verified against the contents of its corresponding file.

K

KeyValueReader - Class in gov.loc.repository.bagit.reader

Convenience class for reading key value pairs from a file

L

LATEST_BAGIT_VERSION - Static variable in interface gov.loc.repository.bagit.conformance.VersionChecker

LATEST_BAGIT_VERSION() - Static method in class gov.loc.repository.bagit.domain.Version

length - Variable in class gov.loc.repository.bagit.domain.FetchItem

The length of the file in octets

lintBag(Path) - Static method in class gov.loc.repository.bagit.conformance.BagLinter

The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged.

lintBag(Path, Collection<BagitWarning>) - Static method in class gov.loc.repository.bagit.conformance.BagLinter

The BagIt specification is very flexible in what it allows which leads to situations where something may be technically allowed, but should be discouraged.

logger - Static variable in interface gov.loc.repository.bagit.conformance.EncodingChecker

logger - Static variable in interface gov.loc.repository.bagit.conformance.VersionChecker

logger - Static variable in interface gov.loc.repository.bagit.reader.TagFileReader

logger - Static variable in class gov.loc.repository.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

M

major - Variable in class gov.loc.repository.bagit.domain.Version

MaliciousPathException - Exception in gov.loc.repository.bagit.exceptions

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.

MaliciousPathException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.MaliciousPathException

MandatoryVerifier - Class in gov.loc.repository.bagit.verify

Responsible for checking all things related to mandatory files for the bagit specification

Manifest - Class in gov.loc.repository.bagit.domain

A manifest is a list of files and their corresponding checksum with the algorithm used to generate that checksum

Manifest(SupportedAlgorithm) - Constructor for class gov.loc.repository.bagit.domain.Manifest

ManifestChecker - Class in gov.loc.repository.bagit.conformance

Part of the BagIt conformance suite.

ManifestReader - Class in gov.loc.repository.bagit.reader

This class is responsible for reading and parsing manifest files on the filesystem

manifestToMessageDigestMap - Variable in class gov.loc.repository.bagit.creator.AbstractCreateManifestsVistor

ManifestVerifier - Class in gov.loc.repository.bagit.verify

Responsible for all things related to the manifest during verification.

ManifestVerifier() - Constructor for class gov.loc.repository.bagit.verify.ManifestVerifier

Create a PayloadVerifier using a cached thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping

ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class gov.loc.repository.bagit.verify.ManifestVerifier

Create a PayloadVerifier using a cached thread pool and a custom mapping

ManifestVerifier(ExecutorService) - Constructor for class gov.loc.repository.bagit.verify.ManifestVerifier

Create a PayloadVerifier using a custom thread pool and the StandardBagitAlgorithmNameToSupportedAlgorithmMapping mapping

ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping, ExecutorService) - Constructor for class gov.loc.repository.bagit.verify.ManifestVerifier

Create a PayloadVerifier using a custom thread pool and a custom mapping

ManifestWriter - Class in gov.loc.repository.bagit.writer

Responsible for writing out a Manifest to the filesystem

messages - Static variable in interface gov.loc.repository.bagit.conformance.EncodingChecker

messages - Static variable in interface gov.loc.repository.bagit.conformance.VersionChecker

messages - Static variable in interface gov.loc.repository.bagit.reader.TagFileReader

messages - Static variable in class gov.loc.repository.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

Metadata - Class in gov.loc.repository.bagit.domain

A class to represent the bag-info.txt (and package-info.txt in older versions)

Metadata() - Constructor for class gov.loc.repository.bagit.domain.Metadata

MetadataChecker - Class in gov.loc.repository.bagit.conformance

Part of the BagIt conformance suite.

MetadataReader - Class in gov.loc.repository.bagit.reader

This class is responsible for reading and parsing bagit metadata files from the filesystem

MetadataWriter - Class in gov.loc.repository.bagit.writer

Responsible for writing out the bag Metadata to the filesystem

MetatdataValueIsNotAcceptableException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a metadata's value is not in the acceptable list of values

MetatdataValueIsNotAcceptableException(String, String, List<String>, String) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.MetatdataValueIsNotAcceptableException

MetatdataValueIsNotRepeatableException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a metadata's value is not to be repeated

MetatdataValueIsNotRepeatableException(String, String) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.MetatdataValueIsNotRepeatableException

minor - Variable in class gov.loc.repository.bagit.domain.Version

MissingBagitFileException - Exception in gov.loc.repository.bagit.exceptions

The bagit.txt file is a required file.

MissingBagitFileException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.MissingBagitFileException

MissingPayloadDirectoryException - Exception in gov.loc.repository.bagit.exceptions

The payload directory is a required file.

MissingPayloadDirectoryException(String, Path) - Constructor for exception gov.loc.repository.bagit.exceptions.MissingPayloadDirectoryException

MissingPayloadManifestException - Exception in gov.loc.repository.bagit.exceptions

A bagit bag needs at least one payload manifest.

MissingPayloadManifestException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.MissingPayloadManifestException

P

parseVersion(String) - Static method in class gov.loc.repository.bagit.reader.BagitTextFileReader

path - Variable in class gov.loc.repository.bagit.domain.FetchItem

The path where the fetched item should be put

PathUtils - Class in gov.loc.repository.bagit.util

Convenience class for dealing with various path issues

PayloadFileExistsInAllManifestsVistor - Class in gov.loc.repository.bagit.verify

Implements SimpleFileVisitor to ensure that the encountered file is in one of the manifests.

PayloadFileExistsInAllManifestsVistor(Set<Manifest>, boolean) - Constructor for class gov.loc.repository.bagit.verify.PayloadFileExistsInAllManifestsVistor

PayloadFileExistsInAtLeastOneManifestVistor - Class in gov.loc.repository.bagit.verify

Implements SimpleFileVisitor to ensure that the encountered file is in one of the manifests.

PayloadFileExistsInAtLeastOneManifestVistor(Set<Path>, boolean) - Constructor for class gov.loc.repository.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

PayloadOxumDoesNotExistException - Exception in gov.loc.repository.bagit.exceptions

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.

PayloadOxumDoesNotExistException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.PayloadOxumDoesNotExistException

PayloadWriter - Class in gov.loc.repository.bagit.writer

Responsible for writing out the bag payload to the filesystem

preVisitDirectory(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.creator.CreatePayloadManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.creator.CreateTagManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.verify.FileCountAndTotalSizeVistor

Q

quicklyVerify(Bag) - Static method in class gov.loc.repository.bagit.verify.BagVerifier

Quickly verify by comparing the number of files and the total number of bytes expected

quicklyVerify(Bag) - Static method in class gov.loc.repository.bagit.verify.QuickVerifier

Quickly verify by comparing the number of files and the total number of bytes expected

QuickVerifier - Class in gov.loc.repository.bagit.verify

responsible for all things related to quick verification.

R

read(Path) - Method in class gov.loc.repository.bagit.reader.BagReader

Read the bag from the filesystem and create a bag object

readBagitTextFile(Path) - Static method in class gov.loc.repository.bagit.reader.BagitTextFileReader

Read the bagit.txt file and return the version and encoding.

readBagMetadata(Path, Charset) - Static method in class gov.loc.repository.bagit.reader.MetadataReader

Reads the bag metadata file (bag-info.txt or package-info.txt) and returns it.

readFetch(Path, Charset, Path) - Static method in class gov.loc.repository.bagit.reader.FetchReader

Reads a fetch.txt file

readKeyValuesFromFile(Path, String, Charset) - Static method in class gov.loc.repository.bagit.reader.KeyValueReader

Generic method to read key value pairs from the bagit files, like bagit.txt or bag-info.txt

readManifest(BagitAlgorithmNameToSupportedAlgorithmMapping, Path, Path, Charset) - Static method in class gov.loc.repository.bagit.reader.ManifestReader

Reads a manifest file and converts it to a Manifest object.

RelativePathWriter - Class in gov.loc.repository.bagit.writer

Convenience class for writing a relative path

remove(String) - Method in class gov.loc.repository.bagit.domain.Metadata

remove the label and all its values

RequiredManifestNotPresentException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a specific manifest type is not found, such as md5, sha1, etc (payload or tag)

RequiredManifestNotPresentException(String) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.RequiredManifestNotPresentException

RequiredMetadataFieldNotPresentException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a specific metadata field is not found

RequiredMetadataFieldNotPresentException(String, String) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.RequiredMetadataFieldNotPresentException

RequiredTagFileNotPresentException - Exception in gov.loc.repository.bagit.exceptions.conformance

Class to represent when a specific tag file is not found

RequiredTagFileNotPresentException(String, String) - Constructor for exception gov.loc.repository.bagit.exceptions.conformance.RequiredTagFileNotPresentException

run() - Method in class gov.loc.repository.bagit.verify.CheckIfFileExistsTask

run() - Method in class gov.loc.repository.bagit.verify.CheckManifestHashesTask

S

Serialization - Enum in gov.loc.repository.bagit.conformance.profile

The type of serialization required by a BagitProfile

setAcceptableBagitVersions(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setAcceptableMIMESerializationTypes(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setAcceptableValues(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

setBagInfoRequirements(Map<String, BagInfoRequirement>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setBagitProfileIdentifier(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setContactEmail(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setContactName(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setContactPhone(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setExternalDescription(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setFetchFileAllowed(boolean) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setFileEncoding(Charset) - Method in class gov.loc.repository.bagit.domain.Bag

setFileToChecksumMap(Map<Path, String>) - Method in class gov.loc.repository.bagit.domain.Manifest

setItemsToFetch(List<FetchItem>) - Method in class gov.loc.repository.bagit.domain.Bag

setList(List<AbstractMap.SimpleImmutableEntry<String, String>>) - Method in class gov.loc.repository.bagit.domain.Metadata

setManifestTypesRequired(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setMap(Map<String, List<String>>) - Method in class gov.loc.repository.bagit.domain.Metadata

setMetadata(Metadata) - Method in class gov.loc.repository.bagit.domain.Bag

setPayLoadManifests(Set<Manifest>) - Method in class gov.loc.repository.bagit.domain.Bag

setRepeatable(boolean) - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

setRequired(boolean) - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

setRootDir(Path) - Method in class gov.loc.repository.bagit.domain.Bag

setSerialization(Serialization) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setSourceOrganization(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setTagFilesRequired(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setTagManifests(Set<Manifest>) - Method in class gov.loc.repository.bagit.domain.Bag

setTagManifestTypesRequired(List<String>) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setVersion(String) - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

setVersion(Version) - Method in class gov.loc.repository.bagit.domain.Bag

StandardBagitAlgorithmNameToSupportedAlgorithmMapping - Class in gov.loc.repository.bagit.hash

Provides a mapping between bagit algorithm names and SupportedAlgorithm

StandardBagitAlgorithmNameToSupportedAlgorithmMapping() - Constructor for class gov.loc.repository.bagit.hash.StandardBagitAlgorithmNameToSupportedAlgorithmMapping

StandardSupportedAlgorithms - Enum in gov.loc.repository.bagit.hash

The standard algorithms that are supported "out of the box" in bagit

SupportedAlgorithm - Interface in gov.loc.repository.bagit.hash

Easy way to convert between bagit manifest spec and MessageDigest
See StandardSupportedAlgorithms for a list of defaults

T

TagFileReader - Interface in gov.loc.repository.bagit.reader

Convenience class for reading tag files from the filesystem

toString() - Method in class gov.loc.repository.bagit.conformance.profile.BagInfoRequirement

toString() - Method in class gov.loc.repository.bagit.conformance.profile.BagitProfile

toString() - Method in class gov.loc.repository.bagit.domain.Bag

toString() - Method in class gov.loc.repository.bagit.domain.FetchItem

toString() - Method in class gov.loc.repository.bagit.domain.Manifest

toString() - Method in class gov.loc.repository.bagit.domain.Metadata

toString() - Method in class gov.loc.repository.bagit.domain.Version

U

UnparsableVersionException - Exception in gov.loc.repository.bagit.exceptions

If the version string in the bagit.txt file was not in the form <MAJOR>.<MINOR>

UnparsableVersionException(String, String) - Constructor for exception gov.loc.repository.bagit.exceptions.UnparsableVersionException

UnsupportedAlgorithmException - Exception in gov.loc.repository.bagit.exceptions

When the bag uses an checksum algorithm that is not supported by MessageDigest.

UnsupportedAlgorithmException(String, String, Throwable) - Constructor for exception gov.loc.repository.bagit.exceptions.UnsupportedAlgorithmException

upsertPayloadOxum(String) - Method in class gov.loc.repository.bagit.domain.Metadata

payload oxum is a special case where it makes no sense to have multiple values so instead of just appending we upsert (insert or update)

url - Variable in class gov.loc.repository.bagit.domain.FetchItem

The url from which the item can be downloaded

V

valueOf(String) - Static method in enum gov.loc.repository.bagit.conformance.BagitWarning

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.loc.repository.bagit.conformance.profile.Serialization

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum gov.loc.repository.bagit.hash.StandardSupportedAlgorithms

Returns the enum constant of this type with the specified name.

values() - Static method in enum gov.loc.repository.bagit.conformance.BagitWarning

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.loc.repository.bagit.conformance.profile.Serialization

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum gov.loc.repository.bagit.hash.StandardSupportedAlgorithms

Returns an array containing the constants of this enum type, in the order they are declared.

VerificationException - Exception in gov.loc.repository.bagit.exceptions

Class to represent an generic exception that happened during verification.

VerificationException(Exception) - Constructor for exception gov.loc.repository.bagit.exceptions.VerificationException

verifyManifests(Bag, boolean) - Method in class gov.loc.repository.bagit.verify.ManifestVerifier

Verify that all the files in the payload directory are listed in the payload manifest and all files listed in all manifests exist.

Version - Class in gov.loc.repository.bagit.domain

The version of the bagit specification used to create the bag.

Version(int, int) - Constructor for class gov.loc.repository.bagit.domain.Version

VersionChecker - Interface in gov.loc.repository.bagit.conformance

Part of the BagIt conformance suite.

visitFile(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.creator.AbstractCreateManifestsVistor

visitFile(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.verify.FileCountAndTotalSizeVistor

visitFile(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.verify.PayloadFileExistsInAllManifestsVistor

visitFile(Path, BasicFileAttributes) - Method in class gov.loc.repository.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

W

write(Bag, Path) - Static method in class gov.loc.repository.bagit.writer.BagWriter

Write the bag out to the specified directory.

writeBagitFile(Version, Charset, Path) - Static method in class gov.loc.repository.bagit.writer.BagitFileWriter

Write the bagit.txt file in required UTF-8 encoding.

writeBagMetadata(Metadata, Version, Path, Charset) - Static method in class gov.loc.repository.bagit.writer.MetadataWriter

Write the bag-info.txt (or package-info.txt) file to the specified outputDir with specified encoding (charsetName)

writeFetchFile(List<FetchItem>, Path, Path, Charset) - Static method in class gov.loc.repository.bagit.writer.FetchWriter

Write the fetch.txt file to the outputDir with the specified encoding (charsetName)

writePayloadFiles(Set<Manifest>, List<FetchItem>, Path, Path) - Static method in class gov.loc.repository.bagit.writer.PayloadWriter

Write the payload file(s) to the output directory

writePayloadManifests(Set<Manifest>, Path, Path, Charset) - Static method in class gov.loc.repository.bagit.writer.ManifestWriter

Write the payload manifest(s) to the output directory

writeTagManifests(Set<Manifest>, Path, Path, Charset) - Static method in class gov.loc.repository.bagit.writer.ManifestWriter

Write the tag manifest(s) to the output directory

A B C D E F G H I K L M P Q R S T U V W