Index

A B C D E F G H I K L M N O P Q R S T U V W _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCreateManifestsVistor - Class in nl.knaw.dans.bagit.creator

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

AbstractCreateManifestsVistor(Map<Manifest, MessageDigest>, boolean) - Constructor for class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

AbstractPayloadFileExistsInManifestsVistor - Class in nl.knaw.dans.bagit.verify

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

AbstractPayloadFileExistsInManifestsVistor(boolean) - Constructor for class nl.knaw.dans.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

abstractPreVisitDirectory(Path, String) - Method in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

acceptableBagitVersions - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

acceptableMIMESerializationTypes - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

acceptableValues - Variable in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

add(String, String) - Method in class nl.knaw.dans.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 nl.knaw.dans.bagit.domain.Metadata

add multiple metadata entries

addMessageDigestHashToManifest(Path, Map<Manifest, MessageDigest>) - Static method in class nl.knaw.dans.bagit.hash.Hasher

algorithm - Variable in class nl.knaw.dans.bagit.domain.Manifest

algorithm - Variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

B

Bag - Class in nl.knaw.dans.bagit.domain

The main representation of the bagit spec.

Bag() - Constructor for class nl.knaw.dans.bagit.domain.Bag

empty bag with an invalid version

Bag(Bag) - Constructor for class nl.knaw.dans.bagit.domain.Bag

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

Bag(Version) - Constructor for class nl.knaw.dans.bagit.domain.Bag

empty bag with the specified bag version

BAG_WITHIN_A_BAG - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

bagConformsToProfile(InputStream, Bag) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.creator

Responsible for creating a bag in place.

BagCreator() - Constructor for class nl.knaw.dans.bagit.creator.BagCreator

BagInfoRequirement - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

BagInfoRequirement(boolean, List<String>) - Constructor for class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

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

BagInfoRequirement(boolean, List<String>, boolean) - Constructor for class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

Constructs a new BagInfoRequirement.

bagInfoRequirements - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

