A B C D E F G H I M O P R S T V W Z

A

ACCEPT_BAGIT_VERSION - Static variable in class org.duraspace.bagit.BagProfileConstants

ACCEPT_SERIALIZATION - Static variable in class org.duraspace.bagit.BagProfileConstants

ACCESS_KEY - Static variable in class org.duraspace.bagit.BagConfig

addTags(String, Map<String, String>) - Method in class org.duraspace.bagit.BagWriter

Add tags (metadata) to the Bag.

ALLOW_FETCH_TXT - Static variable in class org.duraspace.bagit.BagProfileConstants

APPLICATION_GTAR - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_GZIP - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_TAR - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_X_COMPRESSED_TAR - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_X_GTAR - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_X_GZIP - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_X_TAR - Static variable in class org.duraspace.bagit.SerializationSupport

APPLICATION_ZIP - Static variable in class org.duraspace.bagit.SerializationSupport

B

BAG_GROUP_IDENTIFIER - Static variable in class org.duraspace.bagit.BagConfig

BAG_INFO - Static variable in class org.duraspace.bagit.BagProfileConstants

BAG_INFO_KEY - Static variable in class org.duraspace.bagit.BagConfig

BAG_SIZE_KEY - Static variable in class org.duraspace.bagit.BagConfig

BagConfig - Class in org.duraspace.bagit

A convenience class for parsing and storing bagit-config.yml information.

BagConfig(File) - Constructor for class org.duraspace.bagit.BagConfig

Default constructor

BagConfig.AccessTypes - Enum in org.duraspace.bagit

BagDeserializer - Interface in org.duraspace.bagit

Interface for common deserialization operations for Bags.

BAGGING_DATE_KEY - Static variable in class org.duraspace.bagit.BagConfig

BAGIT_MD5 - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_PROFILE_IDENTIFIER - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_PROFILE_INFO - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_PROFILE_VERSION - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_SHA1 - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_SHA_256 - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_TAG_SUFFIX - Static variable in class org.duraspace.bagit.BagProfileConstants

BAGIT_VERSION - Static variable in class org.duraspace.bagit.BagWriter

Version of the BagIt specification implemented

BagItDigest - Enum in org.duraspace.bagit

bagitName() - Method in enum org.duraspace.bagit.BagItDigest

Retrieve the bagit formatted version of the algorithm

BagProfile - Class in org.duraspace.bagit

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

BagProfile(BagProfile.BuiltIn) - Constructor for class org.duraspace.bagit.BagProfile

Load a BagProfile from a BagProfile.BuiltIn profile type

BagProfile(InputStream) - Constructor for class org.duraspace.bagit.BagProfile

Create a BagProfile from a given InputStream

BagProfile.BuiltIn - Enum in org.duraspace.bagit

Enum of the built in profiles which are provided with bagit-support

BagProfile.Serialization - Enum in org.duraspace.bagit

BagProfileConstants - Class in org.duraspace.bagit

BagProfileConstants() - Constructor for class org.duraspace.bagit.BagProfileConstants

BagSerializer - Interface in org.duraspace.bagit

Serialize a BagIt bag into a single format.

BagWriter - Class in org.duraspace.bagit

Utility to write BagIt bags.

BagWriter(File, Set<BagItDigest>) - Constructor for class org.duraspace.bagit.BagWriter

Create a new, empty Bag

C

CONTACT_EMAIL_KEY - Static variable in class org.duraspace.bagit.BagConfig

CONTACT_NAME_KEY - Static variable in class org.duraspace.bagit.BagConfig

CONTACT_PHONE_KEY - Static variable in class org.duraspace.bagit.BagConfig

D

deserialize(Path) - Method in interface org.duraspace.bagit.BagDeserializer

Deserialize a Bag located at the given path.

deserialize(Path) - Method in class org.duraspace.bagit.GZipBagDeserializer

deserialize(Path) - Method in class org.duraspace.bagit.TarBagDeserializer

deserialize(Path) - Method in class org.duraspace.bagit.ZipBagDeserializer

deserializerFor(Path, BagProfile) - Static method in class org.duraspace.bagit.SerializationSupport

Get a BagDeserializer for a given content type.

E

EXTERNAL_DESCRIPTION_KEY - Static variable in class org.duraspace.bagit.BagConfig

EXTERNAL_IDENTIFIER_KEY - Static variable in class org.duraspace.bagit.BagConfig

F

from(String) - Static method in enum org.duraspace.bagit.BagProfile.BuiltIn

Retrieve a built in profile from an identifier

G

getAcceptedBagItVersions() - Method in class org.duraspace.bagit.BagProfile

Get the supported BagIt versions

getAcceptedSerializations() - Method in class org.duraspace.bagit.BagProfile

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

getAllowedPayloadAlgorithms() - Method in class org.duraspace.bagit.BagProfile

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

getAllowedTagAlgorithms() - Method in class org.duraspace.bagit.BagProfile

Get the tag manifest algorithms which are allowed.

getAPTrustInfo() - Method in class org.duraspace.bagit.BagConfig