bagInPlace(Path, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

Creates a bag in place for version 0.97.

bagInPlace(Path, Collection<SupportedAlgorithm>, boolean, Metadata) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

Creates a bag in place for version 0.97.

bagInPlace(Version, Path, Collection<SupportedAlgorithm>, boolean, Metadata) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

BagitAlgorithmNameToSupportedAlgorithmMapping - Interface in nl.knaw.dans.bagit.hash

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

BagitFileWriter - Class in nl.knaw.dans.bagit.writer

Responsible for writing the bagit.txt to the filesystem

BagitFileWriter() - Constructor for class nl.knaw.dans.bagit.writer.BagitFileWriter

BagitProfile - Class in nl.knaw.dans.bagit.conformance.profile

POJO for all the bagit profile fields.

BagitProfile() - Constructor for class nl.knaw.dans.bagit.conformance.profile.BagitProfile

BagitProfileDeserializer - Class in nl.knaw.dans.bagit.conformance.profile

Deserialize bagit profile json to a BagitProfile

BagitProfileDeserializer() - Constructor for class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

BagitProfileDeserializer(Class<?>) - Constructor for class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

bagitProfileIdentifier - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

BagitTextFileReader - Class in nl.knaw.dans.bagit.reader

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

BagitTextFileReader() - Constructor for class nl.knaw.dans.bagit.reader.BagitTextFileReader

BagitVersionIsNotAcceptableException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.conformance.BagitVersionIsNotAcceptableException

BagitWarning - Enum Class in nl.knaw.dans.bagit.conformance

The BagIt specification is very flexible in what it allows.

BagitWarning(String) - Constructor for enum class nl.knaw.dans.bagit.conformance.BagitWarning

BagLinter - Class in nl.knaw.dans.bagit.conformance

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

BagLinter() - Constructor for class nl.knaw.dans.bagit.conformance.BagLinter

BagProfileChecker - Class in nl.knaw.dans.bagit.conformance

Responsible for checking a bag against a profile

BagProfileChecker() - Constructor for class nl.knaw.dans.bagit.conformance.BagProfileChecker

BagReader - Class in nl.knaw.dans.bagit.reader

Responsible for reading a bag from the filesystem.

BagReader() - Constructor for class nl.knaw.dans.bagit.reader.BagReader

BagReader(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class nl.knaw.dans.bagit.reader.BagReader

BagVerifier - Class in nl.knaw.dans.bagit.verify

Responsible for verifying if a bag is valid, complete

BagVerifier() - Constructor for class nl.knaw.dans.bagit.verify.BagVerifier

Create a BagVerifier with a cached thread pool and a StandardBagitAlgorithmNameToSupportedAlgorithmMapping

BagVerifier(ExecutorService) - Constructor for class nl.knaw.dans.bagit.verify.BagVerifier

Create a BagVerifier with a custom thread pool and a StandardBagitAlgorithmNameToSupportedAlgorithmMapping

BagVerifier(ExecutorService, BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class nl.knaw.dans.bagit.verify.BagVerifier

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

BagVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class nl.knaw.dans.bagit.verify.BagVerifier

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

BagWriter - Class in nl.knaw.dans.bagit.writer

responsible for writing out a Bag

BagWriter() - Constructor for class nl.knaw.dans.bagit.writer.BagWriter

BOM - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

C

cachedString - Variable in class nl.knaw.dans.bagit.domain.FetchItem

cachedToString - Variable in class nl.knaw.dans.bagit.domain.Version

calculatePayloadManifests(Bag, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

calculateTagManifests(Bag, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

canQuickVerify(Bag) - Static method in class nl.knaw.dans.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 nl.knaw.dans.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 nl.knaw.dans.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!

checkAlgorthm(String, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

CheckAllFilesInPayloadDirAreListedInAllManifests(Set<Manifest>, Path, boolean) - Static method in class nl.knaw.dans.bagit.verify.ManifestVerifier

checkAllFilesInPayloadDirAreListedInAtLeastOneAManifest(Set<Path>, Path, boolean) - Static method in class nl.knaw.dans.bagit.verify.ManifestVerifier

checkAllFilesListedInManifestExist(Set<Path>) - Method in class nl.knaw.dans.bagit.verify.ManifestVerifier

checkBagitFileExists(Path, Version) - Static method in class nl.knaw.dans.bagit.verify.MandatoryVerifier

make sure the bagit.txt file exists

checkBagMetadata(Path, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.MetadataChecker

checkEncoding(Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in interface nl.knaw.dans.bagit.conformance.EncodingChecker

checkFetch(Path, boolean, List<FetchItem>) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

checkFetchItemsExist(List<FetchItem>, Path) - Static method in class nl.knaw.dans.bagit.verify.MandatoryVerifier

make sure all the fetch items exist in the data directory

checkForAcceptableValues(Metadata, Map.Entry<String, BagInfoRequirement>) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

checkForBagWithinBag(String, Set<BagitWarning>, Collection<BagitWarning>, boolean) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkForDifferentCase(String, Set<String>, Path, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkForExtraLines(Path, Collection<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.BagLinter

checkForManifestCreatedWithMD5SumTools(String, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkForNoneRepeatableMetadata(Metadata, Map.Entry<String, BagInfoRequirement>, boolean) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

checkForOSSpecificFiles(String, Set<BagitWarning>, Collection<BagitWarning>, Path) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkForPayloadOxumMetadata(Path, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.MetadataChecker

checkForRelativePaths(String, Set<BagitWarning>, Collection<BagitWarning>, Path) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkHashes(Manifest) - Method in class nl.knaw.dans.bagit.verify.BagVerifier

checkIfAtLeastOnePayloadManifestsExist(Path, Version) - Static method in class nl.knaw.dans.bagit.verify.MandatoryVerifier

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

CheckIfFileExistsTask - Class in nl.knaw.dans.bagit.verify

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

CheckIfFileExistsTask(Path, Set<Path>, CountDownLatch) - Constructor for class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

checkIfMetadataEntryIsRequired(Map.Entry<String, BagInfoRequirement>, boolean) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

checkLineFormat(String, String) - Static method in class nl.knaw.dans.bagit.reader.KeyValueReader

checkManifest(Path, List<Path>, List<Path>, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkManifestEntry(Map.Entry<Path, String>, MessageDigest, String) - Static method in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

CheckManifestHashesTask - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.verify.CheckManifestHashesTask

checkManifestPayload(Path, Charset, Set<BagitWarning>, Collection<BagitWarning>, boolean) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkManifests(Version, Path, Charset, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

Check for all the manifest specific potential problems

checkManifestSets(Version, List<Path>, List<Path>, Set<BagitWarning>, Charset) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkManifestsListSameSetOfFiles(Set<BagitWarning>, List<Path>, Charset) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkMetadata(Metadata, Map<String, BagInfoRequirement>) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

checkNormalization(String, Path, Set<BagitWarning>, Collection<BagitWarning>) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

checkPayloadDirectoryExists(Bag) - Static method in class nl.knaw.dans.bagit.verify.MandatoryVerifier

Make sure the payload directory exists

checkVersion(Version, Set<BagitWarning>, Collection<BagitWarning>) - Static method in interface nl.knaw.dans.bagit.conformance.VersionChecker

CHUNK_SIZE - Static variable in class nl.knaw.dans.bagit.hash.Hasher

close() - Method in class nl.knaw.dans.bagit.verify.BagVerifier

close() - Method in class nl.knaw.dans.bagit.verify.ManifestVerifier

compareTo(Version) - Method in class nl.knaw.dans.bagit.domain.Version

contactEmail - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

contactName - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

contactPhone - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

contains(String) - Method in class nl.knaw.dans.bagit.domain.Metadata

check if the metadata contains a particular label(key)

CorruptChecksumException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.CorruptChecksumException

count - Variable in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

createBagitFile(Bag) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

createDotBagit(Path, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

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

createDotBagit(Path, Collection<SupportedAlgorithm>, boolean, Metadata) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

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

createFileFromManifest(Path, String) - Static method in interface nl.knaw.dans.bagit.reader.TagFileReader

createManifestToMessageDigestMap(Collection<SupportedAlgorithm>) - Static method in class nl.knaw.dans.bagit.hash.Hasher

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

createMetadataFile(Bag, Metadata) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

createPayloadManifests(Bag, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

CreatePayloadManifestsVistor - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.creator.CreatePayloadManifestsVistor

createTagManifests(Bag, Collection<SupportedAlgorithm>, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

CreateTagManifestsVistor - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.creator.CreateTagManifestsVistor

D

DATE_FORMAT - Static variable in class nl.knaw.dans.bagit.creator.BagCreator

decodeFilname(String) - Static method in class nl.knaw.dans.bagit.util.PathUtils

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

deserialize(JsonParser, DeserializationContext) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

DIFFERENT_CASE - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

DIFFERENT_NORMALIZATION - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

DOT_BAGIT_DIR_NAME - Static variable in class nl.knaw.dans.bagit.util.PathUtils

DOT_BAGIT_DIR_NAME - Static variable in class nl.knaw.dans.bagit.verify.MandatoryVerifier

DOT_BAGIT_VERSION - Static variable in class nl.knaw.dans.bagit.creator.BagCreator

DS_STORE_FILE - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

E

encodeFilename(Path) - Static method in class nl.knaw.dans.bagit.util.PathUtils

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

EncodingChecker - Interface in nl.knaw.dans.bagit.conformance

Part of the BagIt conformance suite.

entry - Variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

equals(Object) - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

equals(Object) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

equals(Object) - Method in class nl.knaw.dans.bagit.domain.Bag

equals(Object) - Method in class nl.knaw.dans.bagit.domain.FetchItem

equals(Object) - Method in class nl.knaw.dans.bagit.domain.Manifest

equals(Object) - Method in class nl.knaw.dans.bagit.domain.Metadata

equals(Object) - Method in class nl.knaw.dans.bagit.domain.Version

ERROR_PREFIX - Static variable in interface nl.knaw.dans.bagit.reader.TagFileReader

exceptions - Variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

executor - Variable in class nl.knaw.dans.bagit.verify.BagVerifier

executor - Variable in class nl.knaw.dans.bagit.verify.ManifestVerifier

existsNormalized() - Method in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

if a file is parially normalized or of a different normalization then the manifest specifies it will fail the existence test.

externalDescription - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

EXTRA_LINES_IN_BAGIT_FILES - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

F

FETCH_LINE_REGEX - Static variable in class nl.knaw.dans.bagit.reader.FetchReader

fetchFileAllowed - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

FetchFileNotAllowedException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.conformance.FetchFileNotAllowedException

FetchItem - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.domain.FetchItem

FetchReader - Class in nl.knaw.dans.bagit.reader

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

FetchReader() - Constructor for class nl.knaw.dans.bagit.reader.FetchReader

FetchWriter - Class in nl.knaw.dans.bagit.writer

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

FetchWriter() - Constructor for class nl.knaw.dans.bagit.writer.FetchWriter

file - Variable in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

FileCountAndTotalSizeVistor - Class in nl.knaw.dans.bagit.verify

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

FileCountAndTotalSizeVistor() - Constructor for class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

fileEncoding - Variable in class nl.knaw.dans.bagit.domain.Bag

FileNotInManifestException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.FileNotInManifestException

FileNotInPayloadDirectoryException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.FileNotInPayloadDirectoryException

filesListedInManifests - Variable in class nl.knaw.dans.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

fileToChecksumMap - Variable in class nl.knaw.dans.bagit.domain.Manifest

forbidden - Enum constant in enum class nl.knaw.dans.bagit.conformance.profile.Serialization

formatFetchLine(FetchItem, Path) - Static method in class nl.knaw.dans.bagit.writer.FetchWriter

formatMessageDigest(MessageDigest) - Static method in class nl.knaw.dans.bagit.hash.Hasher

formatRelativePathString(Path, Path) - Static method in class nl.knaw.dans.bagit.writer.RelativePathWriter

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

FS_EVENTS_FILE - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

G

generatePayloadOxum(Path) - Static method in class nl.knaw.dans.bagit.util.PathUtils

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

get(String) - Method in class nl.knaw.dans.bagit.domain.Metadata

get all the values for a specific label (key)

getAcceptableBagitVersions() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getAcceptableMIMESerializationTypes() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getAcceptableValues() - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

getAlgorithm() - Method in class nl.knaw.dans.bagit.domain.Manifest

getAll() - Method in class nl.knaw.dans.bagit.domain.Metadata

all the metadata

getAllFilesListedInManifests(Bag) - Method in class nl.knaw.dans.bagit.verify.ManifestVerifier

getAllManifestFiles(Path) - Static method in class nl.knaw.dans.bagit.reader.ManifestReader

getBagInfoRequirements() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getBagitDir(Bag) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.util.PathUtils

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

getBagitName() - Method in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

getBagitName() - Method in interface nl.knaw.dans.bagit.hash.SupportedAlgorithm

getBagitProfileIdentifier() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getContactEmail() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getContactName() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getContactPhone() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getCount() - Method in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

getDataDir(Bag) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.util.PathUtils

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

getExecutor() - Method in class nl.knaw.dans.bagit.verify.BagVerifier

getExternalDescription() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getFetchPaths(List<FetchItem>, Path) - Static method in class nl.knaw.dans.bagit.writer.PayloadWriter

getFileEncoding() - Method in class nl.knaw.dans.bagit.domain.Bag

getFilename(Path) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.domain.Manifest

getItemsToFetch() - Method in class nl.knaw.dans.bagit.domain.Bag

getLength() - Method in class nl.knaw.dans.bagit.domain.FetchItem

getList() - Method in class nl.knaw.dans.bagit.domain.Metadata

getMajor() - Method in class nl.knaw.dans.bagit.domain.Version

getManifestTypesRequired() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getManifestVerifier() - Method in class nl.knaw.dans.bagit.verify.BagVerifier

getMap() - Method in class nl.knaw.dans.bagit.domain.Metadata

getMessageDigestName() - Method in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

getMessageDigestName() - Method in interface nl.knaw.dans.bagit.hash.SupportedAlgorithm

getMetadata() - Method in class nl.knaw.dans.bagit.domain.Bag

getMinor() - Method in class nl.knaw.dans.bagit.domain.Version

getNameMapping() - Method in class nl.knaw.dans.bagit.reader.BagReader

getOsFilesRegex() - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

getPath() - Method in class nl.knaw.dans.bagit.domain.FetchItem

getPayLoadManifests() - Method in class nl.knaw.dans.bagit.domain.Bag

getPayloadOxum(Bag) - Static method in class nl.knaw.dans.bagit.verify.QuickVerifier

getReason() - Method in enum class nl.knaw.dans.bagit.conformance.BagitWarning

getRootDir() - Method in class nl.knaw.dans.bagit.domain.Bag

getSerialization() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getSourceOrganization() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getSupportedAlgorithm(String) - Method in interface nl.knaw.dans.bagit.hash.BagitAlgorithmNameToSupportedAlgorithmMapping

getSupportedAlgorithm(String) - Method in class nl.knaw.dans.bagit.hash.StandardBagitAlgorithmNameToSupportedAlgorithmMapping

getTagFilesRequired() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getTagManifests() - Method in class nl.knaw.dans.bagit.domain.Bag

getTagManifestTypesRequired() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getTotalSize() - Method in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

getUrl() - Method in class nl.knaw.dans.bagit.domain.FetchItem

getVersion() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

getVersion() - Method in class nl.knaw.dans.bagit.domain.Bag

H

hash(Path, MessageDigest) - Static method in class nl.knaw.dans.bagit.hash.Hasher

Create a HEX formatted string checksum hash of the file

hash(Path, Map<Manifest, MessageDigest>) - Static method in class nl.knaw.dans.bagit.hash.Hasher

Update the Manifests with the file's hash

hashCode() - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

hashCode() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

hashCode() - Method in class nl.knaw.dans.bagit.domain.Bag

hashCode() - Method in class nl.knaw.dans.bagit.domain.FetchItem

hashCode() - Method in class nl.knaw.dans.bagit.domain.Manifest

hashCode() - Method in class nl.knaw.dans.bagit.domain.Metadata

hashCode() - Method in class nl.knaw.dans.bagit.domain.Version

Hasher - Class in nl.knaw.dans.bagit.hash

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

Hasher() - Constructor for class nl.knaw.dans.bagit.hash.Hasher

I

ignoreHiddenFiles - Variable in class nl.knaw.dans.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

includeHiddenFiles - Variable in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

Incubating - Annotation Interface in nl.knaw.dans.bagit.annotation

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

INDENTED_LINE_REGEX - Static variable in class nl.knaw.dans.bagit.reader.KeyValueReader

internalToString() - Method in class nl.knaw.dans.bagit.domain.FetchItem

InvalidBagitFileFormatException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.InvalidBagitFileFormatException

InvalidBagitFileFormatException(String, Exception) - Constructor for exception nl.knaw.dans.bagit.exceptions.InvalidBagitFileFormatException

InvalidBagMetadataException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.InvalidBagMetadataException

InvalidPayloadOxumException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.InvalidPayloadOxumException

isComplete(Bag, boolean) - Method in class nl.knaw.dans.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 nl.knaw.dans.bagit.domain.Metadata

isFetchFileAllowed() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

isHidden(Path) - Static method in class nl.knaw.dans.bagit.util.PathUtils

Due to the way that windows handles hidden files vs.

isNewer(Version) - Method in class nl.knaw.dans.bagit.domain.Version

isOlder(Version) - Method in class nl.knaw.dans.bagit.domain.Version

isRepeatable() - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

isRequired() - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

isSameOrNewer(Version) - Method in class nl.knaw.dans.bagit.domain.Version

isSameOrOlder(Version) - Method in class nl.knaw.dans.bagit.domain.Version

isValid(Bag, boolean) - Method in class nl.knaw.dans.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.

itemsToFetch - Variable in class nl.knaw.dans.bagit.domain.Bag

K

KeyValueReader - Class in nl.knaw.dans.bagit.reader

Convenience class for reading key value pairs from a file

KeyValueReader() - Constructor for class nl.knaw.dans.bagit.reader.KeyValueReader

L

latch - Variable in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

latch - Variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

LATEST_BAGIT_VERSION - Static variable in interface nl.knaw.dans.bagit.conformance.VersionChecker

LATEST_BAGIT_VERSION() - Static method in class nl.knaw.dans.bagit.domain.Version

LATEST_NON_DOT_BAGIT_VERSION - Static variable in class nl.knaw.dans.bagit.creator.BagCreator

LEADING_DOT_SLASH - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

length - Variable in class nl.knaw.dans.bagit.domain.FetchItem

The length of the file in octets

LINE1_REGEX - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

LINE2_REGEX - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

lintBag(Path) - Static method in class nl.knaw.dans.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 nl.knaw.dans.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.

list - Variable in class nl.knaw.dans.bagit.domain.Metadata

logger - Static variable in class nl.knaw.dans.bagit.conformance.BagLinter

logger - Static variable in class nl.knaw.dans.bagit.conformance.BagProfileChecker

logger - Static variable in interface nl.knaw.dans.bagit.conformance.EncodingChecker

logger - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

logger - Static variable in class nl.knaw.dans.bagit.conformance.MetadataChecker

logger - Static variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

logger - Static variable in interface nl.knaw.dans.bagit.conformance.VersionChecker

logger - Static variable in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

logger - Static variable in class nl.knaw.dans.bagit.creator.BagCreator

logger - Static variable in class nl.knaw.dans.bagit.hash.Hasher

logger - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

logger - Static variable in class nl.knaw.dans.bagit.reader.FetchReader

logger - Static variable in class nl.knaw.dans.bagit.reader.KeyValueReader

logger - Static variable in class nl.knaw.dans.bagit.reader.ManifestReader

logger - Static variable in class nl.knaw.dans.bagit.reader.MetadataReader

logger - Static variable in interface nl.knaw.dans.bagit.reader.TagFileReader

logger - Static variable in class nl.knaw.dans.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

logger - Static variable in class nl.knaw.dans.bagit.verify.BagVerifier

logger - Static variable in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

logger - Static variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

logger - Static variable in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

logger - Static variable in class nl.knaw.dans.bagit.verify.MandatoryVerifier

logger - Static variable in class nl.knaw.dans.bagit.verify.ManifestVerifier

logger - Static variable in class nl.knaw.dans.bagit.verify.QuickVerifier

logger - Static variable in class nl.knaw.dans.bagit.writer.BagitFileWriter

logger - Static variable in class nl.knaw.dans.bagit.writer.BagWriter

logger - Static variable in class nl.knaw.dans.bagit.writer.FetchWriter

logger - Static variable in class nl.knaw.dans.bagit.writer.ManifestWriter

logger - Static variable in class nl.knaw.dans.bagit.writer.MetadataWriter

logger - Static variable in class nl.knaw.dans.bagit.writer.PayloadWriter

M

major - Variable in class nl.knaw.dans.bagit.domain.Version

MaliciousPathException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.MaliciousPathException

MandatoryVerifier - Class in nl.knaw.dans.bagit.verify

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

MandatoryVerifier() - Constructor for class nl.knaw.dans.bagit.verify.MandatoryVerifier

Manifest - Class in nl.knaw.dans.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 nl.knaw.dans.bagit.domain.Manifest

MANIFEST_SETS_DIFFER - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

ManifestChecker - Class in nl.knaw.dans.bagit.conformance

Part of the BagIt conformance suite.

ManifestChecker() - Constructor for class nl.knaw.dans.bagit.conformance.ManifestChecker

ManifestReader - Class in nl.knaw.dans.bagit.reader

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

ManifestReader() - Constructor for class nl.knaw.dans.bagit.reader.ManifestReader

manifests - Variable in class nl.knaw.dans.bagit.verify.PayloadFileExistsInAllManifestsVistor

manifestToMessageDigestMap - Variable in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

manifestTypesRequired - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

manifestVerifier - Variable in class nl.knaw.dans.bagit.verify.BagVerifier

ManifestVerifier - Class in nl.knaw.dans.bagit.verify

Responsible for all things related to the manifest during verification.

ManifestVerifier() - Constructor for class nl.knaw.dans.bagit.verify.ManifestVerifier

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

ManifestVerifier(ExecutorService) - Constructor for class nl.knaw.dans.bagit.verify.ManifestVerifier

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

ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping) - Constructor for class nl.knaw.dans.bagit.verify.ManifestVerifier

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

ManifestVerifier(BagitAlgorithmNameToSupportedAlgorithmMapping, ExecutorService) - Constructor for class nl.knaw.dans.bagit.verify.ManifestVerifier

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

ManifestWriter - Class in nl.knaw.dans.bagit.writer

Responsible for writing out a Manifest to the filesystem

ManifestWriter() - Constructor for class nl.knaw.dans.bagit.writer.ManifestWriter

map - Variable in class nl.knaw.dans.bagit.domain.Metadata

MD5 - Enum constant in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

MD5SUM_TOOL_GENERATED_MANIFEST - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

mergeIndentedLine(String, List<AbstractMap.SimpleImmutableEntry<String, String>>) - Static method in class nl.knaw.dans.bagit.reader.KeyValueReader

messageBundleKey - Variable in enum class nl.knaw.dans.bagit.conformance.BagitWarning

messageDigestName - Variable in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

messages - Static variable in enum class nl.knaw.dans.bagit.conformance.BagitWarning

messages - Static variable in class nl.knaw.dans.bagit.conformance.BagLinter

messages - Static variable in class nl.knaw.dans.bagit.conformance.BagProfileChecker

messages - Static variable in interface nl.knaw.dans.bagit.conformance.EncodingChecker

messages - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

messages - Static variable in class nl.knaw.dans.bagit.conformance.MetadataChecker

messages - Static variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

messages - Static variable in interface nl.knaw.dans.bagit.conformance.VersionChecker

messages - Static variable in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

messages - Static variable in class nl.knaw.dans.bagit.creator.BagCreator

messages - Static variable in class nl.knaw.dans.bagit.hash.Hasher

messages - Static variable in class nl.knaw.dans.bagit.hash.StandardBagitAlgorithmNameToSupportedAlgorithmMapping

messages - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

messages - Static variable in class nl.knaw.dans.bagit.reader.FetchReader

messages - Static variable in class nl.knaw.dans.bagit.reader.KeyValueReader

messages - Static variable in class nl.knaw.dans.bagit.reader.ManifestReader

messages - Static variable in class nl.knaw.dans.bagit.reader.MetadataReader

messages - Static variable in interface nl.knaw.dans.bagit.reader.TagFileReader

messages - Static variable in class nl.knaw.dans.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

messages - Static variable in class nl.knaw.dans.bagit.verify.BagVerifier

messages - Static variable in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

messages - Static variable in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

messages - Static variable in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

messages - Static variable in class nl.knaw.dans.bagit.verify.MandatoryVerifier

messages - Static variable in class nl.knaw.dans.bagit.verify.ManifestVerifier

messages - Static variable in class nl.knaw.dans.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

messages - Static variable in class nl.knaw.dans.bagit.verify.QuickVerifier

messages - Static variable in class nl.knaw.dans.bagit.writer.BagitFileWriter

messages - Static variable in class nl.knaw.dans.bagit.writer.BagWriter

messages - Static variable in class nl.knaw.dans.bagit.writer.FetchWriter

messages - Static variable in class nl.knaw.dans.bagit.writer.ManifestWriter

messages - Static variable in class nl.knaw.dans.bagit.writer.MetadataWriter

messages - Static variable in class nl.knaw.dans.bagit.writer.PayloadWriter

metadata - Variable in class nl.knaw.dans.bagit.domain.Bag

Metadata - Class in nl.knaw.dans.bagit.domain

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

Metadata() - Constructor for class nl.knaw.dans.bagit.domain.Metadata

MetadataChecker - Class in nl.knaw.dans.bagit.conformance

Part of the BagIt conformance suite.

MetadataChecker() - Constructor for class nl.knaw.dans.bagit.conformance.MetadataChecker

MetadataReader - Class in nl.knaw.dans.bagit.reader

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

MetadataReader() - Constructor for class nl.knaw.dans.bagit.reader.MetadataReader

MetadataWriter - Class in nl.knaw.dans.bagit.writer

Responsible for writing out the bag Metadata to the filesystem

MetadataWriter() - Constructor for class nl.knaw.dans.bagit.writer.MetadataWriter

MetatdataValueIsNotAcceptableException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.conformance.MetatdataValueIsNotAcceptableException

MetatdataValueIsNotRepeatableException - Exception in nl.knaw.dans.bagit.exceptions.conformance

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

MetatdataValueIsNotRepeatableException(String, String) - Constructor for exception nl.knaw.dans.bagit.exceptions.conformance.MetatdataValueIsNotRepeatableException

minor - Variable in class nl.knaw.dans.bagit.domain.Version

MISSING_TAG_MANIFEST - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

MissingBagitFileException - Exception in nl.knaw.dans.bagit.exceptions

The bagit.txt file is a required file.

MissingBagitFileException(String) - Constructor for exception nl.knaw.dans.bagit.exceptions.MissingBagitFileException

missingFiles - Variable in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

MissingPayloadDirectoryException - Exception in nl.knaw.dans.bagit.exceptions

The payload directory is a required file.

MissingPayloadDirectoryException(String, Path) - Constructor for exception nl.knaw.dans.bagit.exceptions.MissingPayloadDirectoryException

MissingPayloadManifestException - Exception in nl.knaw.dans.bagit.exceptions

A bagit bag needs at least one payload manifest.

MissingPayloadManifestException(String) - Constructor for exception nl.knaw.dans.bagit.exceptions.MissingPayloadManifestException

moveDataFiles(Path, Path, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

moveDataFilesIfNeeded(Bag, boolean) - Static method in class nl.knaw.dans.bagit.creator.BagCreator

N

nameMapping - Variable in class nl.knaw.dans.bagit.reader.BagReader

nameMapping - Variable in class nl.knaw.dans.bagit.verify.ManifestVerifier

nl.knaw.dans.bagit.annotation - package nl.knaw.dans.bagit.annotation

nl.knaw.dans.bagit.conformance - package nl.knaw.dans.bagit.conformance

nl.knaw.dans.bagit.conformance.profile - package nl.knaw.dans.bagit.conformance.profile

nl.knaw.dans.bagit.creator - package nl.knaw.dans.bagit.creator

nl.knaw.dans.bagit.domain - package nl.knaw.dans.bagit.domain

nl.knaw.dans.bagit.exceptions - package nl.knaw.dans.bagit.exceptions

nl.knaw.dans.bagit.exceptions.conformance - package nl.knaw.dans.bagit.exceptions.conformance

nl.knaw.dans.bagit.hash - package nl.knaw.dans.bagit.hash

nl.knaw.dans.bagit.reader - package nl.knaw.dans.bagit.reader

nl.knaw.dans.bagit.util - package nl.knaw.dans.bagit.util

nl.knaw.dans.bagit.verify - package nl.knaw.dans.bagit.verify

nl.knaw.dans.bagit.writer - package nl.knaw.dans.bagit.writer

NON_STANDARD_ALGORITHM - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

normalizePathToNFD(Path) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

O

OLD_BAGIT_VERSION - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

optional - Enum constant in enum class nl.knaw.dans.bagit.conformance.profile.Serialization

OS_FILES_REGEX - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

OS_SPECIFIC_FILES - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

P

parseAcceptableSerializationFormats(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseAcceptableVersions(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseBagInfo(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseBagitProfile(InputStream) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

parseBagitProfileInfo(JsonNode, BagitProfile) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseMandatoryTagsOfBagitProfileInfo(JsonNode, BagitProfile) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

Parse required tags due to specification defined at bagit profiles Note: If one of the tags is missing, a NullPointerException is thrown.

parseManifestTypesRequired(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseOptionalTagsOfBagitProfileInfo(JsonNode, BagitProfile) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

Parse optional tags due to specification defined at bagit profiles

parsePath(String) - Static method in class nl.knaw.dans.bagit.conformance.ManifestChecker

parseRequiredTagFiles(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseRequiredTagmanifestTypes(JsonNode) - Static method in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

parseVersion(String) - Static method in class nl.knaw.dans.bagit.reader.BagitTextFileReader

path - Variable in class nl.knaw.dans.bagit.domain.FetchItem

The path where the fetched item should be put

PathUtils - Class in nl.knaw.dans.bagit.util

Convenience class for dealing with various path issues

PathUtils() - Constructor for class nl.knaw.dans.bagit.util.PathUtils

PAYLOAD_DIR_NAME - Static variable in class nl.knaw.dans.bagit.util.PathUtils

PAYLOAD_OXUM - Static variable in class nl.knaw.dans.bagit.domain.Metadata

PAYLOAD_OXUM_MISSING - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

PAYLOAD_OXUM_REGEX - Static variable in class nl.knaw.dans.bagit.verify.QuickVerifier

PayloadFileExistsInAllManifestsVistor - Class in nl.knaw.dans.bagit.verify

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

PayloadFileExistsInAllManifestsVistor(Set<Manifest>, boolean) - Constructor for class nl.knaw.dans.bagit.verify.PayloadFileExistsInAllManifestsVistor

PayloadFileExistsInAtLeastOneManifestVistor - Class in nl.knaw.dans.bagit.verify

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

PayloadFileExistsInAtLeastOneManifestVistor(Set<Path>, boolean) - Constructor for class nl.knaw.dans.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

payLoadManifests - Variable in class nl.knaw.dans.bagit.domain.Bag

PayloadOxumDoesNotExistException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.PayloadOxumDoesNotExistException

PayloadWriter - Class in nl.knaw.dans.bagit.writer

Responsible for writing out the bag payload to the filesystem

PayloadWriter() - Constructor for class nl.knaw.dans.bagit.writer.PayloadWriter

preVisitDirectory(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.creator.CreatePayloadManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.creator.CreateTagManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.verify.AbstractPayloadFileExistsInManifestsVistor

preVisitDirectory(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

Q

quicklyVerify(Bag) - Static method in class nl.knaw.dans.bagit.verify.BagVerifier

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

quicklyVerify(Bag) - Static method in class nl.knaw.dans.bagit.verify.QuickVerifier

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

QuickVerifier - Class in nl.knaw.dans.bagit.verify

responsible for all things related to quick verification.

QuickVerifier() - Constructor for class nl.knaw.dans.bagit.verify.QuickVerifier

R

read(Path) - Method in class nl.knaw.dans.bagit.reader.BagReader

Read the bag from the filesystem and create a bag object

readAllManifests(BagitAlgorithmNameToSupportedAlgorithmMapping, Path, Bag) - Static method in class nl.knaw.dans.bagit.reader.ManifestReader

Finds and reads all manifest files in the rootDir and adds them to the given bag.

readBagitTextFile(Path) - Static method in class nl.knaw.dans.bagit.reader.BagitTextFileReader

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

readBagMetadata(Path, Charset) - Static method in class nl.knaw.dans.bagit.reader.MetadataReader

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

readChecksumFileMap(Path, Path, Charset) - Static method in class nl.knaw.dans.bagit.reader.ManifestReader

readFetch(Path, Charset, Path) - Static method in class nl.knaw.dans.bagit.reader.FetchReader

Reads a fetch.txt file

readKeyValuesFromFile(Path, String, Charset) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.reader.ManifestReader

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

RelativePathWriter - Class in nl.knaw.dans.bagit.writer

Convenience class for writing a relative path

RelativePathWriter() - Constructor for class nl.knaw.dans.bagit.writer.RelativePathWriter

remove(String) - Method in class nl.knaw.dans.bagit.domain.Metadata

remove the label and all its values

repeatable - Variable in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

required - Enum constant in enum class nl.knaw.dans.bagit.conformance.profile.Serialization

required - Variable in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

RequiredManifestNotPresentException - Exception in nl.knaw.dans.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 nl.knaw.dans.bagit.exceptions.conformance.RequiredManifestNotPresentException

requiredManifestsExist(Set<Manifest>, List<String>, boolean) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

RequiredMetadataFieldNotPresentException - Exception in nl.knaw.dans.bagit.exceptions.conformance

Class to represent when a specific metadata field is not found

RequiredMetadataFieldNotPresentException(String, String) - Constructor for exception nl.knaw.dans.bagit.exceptions.conformance.RequiredMetadataFieldNotPresentException

RequiredTagFileNotPresentException - Exception in nl.knaw.dans.bagit.exceptions.conformance

Class to represent when a specific tag file is not found

RequiredTagFileNotPresentException(String, String) - Constructor for exception nl.knaw.dans.bagit.exceptions.conformance.RequiredTagFileNotPresentException

requiredTagFilesExist(Path, List<String>) - Static method in class nl.knaw.dans.bagit.conformance.BagProfileChecker

rootDir - Variable in class nl.knaw.dans.bagit.domain.Bag

run() - Method in class nl.knaw.dans.bagit.verify.CheckIfFileExistsTask

run() - Method in class nl.knaw.dans.bagit.verify.CheckManifestHashesTask

S

serialization - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

Serialization - Enum Class in nl.knaw.dans.bagit.conformance.profile

The type of serialization required by a BagitProfile

Serialization() - Constructor for enum class nl.knaw.dans.bagit.conformance.profile.Serialization

serialVersionUID - Static variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfileDeserializer

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.BagitVersionIsNotAcceptableException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.FetchFileNotAllowedException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.MetatdataValueIsNotAcceptableException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.MetatdataValueIsNotRepeatableException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.RequiredManifestNotPresentException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.RequiredMetadataFieldNotPresentException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.conformance.RequiredTagFileNotPresentException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.CorruptChecksumException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.FileNotInManifestException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.FileNotInPayloadDirectoryException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.InvalidBagitFileFormatException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.InvalidBagMetadataException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.InvalidPayloadOxumException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.MaliciousPathException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.MissingBagitFileException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.MissingPayloadDirectoryException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.MissingPayloadManifestException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.PayloadOxumDoesNotExistException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.UnparsableVersionException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.UnsupportedAlgorithmException

serialVersionUID - Static variable in exception nl.knaw.dans.bagit.exceptions.VerificationException

setAcceptableBagitVersions(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setAcceptableMIMESerializationTypes(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setAcceptableValues(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

setBagInfoRequirements(Map<String, BagInfoRequirement>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setBagitProfileIdentifier(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setContactEmail(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setContactName(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setContactPhone(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setExternalDescription(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setFetchFileAllowed(boolean) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setFileEncoding(Charset) - Method in class nl.knaw.dans.bagit.domain.Bag

setFileToChecksumMap(Map<Path, String>) - Method in class nl.knaw.dans.bagit.domain.Manifest

setItemsToFetch(List<FetchItem>) - Method in class nl.knaw.dans.bagit.domain.Bag

setList(List<AbstractMap.SimpleImmutableEntry<String, String>>) - Method in class nl.knaw.dans.bagit.domain.Metadata

setManifestTypesRequired(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setMap(Map<String, List<String>>) - Method in class nl.knaw.dans.bagit.domain.Metadata

setMetadata(Metadata) - Method in class nl.knaw.dans.bagit.domain.Bag

setPayLoadManifests(Set<Manifest>) - Method in class nl.knaw.dans.bagit.domain.Bag

setRepeatable(boolean) - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

setRequired(boolean) - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

setRootDir(Path) - Method in class nl.knaw.dans.bagit.domain.Bag

setSerialization(Serialization) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setSourceOrganization(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setTagFilesRequired(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setTagManifests(Set<Manifest>) - Method in class nl.knaw.dans.bagit.domain.Bag

setTagManifestTypesRequired(List<String>) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setVersion(String) - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

setVersion(Version) - Method in class nl.knaw.dans.bagit.domain.Bag

SHA1 - Enum constant in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

SHA224 - Enum constant in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

SHA256 - Enum constant in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

SHA512 - Enum constant in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

sourceOrganization - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

SPOTLIGHT_FILE - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

StandardBagitAlgorithmNameToSupportedAlgorithmMapping - Class in nl.knaw.dans.bagit.hash

Provides a mapping between bagit algorithm names and SupportedAlgorithm

StandardBagitAlgorithmNameToSupportedAlgorithmMapping() - Constructor for class nl.knaw.dans.bagit.hash.StandardBagitAlgorithmNameToSupportedAlgorithmMapping

StandardSupportedAlgorithms - Enum Class in nl.knaw.dans.bagit.hash

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

StandardSupportedAlgorithms(String) - Constructor for enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

SupportedAlgorithm - Interface in nl.knaw.dans.bagit.hash

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

T

TAG_FILES_ENCODING - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

TagFileReader - Interface in nl.knaw.dans.bagit.reader

Convenience class for reading tag files from the filesystem

tagFilesRequired - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

tagManifests - Variable in class nl.knaw.dans.bagit.domain.Bag

tagManifestTypesRequired - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

throwErrorIfByteOrderMarkIsPresent(Path) - Static method in class nl.knaw.dans.bagit.reader.BagitTextFileReader

throwErrorIfLinesDoNotMatchStrict(List<String>) - Static method in class nl.knaw.dans.bagit.reader.BagitTextFileReader

THUMBS_DB_FILE - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

toString() - Method in class nl.knaw.dans.bagit.conformance.profile.BagInfoRequirement

toString() - Method in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

toString() - Method in class nl.knaw.dans.bagit.domain.Bag

toString() - Method in class nl.knaw.dans.bagit.domain.FetchItem

toString() - Method in class nl.knaw.dans.bagit.domain.Manifest

toString() - Method in class nl.knaw.dans.bagit.domain.Metadata

toString() - Method in class nl.knaw.dans.bagit.domain.Version

totalSize - Variable in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

TRASHES_FILE - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

U

UnparsableVersionException - Exception in nl.knaw.dans.bagit.exceptions

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

UnparsableVersionException(String, String) - Constructor for exception nl.knaw.dans.bagit.exceptions.UnparsableVersionException

UnsupportedAlgorithmException - Exception in nl.knaw.dans.bagit.exceptions

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

UnsupportedAlgorithmException(String, String, Throwable) - Constructor for exception nl.knaw.dans.bagit.exceptions.UnsupportedAlgorithmException

updateMessageDigests(Path, Collection<MessageDigest>) - Static method in class nl.knaw.dans.bagit.hash.Hasher

updateTagManifests(Bag, Path) - Static method in class nl.knaw.dans.bagit.writer.BagWriter

upsertPayloadOxum(String) - Method in class nl.knaw.dans.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 nl.knaw.dans.bagit.domain.FetchItem

The url from which the item can be downloaded

V

valueOf(String) - Static method in enum class nl.knaw.dans.bagit.conformance.BagitWarning

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

valueOf(String) - Static method in enum class nl.knaw.dans.bagit.conformance.profile.Serialization

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

valueOf(String) - Static method in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

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

values() - Static method in enum class nl.knaw.dans.bagit.conformance.BagitWarning

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

values() - Static method in enum class nl.knaw.dans.bagit.conformance.profile.Serialization

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

values() - Static method in enum class nl.knaw.dans.bagit.hash.StandardSupportedAlgorithms

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

VerificationException - Exception in nl.knaw.dans.bagit.exceptions

Class to represent an generic exception that happened during verification.

VerificationException(Exception) - Constructor for exception nl.knaw.dans.bagit.exceptions.VerificationException

verifyManifests(Bag, boolean) - Method in class nl.knaw.dans.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 - Variable in class nl.knaw.dans.bagit.conformance.profile.BagitProfile

version - Variable in class nl.knaw.dans.bagit.domain.Bag

Version - Class in nl.knaw.dans.bagit.domain

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

Version(int, int) - Constructor for class nl.knaw.dans.bagit.domain.Version

VERSION_0_95 - Static variable in class nl.knaw.dans.bagit.writer.MetadataWriter

VERSION_1_0 - Static variable in class nl.knaw.dans.bagit.conformance.BagLinter

VERSION_1_0 - Static variable in class nl.knaw.dans.bagit.conformance.ManifestChecker

VERSION_1_0 - Static variable in class nl.knaw.dans.bagit.reader.BagitTextFileReader

VERSION_2_0 - Static variable in class nl.knaw.dans.bagit.writer.PayloadWriter

VersionChecker - Interface in nl.knaw.dans.bagit.conformance

Part of the BagIt conformance suite.

visitFile(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.creator.AbstractCreateManifestsVistor

visitFile(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.verify.FileCountAndTotalSizeVistor

visitFile(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.verify.PayloadFileExistsInAllManifestsVistor

visitFile(Path, BasicFileAttributes) - Method in class nl.knaw.dans.bagit.verify.PayloadFileExistsInAtLeastOneManifestVistor

W

WEAK_CHECKSUM_ALGORITHM - Enum constant in enum class nl.knaw.dans.bagit.conformance.BagitWarning

write(Bag, Path) - Static method in class nl.knaw.dans.bagit.writer.BagWriter

Write the bag out to the specified directory.

writeBagitFile(Version, Charset, Path) - Static method in class nl.knaw.dans.bagit.writer.BagitFileWriter

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

writeBagMetadata(Metadata, Version, Path, Charset) - Static method in class nl.knaw.dans.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 nl.knaw.dans.bagit.writer.FetchWriter

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

writeManifests(Set<Manifest>, Path, Path, String, Charset) - Static method in class nl.knaw.dans.bagit.writer.ManifestWriter

writePayloadFiles(Set<Manifest>, List<FetchItem>, Path, Path) - Static method in class nl.knaw.dans.bagit.writer.PayloadWriter

Write the payload file(s) to the output directory

writePayloadManifests(Set<Manifest>, Path, Path, Charset) - Static method in class nl.knaw.dans.bagit.writer.ManifestWriter

Write the payload manifest(s) to the output directory

writeTagManifestFiles(Set<Manifest>, Path, Path) - Static method in class nl.knaw.dans.bagit.writer.BagWriter

writeTagManifests(Set<Manifest>, Path, Path, Charset) - Static method in class nl.knaw.dans.bagit.writer.ManifestWriter

Write the tag manifest(s) to the output directory

writeVersionDependentPayloadFiles(Bag, Path) - Static method in class nl.knaw.dans.bagit.writer.PayloadWriter

_

_64_KB - Static variable in class nl.knaw.dans.bagit.hash.Hasher

A B C D E F G H I K L M N O P Q R S T U V W _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form