Returns an immutable map of aptrust info properties.

getBagInfo() - Method in class org.duraspace.bagit.BagConfig

Returns an immutable map of bag info properties.

getCommonTypeMap() - Static method in class org.duraspace.bagit.SerializationSupport

Visible for testing only Retrieve a copy of the commonTypeMap

getDescription() - Method in class org.duraspace.bagit.ProfileFieldRule

getFieldsForTagFile(String) - Method in class org.duraspace.bagit.BagConfig

Returns an immutable map of custom tags for a tag file

getIdentifier() - Method in enum org.duraspace.bagit.BagProfile.BuiltIn

Get the identifier associated with the profile

getIdentifier() - Method in class org.duraspace.bagit.BagProfile

Retrieve the BagIt-Profile-Identifier for this profile

getMetadataFields() - Method in class org.duraspace.bagit.BagProfile

Get the required Bag-Info metadata fields.

getMetadataFields(String) - Method in class org.duraspace.bagit.BagProfile

Get the required tags for the extra tag file

getPayloadDigestAlgorithms() - Method in class org.duraspace.bagit.BagProfile

Get the required digest algorithms for payload manifests.

getProfileMetadata() - Method in class org.duraspace.bagit.BagProfile

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

getRootDir() - Method in class org.duraspace.bagit.BagWriter

Get the Bag's root directory

getSectionNames() - Method in class org.duraspace.bagit.BagProfile

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

getSerialization() - Method in class org.duraspace.bagit.BagProfile

Get the support of serialization for a Bag.

getTagDigestAlgorithms() - Method in class org.duraspace.bagit.BagProfile

Get the required digest algorithms for tag manifests.

getTagFiles() - Method in class org.duraspace.bagit.BagConfig

Returns all the tag files from the config

getTagFilesAllowed() - Method in class org.duraspace.bagit.BagProfile

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

getTagFilesRequired() - Method in class org.duraspace.bagit.BagProfile

Get the tag files which are required to exist

getTags(String) - Method in class org.duraspace.bagit.BagWriter

Get the current tag (metadata) of the Bag

getValues() - Method in class org.duraspace.bagit.ProfileFieldRule

GZIP_TYPES - Static variable in class org.duraspace.bagit.SerializationSupport

GZipBagDeserializer - Class in org.duraspace.bagit

Deflate a gzipped bag so that the underlying bag can continue to be deserialized.

GZipBagDeserializer(BagProfile) - Constructor for class org.duraspace.bagit.GZipBagDeserializer

H

hasTagFile(String) - Method in class org.duraspace.bagit.BagConfig

Check if a tag file is listed in bag config

HexEncoder - Class in org.duraspace.bagit

Simple encoder to convert a byte array to bytes.

I

INTERNAL_SENDER_DESCRIPTION_KEY - Static variable in class org.duraspace.bagit.BagConfig

INTERNAL_SENDER_IDENTIFIER_KEY - Static variable in class org.duraspace.bagit.BagConfig

isAllowFetch() - Method in class org.duraspace.bagit.BagProfile

Boolean flag allowing a fetch.txt file

isRecommended() - Method in class org.duraspace.bagit.ProfileFieldRule

isRepeatable() - Method in class org.duraspace.bagit.ProfileFieldRule

isRequired() - Method in class org.duraspace.bagit.ProfileFieldRule

M

MANIFESTS_ALLOWED - Static variable in class org.duraspace.bagit.BagProfileConstants

MANIFESTS_REQUIRED - Static variable in class org.duraspace.bagit.BagProfileConstants

messageDigest() - Method in enum org.duraspace.bagit.BagItDigest

Retrieve a MessageDigest for the given algorithm

O

of(String) - Static method in enum org.duraspace.bagit.BagProfile.Serialization

Retrieve the BagProfile.Serialization from a string representation

org.duraspace.bagit - package org.duraspace.bagit

ORGANIZATION_ADDRESS_KEY - Static variable in class org.duraspace.bagit.BagConfig

OTHER_INFO - Static variable in class org.duraspace.bagit.BagProfileConstants

P

PAYLOAD_OXUM_KEY - Static variable in class org.duraspace.bagit.BagConfig

PROFILE_VERSION - Static variable in class org.duraspace.bagit.BagProfileConstants

ProfileFieldRule - Class in org.duraspace.bagit

Rules which can be applied to the Bag-Info and Other-Info sections of a Bag Profile.

ProfileFieldRule(boolean, boolean, boolean, String, Set<String>) - Constructor for class org.duraspace.bagit.ProfileFieldRule

Constructor for a ProfileFieldRule.

ProfileValidationException - Exception in org.duraspace.bagit

A profile validation exception.

ProfileValidationException(String) - Constructor for exception org.duraspace.bagit.ProfileValidationException

Default Constructor

ProfileValidationUtil - Class in org.duraspace.bagit

Utility methods for validating profiles.

R

registerChecksums(BagItDigest, Map<File, String>) - Method in class org.duraspace.bagit.BagWriter

Register checksums of payload (data) files

S

SERIALIZATION - Static variable in class org.duraspace.bagit.BagProfileConstants

SerializationSupport - Class in org.duraspace.bagit

Support class to retrieve BagDeserializers from a mime type

serialize(Path) - Method in interface org.duraspace.bagit.BagSerializer

Serialize a BagIt bag depending on the format defined by the implementing class.

serialize(Path) - Method in class org.duraspace.bagit.TarBagSerializer

serialize(Path) - Method in class org.duraspace.bagit.TarGzBagSerializer

serialize(Path) - Method in class org.duraspace.bagit.ZipBagSerializer

serializerFor(String, BagProfile) - Static method in class org.duraspace.bagit.SerializationSupport

Get a BagSerializer for a given content type and BagProfile.

SOURCE_ORGANIZATION_KEY - Static variable in class org.duraspace.bagit.BagConfig

SYSTEM_GENERATED_FIELD_NAMES - Static variable in class org.duraspace.bagit.ProfileValidationUtil

T

TAG_FILES_ALLOWED - Static variable in class org.duraspace.bagit.BagProfileConstants

TAG_FILES_REQUIRED - Static variable in class org.duraspace.bagit.BagProfileConstants

TAG_MANIFESTS_ALLOWED - Static variable in class org.duraspace.bagit.BagProfileConstants

TAG_MANIFESTS_REQUIRED - Static variable in class org.duraspace.bagit.BagProfileConstants

TAR_TYPES - Static variable in class org.duraspace.bagit.SerializationSupport

TarBagDeserializer - Class in org.duraspace.bagit

Deserializer for Bags serialized using tar

TarBagDeserializer() - Constructor for class org.duraspace.bagit.TarBagDeserializer

TarBagSerializer - Class in org.duraspace.bagit

Serialize a BagIt Bag into a Tar archive

TarBagSerializer() - Constructor for class org.duraspace.bagit.TarBagSerializer

TarGzBagSerializer - Class in org.duraspace.bagit

Serialize a BagIt bag to be a tar+gzip archive.

TarGzBagSerializer() - Constructor for class org.duraspace.bagit.TarGzBagSerializer

TITLE_KEY - Static variable in class org.duraspace.bagit.BagConfig

toString(byte[]) - Static method in class org.duraspace.bagit.HexEncoder

toString() - Method in class org.duraspace.bagit.ProfileFieldRule

String representation of a ProfileFieldRule

V

validate(String, Map<String, ProfileFieldRule>, Path) - Static method in class org.duraspace.bagit.ProfileValidationUtil

Validates a tag file against a set of requiredFields and their constrained values.

validate(String, Map<String, ProfileFieldRule>, Map<String, String>) - Static method in class org.duraspace.bagit.ProfileValidationUtil

Validates the fields against a set of requiredFields and their constrained values.

validateBag(Bag) - Method in class org.duraspace.bagit.BagProfile

Validate a given Bag against the current profile

validateConfig(BagConfig) - Method in class org.duraspace.bagit.BagProfile

Validate a given BagConfig against the current profile

validateManifest(Set<Manifest>, Set<String>, Set<String>, String) - Static method in class org.duraspace.bagit.ProfileValidationUtil

Validate that a manifests found in a Bag are allowed according to both the required and allowed sets from a BagProfile.

validateTagFiles(Map<String, Map<String, String>>) - Method in class org.duraspace.bagit.BagProfile

Validate a configuration for tag files based on a mapping of BagIt tag filenames to key-value pairs.

validateTagIsAllowed(Path, Set<String>) - Static method in class org.duraspace.bagit.ProfileValidationUtil

Check if a given tag file is part of the allowed tags.

valueOf(String) - Static method in enum org.duraspace.bagit.BagConfig.AccessTypes

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

valueOf(String) - Static method in enum org.duraspace.bagit.BagItDigest

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

valueOf(String) - Static method in enum org.duraspace.bagit.BagProfile.BuiltIn

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

valueOf(String) - Static method in enum org.duraspace.bagit.BagProfile.Serialization

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

values() - Static method in enum org.duraspace.bagit.BagConfig.AccessTypes

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

values() - Static method in enum org.duraspace.bagit.BagItDigest

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

values() - Static method in enum org.duraspace.bagit.BagProfile.BuiltIn

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

values() - Static method in enum org.duraspace.bagit.BagProfile.Serialization

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

W

write() - Method in class org.duraspace.bagit.BagWriter

Write metadata and finalize Bag

Z

ZIP_TYPES - Static variable in class org.duraspace.bagit.SerializationSupport

ZipBagDeserializer - Class in org.duraspace.bagit

Deserializer for Bags serialized using zip

ZipBagDeserializer() - Constructor for class org.duraspace.bagit.ZipBagDeserializer

ZipBagSerializer - Class in org.duraspace.bagit

Serialize a BagIt bag into a zip archive without compression

ZipBagSerializer() - Constructor for class org.duraspace.bagit.ZipBagSerializer

A B C D E F G H I M O P R S T V W Z