Index (OCFL Java Core 2.2.0 API)

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

A

AbstractOcflStorage - Class in io.ocfl.core.storage: OcflStorage abstract implementation that handles managing the repository's state, initialized, open, close.
AbstractOcflStorage() - Constructor for class io.ocfl.core.storage.AbstractOcflStorage
acceptList(char...) - Static method in class io.ocfl.core.path.constraint.BitSetPathCharConstraint: Creates a constraint that only accepts the specified characters
acceptListRange(char, char) - Static method in class io.ocfl.core.path.constraint.BitSetPathCharConstraint: Creates a constraint that accepts all of the characters in the given range
addAll(ValidationResults) - Method in class io.ocfl.core.validation.ValidationResultsBuilder
addAll(ValidationResultsBuilder) - Method in class io.ocfl.core.validation.ValidationResultsBuilder
addFile(String, String) - Method in class io.ocfl.core.model.VersionBuilder: Adds a file to the version's state
addFile(String, String, OcflOption...) - Method in class io.ocfl.core.inventory.InventoryUpdater: Adds a file.
addFileFixity(String, DigestAlgorithm, String) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
AddFileProcessor - Class in io.ocfl.core.inventory: Encapsulates logic for adding files to an object, both adding them to the inventory and moving them into staging.
AddFileProcessor(InventoryUpdater, FileLocker, Path, DigestAlgorithm) - Constructor for class io.ocfl.core.inventory.AddFileProcessor
AddFileProcessor.Builder - Class in io.ocfl.core.inventory
addFileProcessorBuilder - Variable in class io.ocfl.core.DefaultOcflRepository
addFileToManifest(String, String) - Method in class io.ocfl.core.model.InventoryBuilder: Adds a file to the manifest
addFixity(String, DigestAlgorithm, String) - Method in class io.ocfl.core.inventory.InventoryUpdater: Adds an entry to the fixity block.
addFixityForFile(String, DigestAlgorithm, String) - Method in class io.ocfl.core.model.InventoryBuilder: Adds a file to the fixity block
addHeadVersion(Version) - Method in class io.ocfl.core.model.InventoryBuilder: Add the version as the new HEAD version.
addIssue(ValidationCode, String, Object...) - Method in class io.ocfl.core.validation.ValidationResultsBuilder
addIssue(Optional<ValidationIssue>) - Method in class io.ocfl.core.validation.ValidationResultsBuilder
addObjectDetails(Inventory, String, byte[]) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Adds ObjectDetails to the database.
addObjectDetails(Inventory, String, byte[]) - Method in interface io.ocfl.core.db.ObjectDetailsDatabase: Adds ObjectDetails to the database.
addPath(Path, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
addPath(Path, String, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
ADDRESS_KEY - Static variable in class io.ocfl.core.validation.model.SimpleUser
addSafeCharRange(char, char) - Method in class io.ocfl.core.util.PercentEscaper.Builder: Adds a range of characters to the set of characters that do not need to be encoded.
addSafeChars(String) - Method in class io.ocfl.core.util.PercentEscaper.Builder: Adds each character in the string to the set of characters that do not need to be encoded.
addUnsafeCharRange(char, char) - Method in class io.ocfl.core.util.PercentEscaper.Builder: Adds a range of characters to the set of characters that need to be encoded.
addUnsafeChars(String) - Method in class io.ocfl.core.util.PercentEscaper.Builder: Adds each character in the string to the set of characters that need to be encoded.
all() - Static method in class io.ocfl.core.path.constraint.ContentPathConstraints: Constructs a ContentPathConstraintProcessor that applies the minimum path constraints across Unix, Windows, and cloud filesystems.
appendCharConstraint(PathCharConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new character constraint to the end of the list of character constraints
appendFileNameConstraint(FileNameConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new filename constraint to the end of the list of filename constraints
appendPathConstraint(PathConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new path constraint to the end of the list of path constraints
apply(char, String) - Method in class io.ocfl.core.path.constraint.BackslashPathSeparatorConstraint: Validates that the characters in a filename meet a defined constraint
apply(char, String) - Method in class io.ocfl.core.path.constraint.BitSetPathCharConstraint: Validates that the characters in a filename meet a defined constraint
apply(char, String) - Method in interface io.ocfl.core.path.constraint.PathCharConstraint: Validates that the characters in a filename meet a defined constraint
apply(String) - Method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Validates that a path meets a defined constraint
apply(String) - Method in interface io.ocfl.core.path.constraint.ContentPathConstraintProcessor: Applies the configured path constrains to the content path and storage path.
apply(String) - Method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor: Applies the configured path constrains to the content path and storage path.
apply(String) - Method in interface io.ocfl.core.path.constraint.PathConstraint: Validates that a path meets a defined constraint
apply(String) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Applies all of the configured constraints on the path.
apply(String) - Method in class io.ocfl.core.path.constraint.PathLengthConstraint: Validates that a path meets a defined constraint
apply(String) - Method in class io.ocfl.core.path.constraint.RegexPathConstraint
apply(String, String) - Method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Validates that a filename meets a defined constraint
apply(String, String) - Method in interface io.ocfl.core.path.constraint.ContentPathConstraintProcessor: Applies the configured path constrains to the content path and storage path.
apply(String, String) - Method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor: Applies the configured path constrains to the content path and storage path.
apply(String, String) - Method in interface io.ocfl.core.path.constraint.FileNameConstraint: Validates that a filename meets a defined constraint
apply(String, String) - Method in class io.ocfl.core.path.constraint.NonEmptyFileNameConstraint: Validates that a filename meets a defined constraint
apply(String, String) - Method in class io.ocfl.core.path.constraint.PathLengthConstraint: Validates that a filename meets a defined constraint
apply(String, String) - Method in class io.ocfl.core.path.constraint.RegexPathConstraint: Validates that a filename meets a defined constraint

B

BackslashPathSeparatorConstraint - Class in io.ocfl.core.path.constraint: Windows only: Rejects filenames that contain backslashes
BackslashPathSeparatorConstraint() - Constructor for class io.ocfl.core.path.constraint.BackslashPathSeparatorConstraint
BaseObjectDetailsDatabase - Class in io.ocfl.core.db
BaseObjectDetailsDatabase(String, DataSource, boolean, long, TimeUnit, String) - Constructor for class io.ocfl.core.db.BaseObjectDetailsDatabase
BeginEndPathConstraint - Class in io.ocfl.core.path.constraint: Validates that a path or filename does or does not begin or and with a specified value
BitSetPathCharConstraint - Class in io.ocfl.core.path.constraint: Constraint that applies restrictions on what characters are allowed in file names.
BitSetPathCharConstraint(boolean, BitSet) - Constructor for class io.ocfl.core.path.constraint.BitSetPathCharConstraint
blockList(char...) - Static method in class io.ocfl.core.path.constraint.BitSetPathCharConstraint: Creates a constraint that rejects the specified characters
blockListRange(char, char) - Static method in class io.ocfl.core.path.constraint.BitSetPathCharConstraint: Creates a constraint that rejects all of the characters in the given range
bucket() - Method in interface io.ocfl.core.storage.cloud.CloudClient: The name of the bucket the OCFL repository is in.
bucketExists() - Method in interface io.ocfl.core.storage.cloud.CloudClient: Returns true if the storage bucket exists
build() - Method in class io.ocfl.core.db.ObjectDetailsDatabaseBuilder: Constructs a new ObjectDetailsDatabase instance using the given dataSource.
build() - Method in class io.ocfl.core.lock.ObjectLockBuilder: Constructs a new ObjectLock.
build() - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
build() - Method in class io.ocfl.core.model.InventoryBuilder
build() - Method in class io.ocfl.core.model.VersionBuilder
build() - Method in class io.ocfl.core.OcflRepositoryBuilder: Constructs an OCFL repository.
build() - Method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor.Builder
build() - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder
build() - Method in class io.ocfl.core.storage.OcflStorageBuilder: Creates a OcflStorage object.
build() - Method in class io.ocfl.core.util.PercentEscaper.Builder
build() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
build(InventoryUpdater, FileLocker, Path, DigestAlgorithm) - Method in class io.ocfl.core.inventory.AddFileProcessor.Builder
build(String, DigestAlgorithm, String) - Method in class io.ocfl.core.storage.cloud.CloudOcflFileRetriever.Builder
buildBlankState(Inventory) - Method in class io.ocfl.core.inventory.InventoryUpdater.Builder: Constructs a new InventoryUpdater that does NOT copy over the state from the previous version.
buildCopyState(Inventory) - Method in class io.ocfl.core.inventory.InventoryUpdater.Builder: Constructs a new InventoryUpdater that copies over the state from the previous version.
buildCopyState(Inventory, VersionNum) - Method in class io.ocfl.core.inventory.InventoryUpdater.Builder: Constructs a new InventoryUpdater that copies over the state from a previous version.
buildCopyStateMutable(Inventory) - Method in class io.ocfl.core.inventory.InventoryUpdater.Builder: Constructs a new InventoryUpdater that copies over the state from the previous version, and creates a mutable HEAD version.
builder() - Static method in class io.ocfl.core.inventory.AddFileProcessor
builder() - Static method in class io.ocfl.core.inventory.InventoryUpdater
builder() - Static method in class io.ocfl.core.model.Inventory
builder() - Static method in class io.ocfl.core.model.Version
builder() - Static method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor: Use this to construct a ContentPathConstraintProcessor
builder() - Static method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Use this to construct a new PathConstraintProcessor
builder() - Static method in class io.ocfl.core.path.ContentPathMapper
builder() - Static method in class io.ocfl.core.storage.cloud.CloudObjectKey
builder() - Static method in class io.ocfl.core.storage.cloud.CloudOcflFileRetriever
builder() - Static method in class io.ocfl.core.storage.DefaultOcflStorage: Create a new builder.
builder() - Static method in class io.ocfl.core.storage.OcflStorageBuilder
builder() - Static method in class io.ocfl.core.util.PercentEscaper: Creates a builder without any safe or unsafe characters set.
builder(Version) - Static method in class io.ocfl.core.model.Version
Builder() - Constructor for class io.ocfl.core.inventory.AddFileProcessor.Builder
Builder() - Constructor for class io.ocfl.core.inventory.InventoryUpdater.Builder
Builder() - Constructor for class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor.Builder
Builder() - Constructor for class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder
Builder() - Constructor for class io.ocfl.core.path.ContentPathMapper.Builder
Builder() - Constructor for class io.ocfl.core.storage.cloud.CloudObjectKey.Builder
Builder() - Constructor for class io.ocfl.core.storage.cloud.CloudOcflFileRetriever.Builder
builderFromStub(String, OcflConfig, String) - Static method in class io.ocfl.core.model.Inventory: Creates an inventory builder with values populated from a stub inventory
builderWithSafeAlphaNumeric() - Static method in class io.ocfl.core.util.PercentEscaper: Creates a builder with safe alpha numeric characters preconfigured.
buildFrom() - Method in class io.ocfl.core.model.Inventory: Creates an inventory builder that copies all of the properties of this inventory.
buildFromKey(String) - Method in class io.ocfl.core.storage.cloud.CloudObjectKey.Builder
buildFromPath(String) - Method in class io.ocfl.core.storage.cloud.CloudObjectKey.Builder
buildMutable() - Method in class io.ocfl.core.OcflRepositoryBuilder: Constructs an OCFL repository that allows the use of the Mutable HEAD Extension.
buildMutableVersion(Inventory) - Method in class io.ocfl.core.path.ContentPathMapper.Builder
buildNewInventory(InventoryUpdater, VersionInfo) - Method in class io.ocfl.core.DefaultOcflRepository
buildNewInventory(OffsetDateTime, VersionInfo) - Method in class io.ocfl.core.inventory.InventoryUpdater: Constructs a new Inventory that contains a new Version based on the changes that were recorded.
buildNextVersionFrom() - Method in class io.ocfl.core.model.Inventory: Same as buildFrom except it moves the current digest to the previous digest and nulls the current digest.
buildStandardVersion(Inventory) - Method in class io.ocfl.core.path.ContentPathMapper.Builder
BYTES - Enum constant in enum class io.ocfl.core.path.constraint.PathLengthConstraint.Type

C

Cache<K,V> - Interface in io.ocfl.core.cache: Extension point that allows the OCFL repository to use any number of different cache implementations so long as they conform to this interface.
CachingOcflStorage - Class in io.ocfl.core.storage: Adds an Inventory caching layer on top of an OcflStorage implementation.
CachingOcflStorage(Cache<String, Inventory>, OcflStorage) - Constructor for class io.ocfl.core.storage.CachingOcflStorage
CaffeineCache<K,V> - Class in io.ocfl.core.cache: In-memory cache implementation that is a wrapper around a Caffeine cache.
CaffeineCache(Cache) - Constructor for class io.ocfl.core.cache.CaffeineCache
call() - Method in interface io.ocfl.core.util.UncheckedCallable
CHARACTERS - Enum constant in enum class io.ocfl.core.path.constraint.PathLengthConstraint.Type
charConstraint(PathCharConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Adds a new character constraint
charConstraints(List<PathCharConstraint>) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Replaces the list of character constraints
checkForEmptyDirs() - Method in class io.ocfl.core.DefaultOcflObjectUpdater: Returns true if the processor deleted a file and thus we need to look for empty directories to delete prior to writing the version.
checkForEmptyDirs() - Method in class io.ocfl.core.inventory.AddFileProcessor: Returns true if the processor deleted a file and thus we need to look for empty directories to delete prior to writing the version.
checkSupport(String) - Method in class io.ocfl.core.extension.ExtensionSupportEvaluator: Checks if an extension is supported by ocfl-java, and returns true if it is.
clearFixity() - Method in class io.ocfl.core.inventory.InventoryUpdater: Removes all entries from the fixity block.
clearFixity() - Method in class io.ocfl.core.model.InventoryBuilder: Removes all of the entries from the fixity block.
clearFixityBlock() - Method in class io.ocfl.core.DefaultOcflObjectUpdater
clearState() - Method in class io.ocfl.core.inventory.InventoryUpdater: Removes all of the files from the version's state.
clearVersionState() - Method in class io.ocfl.core.DefaultOcflObjectUpdater
close() - Method in class io.ocfl.core.DefaultOcflRepository
close() - Method in class io.ocfl.core.storage.AbstractOcflStorage: Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
close() - Method in class io.ocfl.core.storage.CachingOcflStorage: Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
close() - Method in interface io.ocfl.core.storage.cloud.CloudClient: Close any resources the client may have created.
close() - Method in class io.ocfl.core.storage.cloud.CloudStorage: Closes any resources the storage implementation may have open.
close() - Method in class io.ocfl.core.storage.common.OcflObjectRootDirIterator
close() - Method in interface io.ocfl.core.storage.common.Storage: Closes any resources the storage implementation may have open.
close() - Method in class io.ocfl.core.storage.DefaultOcflStorage: Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
close() - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Closes any resources the storage implementation may have open.
close() - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
close() - Method in interface io.ocfl.core.storage.OcflStorage: Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
cloud() - Static method in class io.ocfl.core.path.constraint.ContentPathConstraints: Constructs a ContentPathConstraintProcessor that applies the minimum path constraints across cloud providers (Amazon, Azure, Google).
cloud(CloudClient) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Configure cloud based storage implementation.
cloudClient(CloudClient) - Method in class io.ocfl.core.storage.cloud.CloudOcflFileRetriever.Builder
CloudClient - Interface in io.ocfl.core.storage.cloud: Wrapper interface abstracting cloud provider clients
CloudObjectKey - Class in io.ocfl.core.storage.cloud: Represents a key to an object in cloud storage.
CloudObjectKey.Builder - Class in io.ocfl.core.storage.cloud
CloudOcflFileRetriever - Class in io.ocfl.core.storage.cloud: OcflFileRetriever implementation for lazy-loading files from cloud storage.
CloudOcflFileRetriever(CloudClient, String, DigestAlgorithm, String) - Constructor for class io.ocfl.core.storage.cloud.CloudOcflFileRetriever
CloudOcflFileRetriever.Builder - Class in io.ocfl.core.storage.cloud
CloudOcflObjectRootDirIterator - Class in io.ocfl.core.storage.cloud: Implementation of OcflObjectRootDirIterator that iterates over cloud objects
CloudOcflObjectRootDirIterator(CloudClient) - Constructor for class io.ocfl.core.storage.cloud.CloudOcflObjectRootDirIterator
CloudStorage - Class in io.ocfl.core.storage.cloud: Storage abstraction over cloud storage providers.
CloudStorage(CloudClient) - Constructor for class io.ocfl.core.storage.cloud.CloudStorage
commit(Inventory, OffsetDateTime, VersionInfo, OcflConfig) - Static method in class io.ocfl.core.inventory.MutableHeadInventoryCommitter: Converts a mutable HEAD version into a regular OCFL version.
commitMutableHead(Inventory, Inventory, Path) - Method in class io.ocfl.core.storage.CachingOcflStorage: Moves the mutable HEAD of any object into the object root and into an immutable version.
commitMutableHead(Inventory, Inventory, Path) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Moves the mutable HEAD of any object into the object root and into an immutable version.
commitMutableHead(Inventory, Inventory, Path) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Moves the mutable HEAD of any object into the object root and into an immutable version.
commitMutableHead(Inventory, Inventory, Path) - Method in interface io.ocfl.core.storage.OcflStorage: Moves the mutable HEAD of any object into the object root and into an immutable version.
commitStagedChanges(String, VersionInfo) - Method in class io.ocfl.core.DefaultMutableOcflRepository
compareTo(RevisionNum) - Method in class io.ocfl.core.model.RevisionNum
computeDigest(DigestAlgorithm, ByteBuffer) - Static method in class io.ocfl.core.util.DigestUtil
computeDigest(DigestAlgorithm, Path) - Static method in class io.ocfl.core.util.DigestUtil
computeDigest(MessageDigest, Path) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(DigestAlgorithm, byte[]) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(DigestAlgorithm, byte[], boolean) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(DigestAlgorithm, String) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(DigestAlgorithm, String, boolean) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(DigestAlgorithm, Path) - Static method in class io.ocfl.core.util.DigestUtil
computeDigestHex(MessageDigest, DigestAlgorithm, Path) - Static method in class io.ocfl.core.util.DigestUtil
config() - Method in class io.ocfl.core.DefaultOcflRepository
conservativePercentEncodingMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a percent-encoding that percent-encodes every character except: [a-zA-Z0-9_-].
constraints() - Static method in class io.ocfl.core.path.constraint.LogicalPathConstraints: Logical paths may not: Begin or end with a '/' Contain empty filenames Contain the filenames '.' or '..'
constraintsWithBackslashCheck() - Static method in class io.ocfl.core.path.constraint.LogicalPathConstraints: Logical paths may not: Begin or end with a '/' Contain empty filenames Contain the filenames '.' or '..' Use backslashes as path separators
contains(K) - Method in interface io.ocfl.core.cache.Cache: Returns true if the cache contains the specified key
contains(K) - Method in class io.ocfl.core.cache.CaffeineCache: Returns true if the cache contains the specified key
contains(K) - Method in class io.ocfl.core.cache.NoOpCache
containsContentPath(String) - Method in class io.ocfl.core.model.InventoryBuilder: Indicates if the manifest contains a contentPath
containsFileId(String) - Method in class io.ocfl.core.model.InventoryBuilder: Indicates if the manifest contains a fileId
containsFileId(String) - Method in class io.ocfl.core.model.PathBiMap: Indicates if the specified fileId is in the map
containsFileId(String) - Method in class io.ocfl.core.model.VersionBuilder: Indicates if the state contains the fileId
containsLogicalPath(String) - Method in class io.ocfl.core.model.VersionBuilder: Indicates if the state contains the logicalPath
containsObject(String) - Method in class io.ocfl.core.DefaultOcflRepository
containsObject(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: Returns true if an object with the specified id exists in the repository.
containsObject(String) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns true if an object with the specified id exists in the repository.
containsObject(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Returns true if an object with the specified id exists in the repository.
containsObject(String) - Method in interface io.ocfl.core.storage.OcflStorage: Returns true if an object with the specified id exists in the repository.
containsPath(String) - Method in class io.ocfl.core.model.PathBiMap: Indicates if the specified path is in the map
CONTENT_DIR_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
contentDirectory(String) - Method in class io.ocfl.core.model.InventoryBuilder
contentPath() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
contentPathConstraintProcessor(ContentPathConstraintProcessor) - Method in class io.ocfl.core.path.ContentPathMapper.Builder
contentPathConstraintProcessor(PathConstraintProcessor) - Method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor.Builder: Sets the PathConstraintProcessor to apply to content paths
ContentPathConstraintProcessor - Interface in io.ocfl.core.path.constraint
contentPathConstraints(ContentPathConstraintProcessor) - Method in class io.ocfl.core.OcflRepositoryBuilder: Overrides the default ContentPathConstraintProcessor that is used to enforce restrictions on what constitutes a valid content path.
ContentPathConstraints - Class in io.ocfl.core.path.constraint: This class provides default path constraints that can be applied to OCFL content paths to attempt to ensure portability across various filesystems.
ContentPathMapper - Class in io.ocfl.core.path: This maps logical paths to content paths and applies content path constraints.
ContentPathMapper(LogicalPathMapper, ContentPathConstraintProcessor, String, String, VersionNum, RevisionNum) - Constructor for class io.ocfl.core.path.ContentPathMapper
ContentPathMapper.Builder - Class in io.ocfl.core.path
contentPathMapperBuilder(ContentPathMapper.Builder) - Method in class io.ocfl.core.inventory.InventoryUpdater.Builder
contentRoot() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
copy(InputStream, Path, StandardCopyOption...) - Static method in class io.ocfl.core.util.UncheckedFiles
copy(Path, Path, StandardCopyOption...) - Static method in class io.ocfl.core.util.UncheckedFiles
copyDirectoryOutOf(String, Path) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Recursively copy the source directory from inside this storage system to an external destination.
copyDirectoryOutOf(String, Path) - Method in interface io.ocfl.core.storage.common.Storage: Recursively copy the source directory from inside this storage system to an external destination.
copyDirectoryOutOf(String, Path) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Recursively copy the source directory from inside this storage system to an external destination.
copyFileInternal(String, String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Copy a file from inside this storage system to another destination inside it.
copyFileInternal(String, String) - Method in interface io.ocfl.core.storage.common.Storage: Copy a file from inside this storage system to another destination inside it.
copyFileInternal(String, String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Copy a file from inside this storage system to another destination inside it.
copyFileInto(Path, String, String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Copy a file from outside this storage system to a destination inside.
copyFileInto(Path, String, String) - Method in interface io.ocfl.core.storage.common.Storage: Copy a file from outside this storage system to a destination inside.
copyFileInto(Path, String, String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Copy a file from outside this storage system to a destination inside.
copyFileMakeParents(Path, Path, StandardCopyOption...) - Static method in class io.ocfl.core.util.FileUtil
copyObject(String, String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Copies an object from one location to another within the same bucket.
create(InputStream, Collection<DigestAlgorithm>) - Static method in class io.ocfl.core.util.MultiDigestInputStream: Creates a new MultiDigestInputStream
created(OffsetDateTime) - Method in class io.ocfl.core.model.VersionBuilder
CREATED_KEY - Static variable in class io.ocfl.core.validation.model.SimpleVersion
createDirectories(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Create the specified directory and any missing ancestors.
createDirectories(String) - Method in interface io.ocfl.core.storage.common.Storage: Create the specified directory and any missing ancestors.
createDirectories(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Create the specified directory and any missing ancestors.
createDirectories(Path) - Static method in class io.ocfl.core.util.UncheckedFiles
createDirectory(String) - Method in class io.ocfl.core.storage.cloud.CloudOcflObjectRootDirIterator
createDirectory(String) - Method in class io.ocfl.core.storage.common.OcflObjectRootDirIterator: Creates an object to maintain directory state
createDirectory(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemOcflObjectRootDirIterator
createDirectory(Path) - Static method in class io.ocfl.core.util.UncheckedFiles
createObjectDetailsTable(String) - Method in class io.ocfl.core.db.TableCreator
createObjectLockTable(String) - Method in class io.ocfl.core.db.TableCreator
createObjectTempDir(Path, String) - Static method in class io.ocfl.core.util.FileUtil: Creates a new directory as a child of the parent path named: md5(objectId)-[random-long]
createStagingDir(String) - Method in class io.ocfl.core.DefaultOcflRepository
createStubInventory(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository

D

dataSource(DataSource) - Method in class io.ocfl.core.db.ObjectDetailsDatabaseBuilder: Sets the DataSource to use for the object details table.
dataSource(DataSource) - Method in class io.ocfl.core.lock.ObjectLockBuilder: Sets the DataSource to use for DB based locking.
DbObjectLock - Class in io.ocfl.core.lock: Lock implementation that writes to a DB table to lock a resource.
DbObjectLock(DbType, String, DataSource, Duration) - Constructor for class io.ocfl.core.lock.DbObjectLock
DbType - Enum Class in io.ocfl.core.db: This enum describes the database types that the library supports out of the box.
DefaultContentPathConstraintProcessor - Class in io.ocfl.core.path.constraint: This class enforces constraints on content paths.
DefaultContentPathConstraintProcessor(PathConstraintProcessor, PathConstraintProcessor) - Constructor for class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor: Constructs a new ContentPathConstraintProcessor.
DefaultContentPathConstraintProcessor.Builder - Class in io.ocfl.core.path.constraint: Use this to construct a ContentPathConstraintProcessor
defaultLayoutConfig(OcflExtensionConfig) - Method in class io.ocfl.core.OcflRepositoryBuilder: Sets the default OCFL storage layout configuration.
defaultMapper() - Static method in class io.ocfl.core.inventory.InventoryMapper: Creates an InventoryMapper that creates JSON files with as little whitespace as possible.
defaultMapper() - Static method in class io.ocfl.core.util.ObjectMappers: Default Jackson mapper configured to serialize OCFL model objects correctly.
DefaultMutableOcflRepository - Class in io.ocfl.core: Extends the OCFL repository to support OCFL objects with mutable HEADs as defined by the Mutable HEAD Extension.
DefaultMutableOcflRepository(OcflStorage, Path, ObjectLock, InventoryMapper, LogicalPathMapper, ContentPathConstraintProcessor, OcflConfig, boolean, Duration) - Constructor for class io.ocfl.core.DefaultMutableOcflRepository
DefaultOcflObjectUpdater - Class in io.ocfl.core: Default implementation of OcflObjectUpdater that is used by DefaultOcflRepository to provide write access to an object.
DefaultOcflObjectUpdater(Inventory, InventoryUpdater, Path, AddFileProcessor, FileLocker) - Constructor for class io.ocfl.core.DefaultOcflObjectUpdater
DefaultOcflRepository - Class in io.ocfl.core: Primary implementation of the OcflRepository API.
DefaultOcflRepository(OcflStorage, Path, ObjectLock, InventoryMapper, LogicalPathMapper, ContentPathConstraintProcessor, OcflConfig, boolean, Duration) - Constructor for class io.ocfl.core.DefaultOcflRepository
DefaultOcflStorage - Class in io.ocfl.core.storage: Implements the core logic for manipulating OCFL objects.
DefaultOcflStorage(Storage, boolean, OcflStorageInitializer) - Constructor for class io.ocfl.core.storage.DefaultOcflStorage: Creates a new DefaultOcflStorage object.
DefaultOcflStorageInitializer - Class in io.ocfl.core.storage: Initializes an OCFL repository.
DefaultOcflStorageInitializer(Storage, ObjectMapper) - Constructor for class io.ocfl.core.storage.DefaultOcflStorageInitializer
delete(Path) - Static method in class io.ocfl.core.util.UncheckedFiles
deleteAllDetails() - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Removes all ObjectDetails from the database
deleteAllDetails() - Method in interface io.ocfl.core.db.ObjectDetailsDatabase: Removes all ObjectDetails from the database
deleteAllQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for deleting all object details entries
deleteChildren(Path) - Static method in class io.ocfl.core.util.FileUtil: Recursively deletes all of the children of the specified path.
deleteDetailsQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for deleting object details entries
deleteDirAndParentsIfEmpty(Path) - Static method in class io.ocfl.core.util.FileUtil: Deletes the specified directory and any of its parents that are empty.
deleteDirAndParentsIfEmpty(Path, Path) - Static method in class io.ocfl.core.util.FileUtil: Deletes the specified path and all of its ancestors until the stop directory is reached
deleteDirectory(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Recursively delete the specified directory and all of its children.
deleteDirectory(String) - Method in interface io.ocfl.core.storage.common.Storage: Recursively delete the specified directory and all of its children.
deleteDirectory(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Recursively delete the specified directory and all of its children.
deleteDirectory(Path) - Static method in class io.ocfl.core.util.FileUtil: Recursive delete that deletes everything under and including the specified directory.
deleteDirIfEmpty(Path) - Static method in class io.ocfl.core.util.FileUtil: Attempts to delete the specified directory and ignores failures related to the directory not existing or not empty
deleteEmptyDirs(Path) - Static method in class io.ocfl.core.util.FileUtil: Deletes any empty directories under the specified path
deleteEmptyDirsDown(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Recursively delete all empty directory descendents of the specified directory.
deleteEmptyDirsDown(String) - Method in interface io.ocfl.core.storage.common.Storage: Recursively delete all empty directory descendents of the specified directory.
deleteEmptyDirsDown(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Recursively delete all empty directory descendents of the specified directory.
deleteEmptyDirsUp(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Recursively delete all empty directory ancestors until the first non-empty ancestor is found.
deleteEmptyDirsUp(String) - Method in interface io.ocfl.core.storage.common.Storage: Recursively delete all empty directory ancestors until the first non-empty ancestor is found.
deleteEmptyDirsUp(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Recursively delete all empty directory ancestors until the first non-empty ancestor is found.
deleteFile(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Delete the specified file
deleteFile(String) - Method in interface io.ocfl.core.storage.common.Storage: Delete the specified file
deleteFile(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Delete the specified file
deleteFiles(Collection<String>) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Delete the specified files
deleteFiles(Collection<String>) - Method in interface io.ocfl.core.storage.common.Storage: Delete the specified files
deleteFiles(Collection<String>) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Delete the specified files
deleteIfExists(Path) - Static method in class io.ocfl.core.util.UncheckedFiles
deleteObjectDetails(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Removes ObjectDetails from the database.
deleteObjectDetails(String) - Method in interface io.ocfl.core.db.ObjectDetailsDatabase: Removes ObjectDetails from the database.
deleteObjects(Collection<String>) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Deletes all of the specified objects.
deletePath(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Deletes all of the objects under the specified path
describeObject(String) - Method in class io.ocfl.core.DefaultOcflRepository
describeVersion(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository
DIGEST_ALGO_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
digestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.model.InventoryBuilder
DigestUtil - Class in io.ocfl.core.util
DirectLogicalPathMapper - Class in io.ocfl.core.path.mapper: Directly maps logical paths to content paths without making any changes.
DirectLogicalPathMapper() - Constructor for class io.ocfl.core.path.mapper.DirectLogicalPathMapper
directMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a LogicalPathMapper that directly maps logical paths to content paths, making no changes.
directory(String) - Static method in class io.ocfl.core.storage.common.Listing: Creates a directory listing.
Directory - Enum constant in enum class io.ocfl.core.storage.common.Listing.Type
directoryExists(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Returns true if the specified virtual directory exists.
directoryIsEmpty(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Return true if the specified directory contains no children
directoryIsEmpty(String) - Method in interface io.ocfl.core.storage.common.Storage: Return true if the specified directory contains no children
directoryIsEmpty(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Return true if the specified directory contains no children
DirectoryListing() - Constructor for class io.ocfl.core.storage.cloud.ListResult.DirectoryListing
doInitialize(OcflVersion, OcflExtensionConfig) - Method in class io.ocfl.core.storage.AbstractOcflStorage: Does whatever is necessary to initialize OCFL repository storage.
doInitialize(OcflVersion, OcflExtensionConfig) - Method in class io.ocfl.core.storage.CachingOcflStorage: Does whatever is necessary to initialize OCFL repository storage.
doInitialize(OcflVersion, OcflExtensionConfig) - Method in class io.ocfl.core.storage.DefaultOcflStorage
doInitialize(OcflVersion, OcflExtensionConfig) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Does whatever is necessary to initialize OCFL repository storage.
doInWriteLock(String, Runnable) - Method in class io.ocfl.core.lock.DbObjectLock: Executes the code block after securing a write lock on the objectId.
doInWriteLock(String, Runnable) - Method in class io.ocfl.core.lock.InMemoryObjectLock: Executes the code block after securing a write lock on the objectId.
doInWriteLock(String, Runnable) - Method in interface io.ocfl.core.lock.ObjectLock: Executes the code block after securing a write lock on the objectId.
doInWriteLock(String, Callable<T>) - Method in class io.ocfl.core.lock.DbObjectLock: Executes the code block after securing a write lock on the objectId.
doInWriteLock(String, Callable<T>) - Method in class io.ocfl.core.lock.InMemoryObjectLock: Executes the code block after securing a write lock on the objectId.
doInWriteLock(String, Callable<T>) - Method in interface io.ocfl.core.lock.ObjectLock: Executes the code block after securing a write lock on the objectId.
downloadFile(String, Path) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Downloads an object to the local filesystem.
downloadStream(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Downloads and object and performs a fixity check as it streams to disk.
downloadString(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Downloads an object to a string.

E

enforceObjectVersionForUpdate(ObjectVersionId, Inventory) - Method in class io.ocfl.core.DefaultOcflRepository
ensureContentPath(String) - Method in class io.ocfl.core.model.Inventory: Returns the first contentPath associated to a fileId.
ensureOpen() - Method in class io.ocfl.core.DefaultOcflRepository
ensureOpen() - Method in class io.ocfl.core.storage.AbstractOcflStorage: Throws an exception if the repository has not been initialized or is closed
ensureVersion(VersionNum) - Method in class io.ocfl.core.model.Inventory: Returns the Version that corresponds to the version number.
EQUAL - Enum constant in enum class io.ocfl.core.validation.SimpleInventoryValidator.VersionEquality
equals(Object) - Method in class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
equals(Object) - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
equals(Object) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
equals(Object) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
equals(Object) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
equals(Object) - Method in class io.ocfl.core.model.Inventory
equals(Object) - Method in class io.ocfl.core.model.PathBiMap
equals(Object) - Method in class io.ocfl.core.model.RevisionNum
equals(Object) - Method in class io.ocfl.core.model.User
equals(Object) - Method in class io.ocfl.core.model.Version
equals(Object) - Method in class io.ocfl.core.storage.cloud.CloudObjectKey
equals(Object) - Method in class io.ocfl.core.storage.cloud.HeadResult
equals(Object) - Method in class io.ocfl.core.storage.common.Listing
equals(Object) - Method in class io.ocfl.core.validation.model.SimpleInventory
equals(Object) - Method in class io.ocfl.core.validation.model.SimpleUser
equals(Object) - Method in class io.ocfl.core.validation.model.SimpleVersion
escape(int) - Method in class io.ocfl.core.util.PercentEscaper: Escapes the given Unicode code point in UTF-8.
escape(String) - Method in class io.ocfl.core.util.PercentEscaper
exportObject(String, Path) - Method in class io.ocfl.core.storage.CachingOcflStorage: Copies a raw OCFL object to the specified directory.
exportObject(String, Path) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Copies a raw OCFL object to the specified directory.
exportObject(String, Path) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Copies a raw OCFL object to the specified directory.
exportObject(String, Path) - Method in interface io.ocfl.core.storage.OcflStorage: Copies a raw OCFL object to the specified directory.
exportObject(String, Path, OcflOption...) - Method in class io.ocfl.core.DefaultOcflRepository
exportVersion(ObjectVersionId, Path) - Method in class io.ocfl.core.storage.CachingOcflStorage: Copies a raw OCFL object version to the specified directory.
exportVersion(ObjectVersionId, Path) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Copies a raw OCFL object version to the specified directory.
exportVersion(ObjectVersionId, Path) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Copies a raw OCFL object version to the specified directory.
exportVersion(ObjectVersionId, Path) - Method in interface io.ocfl.core.storage.OcflStorage: Copies a raw OCFL object version to the specified directory.
exportVersion(ObjectVersionId, Path, OcflOption...) - Method in class io.ocfl.core.DefaultOcflRepository
EXTENSION_NAME - Static variable in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension
EXTENSION_NAME - Static variable in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension
EXTENSION_NAME - Static variable in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension
EXTENSION_NAME - Static variable in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension
EXTENSION_NAME - Static variable in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension
extensionsPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path to the extensions directory within an object
extensionsPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to the extensions directory within an object
ExtensionSupportEvaluator - Class in io.ocfl.core.extension: Evaluates if an extension is supported and acts accordingly if it is not.
ExtensionSupportEvaluator() - Constructor for class io.ocfl.core.extension.ExtensionSupportEvaluator
ExtensionSupportEvaluator(UnsupportedExtensionBehavior, Set<String>) - Constructor for class io.ocfl.core.extension.ExtensionSupportEvaluator

F

FAIL - Enum constant in enum class io.ocfl.core.extension.UnsupportedExtensionBehavior: Fails with an exception, refusing to operate on the repository or object
file(String) - Static method in class io.ocfl.core.storage.common.Listing: Creates a file listing.
File - Enum constant in enum class io.ocfl.core.storage.common.Listing.Type
fileChangeHistory(Inventory, String) - Method in class io.ocfl.core.util.ResponseMapper
fileChangeHistory(String, String) - Method in class io.ocfl.core.DefaultOcflRepository
fileContent() - Method in class io.ocfl.core.util.NamasteTypeFile
fileExists(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Indicates if the file exists
fileExists(String) - Method in interface io.ocfl.core.storage.common.Storage: Indicates if the file exists
fileExists(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Indicates if the file exists
FileLocker - Class in io.ocfl.core: Provides locks for logical paths, so that an object may be safely modified by multiple threads.
FileLocker(Duration) - Constructor for class io.ocfl.core.FileLocker
fileLockTimeoutDuration(Duration) - Method in class io.ocfl.core.OcflRepositoryBuilder: Configures the max amount of time to wait for a file lock when updating an object from multiple threads.
fileName() - Method in class io.ocfl.core.util.NamasteTypeFile
fileNameConstraint(FileNameConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Adds a new filename constraint
FileNameConstraint - Interface in io.ocfl.core.path.constraint: Validates that a filename meets a defined constraint
fileNameConstraints(List<FileNameConstraint>) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Replaces the list of filename constraints
fileSystem(Path) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Configure local filesystem based storage implementation.
FileSystemOcflFileRetriever - Class in io.ocfl.core.storage.filesystem: OcflFileRetriever implementation for lazy-loading files from file system storage.
FileSystemOcflFileRetriever(Path, DigestAlgorithm, String) - Constructor for class io.ocfl.core.storage.filesystem.FileSystemOcflFileRetriever
FileSystemOcflObjectRootDirIterator - Class in io.ocfl.core.storage.filesystem: Implementation of OcflObjectRootDirIterator that iterates over the filesystem
FileSystemOcflObjectRootDirIterator(Path) - Constructor for class io.ocfl.core.storage.filesystem.FileSystemOcflObjectRootDirIterator
FileSystemStorage - Class in io.ocfl.core.storage.filesystem: Storage abstraction over the local filesystem
FileSystemStorage(Path) - Constructor for class io.ocfl.core.storage.filesystem.FileSystemStorage
FileUtil - Class in io.ocfl.core.util
findFiles(Path) - Static method in class io.ocfl.core.util.FileUtil
findInventorySidecarPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory sidecar file within the given directory
findMutableHeadRootInventorySidecarPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to the saved sidecar file within the mutable head extension
fixity(Map<DigestAlgorithm, Map<String, Set<String>>>) - Method in class io.ocfl.core.model.InventoryBuilder
FIXITY_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
fixityBiMap(Map<DigestAlgorithm, PathBiMap>) - Method in class io.ocfl.core.model.InventoryBuilder
FlatLayoutConfig - Class in io.ocfl.core.extension.storage.layout.config: Configuration for the Flat Direct Storage Layout extension.
FlatLayoutConfig() - Constructor for class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
FlatLayoutExtension - Class in io.ocfl.core.extension.storage.layout: Implementation of the Flat Storage Layout extension.
FlatLayoutExtension() - Constructor for class io.ocfl.core.extension.storage.layout.FlatLayoutExtension
FlatOmitPrefixLayoutConfig - Class in io.ocfl.core.extension.storage.layout.config: Configuration for the Flat Omit Prefix Storage Layout extension.
FlatOmitPrefixLayoutConfig() - Constructor for class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
FlatOmitPrefixLayoutExtension - Class in io.ocfl.core.extension.storage.layout: Implementation of the Flat Omit Prefix Storage Layout extension.
FlatOmitPrefixLayoutExtension() - Constructor for class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension
fromDataSource(DataSource) - Static method in enum class io.ocfl.core.db.DbType
fromFileIdMap(Map<String, Set<String>>) - Static method in class io.ocfl.core.model.PathBiMap: Constructs a new PathBiMap from an existing map of fileIds to paths.
fromInt(int) - Static method in class io.ocfl.core.model.RevisionNum
fromLogicalPath(String) - Method in class io.ocfl.core.path.ContentPathMapper: Returns a content path for the given logical path after sanitizing it and ensuring that it meets the configured content path constraints.
fromString(String) - Static method in class io.ocfl.core.model.RevisionNum

G

get(K, Function<K, V>) - Method in interface io.ocfl.core.cache.Cache: Retrieves a value from the cache.
get(K, Function<K, V>) - Method in class io.ocfl.core.cache.CaffeineCache: Retrieves a value from the cache.
get(K, Function<K, V>) - Method in class io.ocfl.core.cache.NoOpCache
getAddress() - Method in class io.ocfl.core.model.User
getAddress() - Method in class io.ocfl.core.validation.model.SimpleUser
getContentDirectory() - Method in class io.ocfl.core.model.Inventory: Use resolveContentDirectory() instead
getContentDirectory() - Method in class io.ocfl.core.validation.model.SimpleInventory
getContentEncoding() - Method in class io.ocfl.core.storage.cloud.HeadResult
getContentLength() - Method in class io.ocfl.core.storage.cloud.HeadResult
getContentPath() - Method in class io.ocfl.core.inventory.InventoryUpdater.AddFileResult: The content path of the file
getContentPath() - Method in class io.ocfl.core.inventory.InventoryUpdater.RemoveFileResult
getContentPath(String) - Method in class io.ocfl.core.model.Inventory: Returns the first path to a file that maps to the given digest
getContentPaths(String) - Method in class io.ocfl.core.model.Inventory: Returns the set of paths that are identified by the given digest if they exist.
getContentPaths(String) - Method in class io.ocfl.core.model.InventoryBuilder: Retrieves the content paths associated to the fileId or an empty set
getCreated() - Method in class io.ocfl.core.model.Version
getCreated() - Method in class io.ocfl.core.validation.model.SimpleVersion
getDelimiter() - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
getDelimiter() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
getDescription() - Method in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension
getDescription() - Method in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension
getDescription() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension
getDescription() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension
getDescription() - Method in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension
getDescription() - Method in class io.ocfl.core.extension.storage.layout.OcflLayout
getDescription() - Method in interface io.ocfl.core.extension.storage.layout.OcflStorageLayoutExtension
getDigestAlgorithm() - Method in class io.ocfl.core.db.OcflObjectDetails: The algorithm used to compute the inventory digest
getDigestAlgorithm() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
getDigestAlgorithm() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
getDigestAlgorithm() - Method in class io.ocfl.core.model.Inventory
getDigestAlgorithm() - Method in class io.ocfl.core.storage.common.ObjectProperties
getDigestAlgorithm() - Method in class io.ocfl.core.validation.model.SimpleInventory
getDigestAlgorithmFromSidecar(String) - Static method in class io.ocfl.core.inventory.SidecarMapper
getDigestAlgorithmFromSidecar(Path) - Static method in class io.ocfl.core.inventory.SidecarMapper
getDirectories() - Method in class io.ocfl.core.storage.cloud.ListResult: The directories that were returned by the list operation
getErrors() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
getETag() - Method in class io.ocfl.core.storage.cloud.HeadResult
getExtension() - Method in class io.ocfl.core.extension.storage.layout.OcflLayout
getExtensionConfigClass() - Method in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension
getExtensionConfigClass() - Method in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension
getExtensionConfigClass() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension
getExtensionConfigClass() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension
getExtensionConfigClass() - Method in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension
getExtensionConfigClass() - Method in interface io.ocfl.core.extension.storage.layout.OcflStorageLayoutExtension: The class that represents the extensions deserialized configuration.
getExtensionName() - Method in interface io.ocfl.core.extension.OcflExtension: Returns the name of the extension
getExtensionName() - Method in interface io.ocfl.core.extension.OcflExtensionConfig: Returns the name of the extension the config is for.
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension: Returns the name of the extension
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension: Returns the name of the extension
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension: Returns the name of the extension
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension: Returns the name of the extension
getExtensionName() - Method in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension: Returns the name of the extension
getFileFixity(String, DigestAlgorithm) - Method in class io.ocfl.core.model.InventoryBuilder: Returns the fixity digest for a file or null
getFileId(String) - Method in class io.ocfl.core.model.Inventory: Returns the digest that is used to identify the given path if it exists.
getFileId(String) - Method in class io.ocfl.core.model.InventoryBuilder: Retrieves the fileId associated to the content path
getFileId(String) - Method in class io.ocfl.core.model.PathBiMap: Returns the fileId associated to the path or null
getFileId(String) - Method in class io.ocfl.core.model.Version: Returns the file id associated to the given logical path.
getFileId(String) - Method in class io.ocfl.core.model.VersionBuilder: Retrieves the fileId associated to the logicalPath
getFileId(Path) - Method in class io.ocfl.core.model.Inventory: Returns the digest that is used to identify the given path if it exists.
getFileIdsForMatchingFiles(String) - Method in class io.ocfl.core.model.Inventory: Returns the set of file ids of files that have content paths that begin with the given prefix.
getFileIdsForMatchingFiles(Path) - Method in class io.ocfl.core.model.Inventory: Returns the set of file ids of files that have content paths that begin with the given prefix.
getFileIdToPaths() - Method in class io.ocfl.core.model.PathBiMap: Returns an immutable view of the PathBiMap, mapping fileIds to paths.
getFixity() - Method in class io.ocfl.core.model.Inventory
getFixity() - Method in class io.ocfl.core.validation.model.SimpleInventory
getFixityDigest(String, DigestAlgorithm) - Method in class io.ocfl.core.inventory.InventoryUpdater: Gets the fixity digest for the specified file or null.
getFixityForContentPath(String) - Method in class io.ocfl.core.model.Inventory: Returns the fixity information for a contentPath.
getHead() - Method in class io.ocfl.core.model.Inventory
getHead() - Method in class io.ocfl.core.validation.model.SimpleInventory
getHeadVersion() - Method in class io.ocfl.core.model.Inventory
getId() - Method in class io.ocfl.core.model.Inventory
getId() - Method in class io.ocfl.core.validation.model.SimpleInventory
getInfos() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
getInventory() - Method in class io.ocfl.core.validation.SimpleInventoryParser.ParseSimpleInventoryResult
getInventoryBytes() - Method in class io.ocfl.core.db.OcflObjectDetails: The bytes of the serialized inventory
getInventoryBytes(String, VersionNum) - Method in class io.ocfl.core.storage.CachingOcflStorage: Returns the raw inventory bytes for the specified object version
getInventoryBytes(String, VersionNum) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns the raw inventory bytes for the specified object version
getInventoryBytes(String, VersionNum) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Returns the raw inventory bytes for the specified object version
getInventoryBytes(String, VersionNum) - Method in interface io.ocfl.core.storage.OcflStorage: Returns the raw inventory bytes for the specified object version
getInventoryDigest() - Method in class io.ocfl.core.db.OcflObjectDetails: The digest of the serialized inventory
getInventoryDigest() - Method in class io.ocfl.core.model.Inventory: Returns the digest of this inventory or null if it's not known.
getInvertedManifest() - Method in class io.ocfl.core.validation.model.SimpleInventory
getInvertedManifestCopy() - Method in class io.ocfl.core.validation.model.SimpleInventory
getInvertedState() - Method in class io.ocfl.core.model.VersionBuilder: Returns a map of logical paths to file ids of all of the files in the version's state
getInvertedState() - Method in class io.ocfl.core.validation.model.SimpleVersion
getKey() - Method in class io.ocfl.core.storage.cloud.CloudObjectKey: The composed object key that includes the prefix and the path
getKey() - Method in class io.ocfl.core.storage.cloud.ListResult.ObjectListing: The key the object is stored at.
getKeySuffix() - Method in class io.ocfl.core.storage.cloud.ListResult.ObjectListing: The object's key suffix, the portion of the key that appears after the key prefix the list operation was on
getLastModified() - Method in class io.ocfl.core.storage.cloud.HeadResult
getLogicalPaths(String) - Method in class io.ocfl.core.model.VersionBuilder: Retrieves all of the logical paths associated to the fileId or an empty set
getManifest() - Method in class io.ocfl.core.model.Inventory: A map of all of the files that are part of the object across all versions of the object.
getManifest() - Method in class io.ocfl.core.validation.model.SimpleInventory
getMessage() - Method in class io.ocfl.core.model.Version
getMessage() - Method in class io.ocfl.core.validation.model.SimpleVersion
getName() - Method in class io.ocfl.core.model.User
getName() - Method in class io.ocfl.core.storage.cloud.ListResult.DirectoryListing: Return the virtual name of the directory.
getName() - Method in class io.ocfl.core.validation.model.SimpleUser
getNumberOfTuples() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
getNumberOfTuples() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
getNumberOfTuples() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
getObject(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository
getObject(ObjectVersionId, Path) - Method in class io.ocfl.core.DefaultOcflRepository
getObjectId() - Method in class io.ocfl.core.db.OcflObjectDetails: The OCFL object id
getObjectRootPath() - Method in class io.ocfl.core.db.OcflObjectDetails: The storage relative path to the object's root directory
getObjectRootPath() - Method in class io.ocfl.core.model.Inventory
getObjects() - Method in class io.ocfl.core.storage.cloud.ListResult: The list of objects that were returned by the list operation
getObjectStreams(Inventory, VersionNum) - Method in class io.ocfl.core.storage.CachingOcflStorage: Returns a map of OcflFileRetriever objects that are used to lazy-load object files.
getObjectStreams(Inventory, VersionNum) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns a map of OcflFileRetriever objects that are used to lazy-load object files.
getObjectStreams(Inventory, VersionNum) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Returns a map of OcflFileRetriever objects that are used to lazy-load object files.
getObjectStreams(Inventory, VersionNum) - Method in interface io.ocfl.core.storage.OcflStorage: Returns a map of OcflFileRetriever objects that are used to lazy-load object files.
getOcflVersion() - Method in class io.ocfl.core.storage.common.ObjectProperties
getOcflVersion() - Method in class io.ocfl.core.storage.RepositoryConfig
getPath() - Method in class io.ocfl.core.storage.cloud.CloudObjectKey: The part of the object key that's under the common prefix
getPath() - Method in class io.ocfl.core.storage.cloud.ListResult.DirectoryListing: The object key prefix
getPaths(String) - Method in class io.ocfl.core.model.PathBiMap: Returns all of the paths associated to the fileId, or an empty set.
getPaths(String) - Method in class io.ocfl.core.model.Version: Returns the logical paths associated with the given file id
getPathToFileId() - Method in class io.ocfl.core.model.PathBiMap: Returns an immutable view of the PathBiMap, mapping paths to fileIds
getPathUnderContentDir() - Method in class io.ocfl.core.inventory.InventoryUpdater.AddFileResult: The portion of the content path that's under the content directory
getPathUnderContentDir() - Method in class io.ocfl.core.inventory.InventoryUpdater.RemoveFileResult
getPrefix() - Method in class io.ocfl.core.storage.cloud.CloudObjectKey: The common key prefix for an OCFL repository within a bucket, may be empty
getPreviousDigest() - Method in class io.ocfl.core.model.Inventory: Returns the digest in the previous version's sidecar file or null
getRelativePath() - Method in class io.ocfl.core.storage.common.Listing
getResults() - Method in class io.ocfl.core.util.MultiDigestInputStream: Returns the computed digests.
getRevisionNum() - Method in class io.ocfl.core.db.OcflObjectDetails: The HEAD revision of the object.
getRevisionNum() - Method in class io.ocfl.core.model.Inventory: If there's an active mutable HEAD, its revision number is returned.
getState() - Method in class io.ocfl.core.model.Version: A map of all of the files that are part of this version of the object.
getState() - Method in class io.ocfl.core.validation.model.SimpleVersion
getStorageLayoutExtension() - Method in class io.ocfl.core.storage.RepositoryConfig
getTupleSize() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
getTupleSize() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
getTupleSize() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
getType() - Method in class io.ocfl.core.model.Inventory
getType() - Method in class io.ocfl.core.model.InventoryBuilder
getType() - Method in class io.ocfl.core.storage.common.Listing
getType() - Method in class io.ocfl.core.validation.model.SimpleInventory
getUpdateTimestamp() - Method in class io.ocfl.core.db.OcflObjectDetails: The timestamp the record was last updated
getUser() - Method in class io.ocfl.core.model.Version
getUser() - Method in class io.ocfl.core.validation.model.SimpleVersion
getValidationResults() - Method in class io.ocfl.core.validation.SimpleInventoryParser.ParseSimpleInventoryResult
getVersion(VersionNum) - Method in class io.ocfl.core.model.Inventory
getVersionNum() - Method in class io.ocfl.core.db.OcflObjectDetails: The HEAD version of the object
getVersions() - Method in class io.ocfl.core.model.Inventory: A map of version number to the object that describes the state of the object at that version.
getVersions() - Method in class io.ocfl.core.validation.model.SimpleInventory
getWarnings() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
getZeroPadding() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: return zeroPadding - Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples

H

H2 - Enum constant in enum class io.ocfl.core.db.DbType
H2ObjectDetailsDatabase - Class in io.ocfl.core.db
H2ObjectDetailsDatabase(String, DataSource, boolean, long, TimeUnit) - Constructor for class io.ocfl.core.db.H2ObjectDetailsDatabase
hasChildren(Path) - Static method in class io.ocfl.core.util.FileUtil
hasErrors() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
hasExtensions() - Method in class io.ocfl.core.storage.common.ObjectProperties
hashCode() - Method in class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
hashCode() - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
hashCode() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
hashCode() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
hashCode() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
hashCode() - Method in class io.ocfl.core.model.Inventory
hashCode() - Method in class io.ocfl.core.model.PathBiMap
hashCode() - Method in class io.ocfl.core.model.RevisionNum
hashCode() - Method in class io.ocfl.core.model.User
hashCode() - Method in class io.ocfl.core.model.Version
hashCode() - Method in class io.ocfl.core.storage.cloud.CloudObjectKey
hashCode() - Method in class io.ocfl.core.storage.cloud.HeadResult
hashCode() - Method in class io.ocfl.core.storage.common.Listing
hashCode() - Method in class io.ocfl.core.validation.model.SimpleInventory
hashCode() - Method in class io.ocfl.core.validation.model.SimpleUser
hashCode() - Method in class io.ocfl.core.validation.model.SimpleVersion
HashedNTupleIdEncapsulationLayoutConfig - Class in io.ocfl.core.extension.storage.layout.config: Configuration for the Hashed Truncated N-tuple Trees with Object ID Encapsulating Directory extension.
HashedNTupleIdEncapsulationLayoutConfig() - Constructor for class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig: Creates a new config object with all of the default values set.
HashedNTupleIdEncapsulationLayoutExtension - Class in io.ocfl.core.extension.storage.layout: Implementation of the Hashed Truncated N-tuple Trees with Object ID Encapsulating Directory extension.
HashedNTupleIdEncapsulationLayoutExtension() - Constructor for class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension
HashedNTupleLayoutConfig - Class in io.ocfl.core.extension.storage.layout.config: Configuration for the Hashed N-tuple Storage Layout extension.
HashedNTupleLayoutConfig() - Constructor for class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig: Creates a new config object with all of the default values set.
HashedNTupleLayoutExtension - Class in io.ocfl.core.extension.storage.layout: Implementation of the Hashed N-tuple Storage Layout extension.
HashedNTupleLayoutExtension() - Constructor for class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension
hasInfos() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
hasMutableHead() - Method in class io.ocfl.core.model.Inventory: Indicates if there's an active mutable HEAD
hasMutableHead() - Method in class io.ocfl.core.model.InventoryBuilder
hasNext() - Method in class io.ocfl.core.storage.common.OcflObjectRootDirIterator
hasParameters() - Method in interface io.ocfl.core.extension.OcflExtensionConfig: Indicates if the extension defines parameters.
hasParameters() - Method in class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
hasParameters() - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
hasParameters() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
hasParameters() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
hasParameters() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
hasStagedChanges(String) - Method in class io.ocfl.core.DefaultMutableOcflRepository
hasWarnings() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
head(VersionNum) - Method in class io.ocfl.core.model.InventoryBuilder
head(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Heads the object at the specified path.
HEAD_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
HeadResult - Class in io.ocfl.core.storage.cloud: Encapsulates the results of a head operation
HeadResult() - Constructor for class io.ocfl.core.storage.cloud.HeadResult
headRevisionPath() - Method in class io.ocfl.core.ObjectPaths.ContentRoot
headVersion() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
headVersionPath() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot

I

id(String) - Method in class io.ocfl.core.model.InventoryBuilder
ID_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
ignoreUnsupportedExtensions(Set<String>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Sets a list of unsupported extensions that should be ignored.
importObject(String, Path) - Method in class io.ocfl.core.storage.CachingOcflStorage: Moves an entire OCFL object into the repository.
importObject(String, Path) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Moves an entire OCFL object into the repository.
importObject(String, Path) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Moves an entire OCFL object into the repository.
importObject(String, Path) - Method in interface io.ocfl.core.storage.OcflStorage: Moves an entire OCFL object into the repository.
importObject(Path, OcflOption...) - Method in class io.ocfl.core.DefaultOcflRepository
importVersion(Path, OcflOption...) - Method in class io.ocfl.core.DefaultOcflRepository
init(OcflExtensionConfig) - Method in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension: Configures the extension.
init(OcflExtensionConfig) - Method in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension: Configures the extension.
init(OcflExtensionConfig) - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension: Configures the extension.
init(OcflExtensionConfig) - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension: Configures the extension.
init(OcflExtensionConfig) - Method in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension: Configures the extension.
init(OcflExtensionConfig) - Method in interface io.ocfl.core.extension.storage.layout.OcflStorageLayoutExtension: Configures the extension.
initializer(OcflStorageInitializer) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Overrides the default OcflStorageInitializer.
initializeStorage(OcflVersion, OcflExtensionConfig, ExtensionSupportEvaluator) - Method in class io.ocfl.core.storage.DefaultOcflStorageInitializer: Initializes a new OCFL storage root when the storage root does not already exist.
initializeStorage(OcflVersion, OcflExtensionConfig, ExtensionSupportEvaluator) - Method in interface io.ocfl.core.storage.OcflStorageInitializer: Initializes a new OCFL storage root when the storage root does not already exist.
initializeStorage(OcflVersion, OcflExtensionConfig, InventoryMapper, ExtensionSupportEvaluator) - Method in class io.ocfl.core.storage.AbstractOcflStorage: Initializes the OCFL root.
initializeStorage(OcflVersion, OcflExtensionConfig, InventoryMapper, ExtensionSupportEvaluator) - Method in interface io.ocfl.core.storage.OcflStorage: Initializes the OCFL root.
InMemoryObjectLock - Class in io.ocfl.core.lock: In-memory implementation of ObjectLock that uses Java's ReentrantReadWriteLock.
InMemoryObjectLock(long, TimeUnit) - Constructor for class io.ocfl.core.lock.InMemoryObjectLock: How long to wait when attempting to acquire a lock.
innerContentPath(String) - Method in class io.ocfl.core.inventory.InventoryUpdater: Maps the logical path to a content path and returns the part of the content path that's under the content directory.
insertDetailsQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for inserting object details entries
invalidate(K) - Method in interface io.ocfl.core.cache.Cache: Invalidates the key in the cache.
invalidate(K) - Method in class io.ocfl.core.cache.CaffeineCache: Invalidates the key in the cache.
invalidate(K) - Method in class io.ocfl.core.cache.NoOpCache
invalidateAll() - Method in interface io.ocfl.core.cache.Cache: Invalidates the entire cache
invalidateAll() - Method in class io.ocfl.core.cache.CaffeineCache: Invalidates the entire cache
invalidateAll() - Method in class io.ocfl.core.cache.NoOpCache
invalidateCache() - Method in class io.ocfl.core.DefaultOcflRepository
invalidateCache() - Method in class io.ocfl.core.storage.AbstractOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache.
invalidateCache() - Method in class io.ocfl.core.storage.CachingOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache.
invalidateCache() - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache.
invalidateCache() - Method in interface io.ocfl.core.storage.OcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache.
invalidateCache(String) - Method in class io.ocfl.core.DefaultOcflRepository
invalidateCache(String) - Method in class io.ocfl.core.storage.AbstractOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object.
invalidateCache(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object.
invalidateCache(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object.
invalidateCache(String) - Method in interface io.ocfl.core.storage.OcflStorage: If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object.
Inventory - Class in io.ocfl.core.model: OCFL inventory object.
Inventory(String, InventoryType, DigestAlgorithm, VersionNum, String, Map<DigestAlgorithm, Map<String, Set<String>>>, Map<String, Set<String>>, Map<VersionNum, Version>, boolean, RevisionNum, String, String, String) - Constructor for class io.ocfl.core.model.Inventory
Inventory.JacksonBuilder - Class in io.ocfl.core.model: This builder is only intended to be used by Jackson for deserializing inventory files.
InventoryBuilder - Class in io.ocfl.core.model: Used to construct Inventory objects.
InventoryBuilder() - Constructor for class io.ocfl.core.model.InventoryBuilder
InventoryBuilder(Inventory) - Constructor for class io.ocfl.core.model.InventoryBuilder: Used to construct a new Inventory that's based on an existing inventory.
inventoryCache(Cache<String, Inventory>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Used to cache deserialized inventories.
inventoryDigest(String) - Method in class io.ocfl.core.model.InventoryBuilder
inventoryFile() - Method in interface io.ocfl.core.ObjectPaths.HasInventory
inventoryFile() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
inventoryFile() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
inventoryMapper - Variable in class io.ocfl.core.storage.AbstractOcflStorage
inventoryMapper(InventoryMapper) - Method in class io.ocfl.core.OcflRepositoryBuilder: Used to override the default InventoryMapper, which is used to serialize Inventories to JSON files.
InventoryMapper - Class in io.ocfl.core.inventory: Wrapper around Jackson's ObjectMapper for serializing and deserializing Inventories.
InventoryMapper(ObjectMapper) - Constructor for class io.ocfl.core.inventory.InventoryMapper: Should use InventoryMapper.defaultMapper() or InventoryMapper.prettyPrintMapper() unless you know what you're doing.
inventoryPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory file within the given directory
inventoryPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory file within the given directory
inventorySidecar() - Method in interface io.ocfl.core.ObjectPaths.HasInventory
inventorySidecar() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
inventorySidecar() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
inventorySidecarPath(String, Inventory) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory sidecar file within the given directory
inventorySidecarPath(Path, Inventory) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory sidecar file within the given directory
InventoryUpdater - Class in io.ocfl.core.inventory: This class is used to record changes to OCFL objects and construct an updated inventory.
InventoryUpdater.AddFileResult - Class in io.ocfl.core.inventory: Indicates the result of an add file operation.
InventoryUpdater.Builder - Class in io.ocfl.core.inventory
InventoryUpdater.RemoveFileResult - Class in io.ocfl.core.inventory: Indicates that a file was removed from the manifest.
inventoryUpdaterBuilder - Variable in class io.ocfl.core.DefaultOcflRepository
InventoryValidator - Class in io.ocfl.core.validation: Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory.
io.ocfl.core - package io.ocfl.core
io.ocfl.core.cache - package io.ocfl.core.cache
io.ocfl.core.db - package io.ocfl.core.db
io.ocfl.core.extension - package io.ocfl.core.extension
io.ocfl.core.extension.storage.layout - package io.ocfl.core.extension.storage.layout
io.ocfl.core.extension.storage.layout.config - package io.ocfl.core.extension.storage.layout.config
io.ocfl.core.inventory - package io.ocfl.core.inventory
io.ocfl.core.lock - package io.ocfl.core.lock
io.ocfl.core.model - package io.ocfl.core.model
io.ocfl.core.path - package io.ocfl.core.path
io.ocfl.core.path.constraint - package io.ocfl.core.path.constraint
io.ocfl.core.path.mapper - package io.ocfl.core.path.mapper
io.ocfl.core.storage - package io.ocfl.core.storage
io.ocfl.core.storage.cloud - package io.ocfl.core.storage.cloud
io.ocfl.core.storage.common - package io.ocfl.core.storage.common
io.ocfl.core.storage.filesystem - package io.ocfl.core.storage.filesystem
io.ocfl.core.util - package io.ocfl.core.util
io.ocfl.core.validation - package io.ocfl.core.validation
io.ocfl.core.validation.model - package io.ocfl.core.validation.model
isConcurrentWriteException(SQLException) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Checks if given exception was thrown because of concurrent write issue or something else.
isConcurrentWriteException(SQLException) - Method in class io.ocfl.core.db.H2ObjectDetailsDatabase: Checks if given exception was thrown because of concurrent write issue or something else.
isConcurrentWriteException(SQLException) - Method in class io.ocfl.core.db.MariaDbObjectDetailsDatabase: Checks if given exception was thrown because of concurrent write issue or something else.
isConcurrentWriteException(SQLException) - Method in class io.ocfl.core.db.PostgresObjectDetailsDatabase: Checks if given exception was thrown because of concurrent write issue or something else.
isDirectory() - Method in class io.ocfl.core.storage.common.Listing
isDirEmpty(Path) - Static method in class io.ocfl.core.util.FileUtil
isFile() - Method in class io.ocfl.core.storage.common.Listing
isNew() - Method in class io.ocfl.core.inventory.InventoryUpdater.AddFileResult
isObjectRoot(String) - Method in class io.ocfl.core.storage.cloud.CloudOcflObjectRootDirIterator
isObjectRoot(String) - Method in class io.ocfl.core.storage.common.OcflObjectRootDirIterator: Indicates if a directory path is an object root path
isObjectRoot(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemOcflObjectRootDirIterator
isOther() - Method in class io.ocfl.core.storage.common.Listing
isReverseObjectRoot() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: return true or false, indicates that the prefix-omitted, padded object identifier should be reversed
isRevisionNum(String) - Static method in class io.ocfl.core.model.RevisionNum
isShortObjectRoot() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
isSupported(String) - Static method in class io.ocfl.core.extension.OcflExtensionRegistry: Returns true if there is a known implementation of the given extension name
iterateObjects() - Method in class io.ocfl.core.storage.cloud.CloudStorage: Return an iterator that iterates over every OCFL object directory in the repository.
iterateObjects() - Method in interface io.ocfl.core.storage.common.Storage: Return an iterator that iterates over every OCFL object directory in the repository.
iterateObjects() - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Return an iterator that iterates over every OCFL object directory in the repository.

J

JacksonBuilder() - Constructor for class io.ocfl.core.model.Inventory.JacksonBuilder

K

KeyNotFoundException - Exception Class in io.ocfl.core.storage.cloud: This exception is thrown when a cloud storage provider cannot find the specified key.
KeyNotFoundException() - Constructor for exception class io.ocfl.core.storage.cloud.KeyNotFoundException
KeyNotFoundException(String) - Constructor for exception class io.ocfl.core.storage.cloud.KeyNotFoundException
KeyNotFoundException(String, Throwable) - Constructor for exception class io.ocfl.core.storage.cloud.KeyNotFoundException
KeyNotFoundException(Throwable) - Constructor for exception class io.ocfl.core.storage.cloud.KeyNotFoundException

L

LEFT - Enum constant in enum class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig.ZeroPadding
LESS_THAN_OR_EQUAL - Enum constant in enum class io.ocfl.core.validation.SimpleInventoryValidator.VersionEquality
list(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Lists all of the keys under a prefix.
listDirectory(String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Lists all of the keys within a virtual directory.
listDirectory(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Return a list of all files and directories contained in the specified directory.
listDirectory(String) - Method in interface io.ocfl.core.storage.common.Storage: Return a list of all files and directories contained in the specified directory.
listDirectory(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Return a list of all files and directories contained in the specified directory.
Listing - Class in io.ocfl.core.storage.common: The result of a storage list operation
Listing(Listing.Type, String) - Constructor for class io.ocfl.core.storage.common.Listing
Listing.Type - Enum Class in io.ocfl.core.storage.common
listObjectIds() - Method in class io.ocfl.core.DefaultOcflRepository
listObjectIds() - Method in class io.ocfl.core.storage.CachingOcflStorage: Returns a stream of object ids for all of the OCFL objects stored in a repository.
listObjectIds() - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns a stream of object ids for all of the OCFL objects stored in a repository.
listObjectIds() - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Returns a stream of object ids for all of the OCFL objects stored in a repository.
listObjectIds() - Method in interface io.ocfl.core.storage.OcflStorage: Returns a stream of object ids for all of the OCFL objects stored in a repository.
listRecursive(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Return a list of all leaf-node descendents of the specified directory, this includes empty leaf-node directories.
listRecursive(String) - Method in interface io.ocfl.core.storage.common.Storage: Return a list of all leaf-node descendents of the specified directory, this includes empty leaf-node directories.
listRecursive(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Return a list of all leaf-node descendents of the specified directory, this includes empty leaf-node directories.
ListResult - Class in io.ocfl.core.storage.cloud: Encapsulates the results of a list operation
ListResult() - Constructor for class io.ocfl.core.storage.cloud.ListResult
ListResult.DirectoryListing - Class in io.ocfl.core.storage.cloud: Encapsulates a virtual directory.
ListResult.ObjectListing - Class in io.ocfl.core.storage.cloud: Encapsulates an object key and its suffix.
loadInventory(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository
loadInventory(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: If the inventory is cached, it's returned immediately.
loadInventory(String) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns a verified copy of the most recent object inventory.
loadInventory(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: If the object is stored in the database with its inventory, then the inventory is loaded from there.
loadInventory(String) - Method in interface io.ocfl.core.storage.OcflStorage: Returns a verified copy of the most recent object inventory.
lock(String) - Method in class io.ocfl.core.FileLocker: Returns a lock on the specified logical path or throws a LockException if a lock was unable to be acquired.
LogicalPathConstraints - Class in io.ocfl.core.path.constraint: Describes the constraints that are applied to logical paths.
logicalPathMapper(LogicalPathMapper) - Method in class io.ocfl.core.OcflRepositoryBuilder: Overrides the default DirectLogicalPathMapper.
logicalPathMapper(LogicalPathMapper) - Method in class io.ocfl.core.path.ContentPathMapper.Builder
LogicalPathMapper - Interface in io.ocfl.core.path.mapper: Maps logical paths to content paths.
LogicalPathMappers - Class in io.ocfl.core.path.mapper: This class defines common LogicalPathMapper implementations.
logsPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path to the logs directory within an object
logsPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to the logs directory within an object
lookup(String) - Static method in class io.ocfl.core.extension.OcflExtensionRegistry: Returns a registered extension implementation, if one exists.

M

manifest(PathBiMap) - Method in class io.ocfl.core.model.InventoryBuilder
manifest(Map<String, Set<String>>) - Method in class io.ocfl.core.model.InventoryBuilder
MANIFEST_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory
manifestContainsFileId(String) - Method in class io.ocfl.core.model.Inventory: Helper method for checking if an object contains a file with the given digest id.
mapInventory(Inventory) - Method in class io.ocfl.core.util.ResponseMapper
mapObjectId(String) - Method in class io.ocfl.core.extension.storage.layout.FlatLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapObjectId(String) - Method in class io.ocfl.core.extension.storage.layout.FlatOmitPrefixLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapObjectId(String) - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleIdEncapsulationLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapObjectId(String) - Method in class io.ocfl.core.extension.storage.layout.HashedNTupleLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapObjectId(String) - Method in class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapObjectId(String) - Method in interface io.ocfl.core.extension.storage.layout.OcflStorageLayoutExtension: Maps an object id to its path within the OCFL storage root.
mapVersion(Inventory, VersionNum, Version) - Method in class io.ocfl.core.util.ResponseMapper
MARIADB - Enum constant in enum class io.ocfl.core.db.DbType
MariaDbObjectDetailsDatabase - Class in io.ocfl.core.db
MariaDbObjectDetailsDatabase(String, DataSource, boolean, long, TimeUnit) - Constructor for class io.ocfl.core.db.MariaDbObjectDetailsDatabase
maxBytes(int) - Static method in class io.ocfl.core.path.constraint.PathLengthConstraint: Creates a new constraint that limits the number of bytes in a path
maxChars(int) - Static method in class io.ocfl.core.path.constraint.PathLengthConstraint: Creates a new constraint that limits the number of characters in a path
maxLockDuration(Duration) - Method in class io.ocfl.core.lock.ObjectLockBuilder: Sets the maximum amount of time a lock may be held for before it's able to be acquired by another process.
message(String) - Method in class io.ocfl.core.model.VersionBuilder
MESSAGE_KEY - Static variable in class io.ocfl.core.validation.model.SimpleVersion
minimal() - Static method in class io.ocfl.core.path.constraint.ContentPathConstraints: Constructs a ContentPathConstraintProcessor that does the minimal content path validations as required by the OCFL spec.
moveDirectory(Path, Path) - Static method in class io.ocfl.core.util.FileUtil: Performs an atomic directory move.
moveDirectoryInternal(String, String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Move a directory from inside this storage system to another location inside.
moveDirectoryInternal(String, String) - Method in interface io.ocfl.core.storage.common.Storage: Move a directory from inside this storage system to another location inside.
moveDirectoryInternal(String, String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Move a directory from inside this storage system to another location inside.
moveDirectoryInto(Path, String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Move a directory from outside this storage system to a destination inside.
moveDirectoryInto(Path, String) - Method in interface io.ocfl.core.storage.common.Storage: Move a directory from outside this storage system to a destination inside.
moveDirectoryInto(Path, String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Move a directory from outside this storage system to a destination inside.
moveFileMakeParents(Path, Path, StandardCopyOption...) - Static method in class io.ocfl.core.util.FileUtil
MultiDigestInputStream - Class in io.ocfl.core.util: Input stream that is able to calculate multiple digests concurrently
mustBeginWith(String) - Static method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Creates a new constraint that validates that a path DOES begin with a specified prefix
mustContain(Pattern) - Static method in class io.ocfl.core.path.constraint.RegexPathConstraint: Creates a new constraint that validates paths do match the regex
mustEndWith(String) - Static method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Creates a new constraint that validates that a path DOES end with a specified suffix
mustNotBeginWith(String) - Static method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Creates a new constraint that validates that a path DOES NOT begin with a specified prefix
mustNotContain(Pattern) - Static method in class io.ocfl.core.path.constraint.RegexPathConstraint: Creates a new constraint that validates paths do not match the regex
mustNotEndWith(String) - Static method in class io.ocfl.core.path.constraint.BeginEndPathConstraint: Creates a new constraint that validates that a path DOES NOT end with a specified suffix
mutableHead(boolean) - Method in class io.ocfl.core.model.InventoryBuilder
mutableHeadExtensionPath() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
mutableHeadExtensionRoot(String) - Static method in class io.ocfl.core.ObjectPaths: Path to the mutable HEAD extension root directory
mutableHeadExtensionRoot(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to the mutable HEAD extension root directory
MutableHeadInventoryCommitter - Class in io.ocfl.core.inventory: Converts a mutable HEAD version into a regular OCFL version.
mutableHeadInventoryPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory file within the mutable HEAD
mutableHeadInventoryPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory file within the mutable HEAD
mutableHeadInventorySidecarPath(String, Inventory) - Static method in class io.ocfl.core.ObjectPaths: Path to an inventory sidecar file within the given directory
mutableHeadPath() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
mutableHeadRevisionsPath() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
mutableHeadRevisionsPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path the revisions directory under the mutable HEAD extension directory
mutableHeadRevisionsPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path the revisions directory under the mutable HEAD extension directory
mutableHeadVersion() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
mutableHeadVersionPath(String) - Static method in class io.ocfl.core.ObjectPaths: Path to the mutable HEAD extension version directory
mutableHeadVersionPath(Path) - Static method in class io.ocfl.core.ObjectPaths: Path to the mutable HEAD extension version directory

N

NamasteTypeFile - Class in io.ocfl.core.util
NamasteTypeFile(String) - Constructor for class io.ocfl.core.util.NamasteTypeFile
NAME_KEY - Static variable in class io.ocfl.core.validation.model.SimpleUser
next() - Method in class io.ocfl.core.storage.common.OcflObjectRootDirIterator
nextChildDirectory() - Method in interface io.ocfl.core.storage.common.OcflObjectRootDirIterator.Directory: Returns the path to the directory's next child relative the storage root.
nextEscapeIndex(CharSequence, int, int) - Method in class io.ocfl.core.util.PercentEscaper
nextRevisionNum() - Method in class io.ocfl.core.model.Inventory: Returns the next revision number.
nextRevisionNum() - Method in class io.ocfl.core.model.RevisionNum
nextVersionNum() - Method in class io.ocfl.core.model.Inventory: Returns the next version number after the current HEAD version.
NonEmptyFileNameConstraint - Class in io.ocfl.core.path.constraint: Validates that there are no empty filenames
NonEmptyFileNameConstraint() - Constructor for class io.ocfl.core.path.constraint.NonEmptyFileNameConstraint
NoOpCache<K,V> - Class in io.ocfl.core.cache: Pass-through cache implementation that never caches.
NoOpCache() - Constructor for class io.ocfl.core.cache.NoOpCache
now(VersionInfo) - Method in class io.ocfl.core.DefaultOcflRepository
NTupleOmitPrefixStorageLayoutConfig - Class in io.ocfl.core.extension.storage.layout.config: Configuration for the N Tuple Storage Layout extension.
NTupleOmitPrefixStorageLayoutConfig() - Constructor for class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
NTupleOmitPrefixStorageLayoutConfig.ZeroPadding - Enum Class in io.ocfl.core.extension.storage.layout.config
NTupleOmitPrefixStorageLayoutExtension - Class in io.ocfl.core.extension.storage.layout: Implementation of the N Tuple Storage Layout extension.
NTupleOmitPrefixStorageLayoutExtension() - Constructor for class io.ocfl.core.extension.storage.layout.NTupleOmitPrefixStorageLayoutExtension

O

ObjectDetailsDatabase - Interface in io.ocfl.core.db: Interface for interacting with OCFL object details that are stored in a database.
ObjectDetailsDatabaseBuilder - Class in io.ocfl.core.db: Constructs ObjectDetailsDatabase instances
ObjectDetailsDatabaseBuilder() - Constructor for class io.ocfl.core.db.ObjectDetailsDatabaseBuilder
objectDetailsDb(ObjectDetailsDatabase) - Method in class io.ocfl.core.OcflRepositoryBuilder: Used to store details about OCFL objects in the repository.
objectDetailsDb(Consumer<ObjectDetailsDatabaseBuilder>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Used to store details about OCFL objects in the repository.
ObjectDetailsDbOcflStorage - Class in io.ocfl.core.storage
ObjectDetailsDbOcflStorage(ObjectDetailsDatabase, OcflStorage) - Constructor for class io.ocfl.core.storage.ObjectDetailsDbOcflStorage
objectId() - Method in class io.ocfl.core.ObjectPaths.ContentRoot
objectId() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
objectId() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
ObjectListing() - Constructor for class io.ocfl.core.storage.cloud.ListResult.ObjectListing
objectLock(ObjectLock) - Method in class io.ocfl.core.OcflRepositoryBuilder: Used to lock objects when writing.
objectLock(Consumer<ObjectLockBuilder>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Configures the object lock that's used.
ObjectLock - Interface in io.ocfl.core.lock: Extension point that allows the OCFL repository to use any number of different lock implementations so long as they conform to this interface.
ObjectLockBuilder - Class in io.ocfl.core.lock: Constructs new ObjectLock instances
ObjectLockBuilder() - Constructor for class io.ocfl.core.lock.ObjectLockBuilder
objectMapper(ObjectMapper) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Overrides the default ObjectMapper that's used to serialize ocfl_layout.json
ObjectMappers - Class in io.ocfl.core.util
ObjectPaths - Class in io.ocfl.core: Centralizes common OCFL path locations
ObjectPaths.ContentRoot - Class in io.ocfl.core: Provides methods for navigating a version's content directory
ObjectPaths.HasInventory - Interface in io.ocfl.core
ObjectPaths.ObjectRoot - Class in io.ocfl.core: Provides methods for navigating an OCFL object root
ObjectPaths.VersionRoot - Class in io.ocfl.core: Provides methods for navigating an OCFL object version directory
ObjectProperties - Class in io.ocfl.core.storage.common
ObjectProperties() - Constructor for class io.ocfl.core.storage.common.ObjectProperties
ObjectProperties(OcflVersion, DigestAlgorithm, boolean) - Constructor for class io.ocfl.core.storage.common.ObjectProperties
objectRoot(Inventory) - Static method in class io.ocfl.core.ObjectPaths: Creates a new ObjectRoot object
objectRootPath(String) - Method in class io.ocfl.core.model.InventoryBuilder
objectRootPath(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: Returns the path from the storage root to the object root.
objectRootPath(String) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Returns the path from the storage root to the object root.
objectRootPath(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Returns the path from the storage root to the object root.
objectRootPath(String) - Method in interface io.ocfl.core.storage.OcflStorage: Returns the path from the storage root to the object root.
ocflConfig(OcflConfig) - Method in class io.ocfl.core.OcflRepositoryBuilder: Sets OCFL configuration options.
ocflConfig(Consumer<OcflConfig>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Sets OCFL configuration options.
OcflExtension - Interface in io.ocfl.core.extension: Marker interface for an OCFL extension implementation
OcflExtensionConfig - Interface in io.ocfl.core.extension: Represents deserialized extension configuration.
OcflExtensionRegistry - Class in io.ocfl.core.extension: Registry for mapping extensions to their implementations.
OcflLayout - Class in io.ocfl.core.extension.storage.layout: This class is a representation of the ocfl_layout.json file.
OcflLayout() - Constructor for class io.ocfl.core.extension.storage.layout.OcflLayout
OcflObjectDetails - Class in io.ocfl.core.db: Represents a ObjectDetails database record.
OcflObjectDetails() - Constructor for class io.ocfl.core.db.OcflObjectDetails
OcflObjectRootDirIterator - Class in io.ocfl.core.storage.common: Iterator that iterates over OCFL object root directories.
OcflObjectRootDirIterator() - Constructor for class io.ocfl.core.storage.common.OcflObjectRootDirIterator
OcflObjectRootDirIterator.Directory - Interface in io.ocfl.core.storage.common: Encapsulates a directory for iterating over its children
OcflRepositoryBuilder - Class in io.ocfl.core: Constructs a local file system based OCFL repository sensible defaults that can be overridden prior to calling OcflRepositoryBuilder.build().
OcflRepositoryBuilder() - Constructor for class io.ocfl.core.OcflRepositoryBuilder: Constructs a local file system based OCFL repository sensible defaults that can be overridden prior to calling OcflRepositoryBuilder.build().
OcflStorage - Interface in io.ocfl.core.storage: Extension point that allows the OCFL repository to use any number of storage implementations so long as they conform to this interface.
OcflStorageBuilder - Class in io.ocfl.core.storage: Builder for constructing OcflStorage objects.
OcflStorageBuilder() - Constructor for class io.ocfl.core.storage.OcflStorageBuilder
OcflStorageInitializer - Interface in io.ocfl.core.storage: Initializes an OCFL repository by either creating a new repository root or reading the configuration from an existing repository.
OcflStorageLayoutExtension - Interface in io.ocfl.core.extension.storage.layout: Interface for OCFL storage layout extensions.
other(String) - Static method in class io.ocfl.core.storage.common.Listing: Creates a listing for a file that is neither a regular file nor directory, such as a symbolic link.
Other - Enum constant in enum class io.ocfl.core.storage.common.Listing.Type

P

parentPath(String) - Static method in class io.ocfl.core.util.FileUtil: Returns the path to the parent of the specified path, using forward slashes as path separators.
parse(InputStream, String) - Method in class io.ocfl.core.validation.SimpleInventoryParser: Parses the input stream JSON into a minimally valid SimpleInventory object.
ParseSimpleInventoryResult(SimpleInventory, ValidationResults) - Constructor for class io.ocfl.core.validation.SimpleInventoryParser.ParseSimpleInventoryResult
path() - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
path() - Method in class io.ocfl.core.ObjectPaths.VersionRoot
PathBiMap - Class in io.ocfl.core.model: BiDirection map implementation that focuses on OCFL structures.
PathBiMap() - Constructor for class io.ocfl.core.model.PathBiMap
PathCharConstraint - Interface in io.ocfl.core.path.constraint: Validates that the characters in a filename meet a defined constraint
pathConstraint(PathConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Adds a new path constraint
PathConstraint - Interface in io.ocfl.core.path.constraint: Validates that a path meets a defined constraint
PathConstraintProcessor - Class in io.ocfl.core.path.constraint: A PathConstraintProcessor is used to apply a preconfigured set of constraints to a given path.
PathConstraintProcessor(List<PathConstraint>, List<FileNameConstraint>, List<PathCharConstraint>) - Constructor for class io.ocfl.core.path.constraint.PathConstraintProcessor: Constructs a new PathConstraintProcessor.
PathConstraintProcessor.Builder - Class in io.ocfl.core.path.constraint: Use this to construct a new PathConstraintProcessor
pathConstraints(List<PathConstraint>) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor.Builder: Replaces the list of path constraints
pathJoinFailEmpty(String...) - Static method in class io.ocfl.core.util.FileUtil: Joins all of the parts together as a path separated by '/'.
pathJoinIgnoreEmpty(String...) - Static method in class io.ocfl.core.util.FileUtil: Joins all of the parts together as a path separated by '/'.
PathLengthConstraint - Class in io.ocfl.core.path.constraint: Validates that a path or filename are not longer than a fixed number of characters or bytes
PathLengthConstraint(int, PathLengthConstraint.Type) - Constructor for class io.ocfl.core.path.constraint.PathLengthConstraint
PathLengthConstraint.Type - Enum Class in io.ocfl.core.path.constraint
pathToStringStandardSeparator(Path) - Static method in class io.ocfl.core.util.FileUtil: Returns a string representation of a Path that uses '/' as the file separator.
percentEncodingAllMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a percent-encoding that encodes the following characters that are generally problematic across Windows, linux, and cloud platforms: ASCII characters codes: x0-x1f ASCII characters codes: x7f-xa0 Characters: <>:"\|?* #[]
percentEncodingCloudMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a percent-encoding that encodes the following characters that are problematic for some cloud storage platforms: ASCII characters codes: x0-x1f ASCII characters codes: x7f-xa0 Characters: \#[]*?
percentEncodingLinuxMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a percent-encoding that encodes the following characters: ASCII characters codes: x0-x1f ASCII characters codes: x7f-xa0 Characters:
PercentEncodingLogicalPathMapper - Class in io.ocfl.core.path.mapper: A LogicalPathMapper that percent-encodes specific characters in logical paths to produce safe content paths.
PercentEncodingLogicalPathMapper(PercentEscaper) - Constructor for class io.ocfl.core.path.mapper.PercentEncodingLogicalPathMapper: Constructs a new PercentEncodingLogicalPathMapper.
percentEncodingWindowsMapper() - Static method in class io.ocfl.core.path.mapper.LogicalPathMappers: Creates a percent-encoding mapper that encodes the following characters that are problematic for Windows: ASCII characters codes: x0-x1f ASCII characters codes: x7f-xa0 Characters: <>:"\|?*
PercentEscaper - Class in io.ocfl.core.util: NOTICE: This class is copied from Guava 28.2-jre and modified to support lowercase hex encoding and either encoding all characters not in a given set or encoding only the characters in a given set by Peter Winckles.
PercentEscaper.Builder - Class in io.ocfl.core.util
plusForSpace(boolean) - Method in class io.ocfl.core.util.PercentEscaper.Builder
POSTGRES - Enum constant in enum class io.ocfl.core.db.DbType
PostgresObjectDetailsDatabase - Class in io.ocfl.core.db
PostgresObjectDetailsDatabase(String, DataSource, boolean, long, TimeUnit) - Constructor for class io.ocfl.core.db.PostgresObjectDetailsDatabase
prefix() - Method in interface io.ocfl.core.storage.cloud.CloudClient: The key prefix of all objects within the OCFL repository.
prefix(String) - Method in class io.ocfl.core.storage.cloud.CloudObjectKey.Builder
prependCharConstraint(PathCharConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new character constraint to the beginning of the list of character constraints
prependFileNameConstraint(FileNameConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new filename constraint to the beginning of the list of filename constraints
prependPathConstraint(PathConstraint) - Method in class io.ocfl.core.path.constraint.PathConstraintProcessor: Adds a new path constraint to the beginning of the list of path constraints
prettyPrintJson() - Method in class io.ocfl.core.OcflRepositoryBuilder: Changes the InventoryMapper to pretty print Inventory JSON files so that they are human readable but use more disk space.
prettyPrintMapper() - Static method in class io.ocfl.core.inventory.InventoryMapper: Creates an InventoryMapper that will pretty print JSON files.
prettyPrintMapper() - Static method in class io.ocfl.core.util.ObjectMappers: The same as ObjectMappers.defaultMapper() except it pretty prints.
previousDigest(String) - Method in class io.ocfl.core.model.InventoryBuilder
previousRevisionNum() - Method in class io.ocfl.core.model.RevisionNum
processFileWithDigest(String, Path, String, OcflOption...) - Method in class io.ocfl.core.inventory.AddFileProcessor: Adds the file at sourcePath to the object at the specified destinationPath.
processPath(Path, OcflOption...) - Method in class io.ocfl.core.inventory.AddFileProcessor: Adds all of the files at or under the sourcePath to the root of the object.
processPath(Path, String, OcflOption...) - Method in class io.ocfl.core.inventory.AddFileProcessor: Adds all of the files at or under the sourcePath to the object at the specified destinationPath.
purgeMutableHead(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: Permanently removes the mutable HEAD of an object.
purgeMutableHead(String) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Permanently removes the mutable HEAD of an object.
purgeMutableHead(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Permanently removes the mutable HEAD of an object.
purgeMutableHead(String) - Method in interface io.ocfl.core.storage.OcflStorage: Permanently removes the mutable HEAD of an object.
purgeObject(String) - Method in class io.ocfl.core.DefaultOcflRepository
purgeObject(String) - Method in class io.ocfl.core.storage.CachingOcflStorage: Permanently removes an object from the repository.
purgeObject(String) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Permanently removes an object from the repository.
purgeObject(String) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Permanently removes an object from the repository.
purgeObject(String) - Method in interface io.ocfl.core.storage.OcflStorage: Permanently removes an object from the repository.
purgeStagedChanges(String) - Method in class io.ocfl.core.DefaultMutableOcflRepository
put(String, String) - Method in class io.ocfl.core.model.PathBiMap: Adds a new fileId => path mapping
put(K, V) - Method in interface io.ocfl.core.cache.Cache: Inserts a value into the cache.
put(K, V) - Method in class io.ocfl.core.cache.CaffeineCache: Inserts a value into the cache.
put(K, V) - Method in class io.ocfl.core.cache.NoOpCache
putObject(ObjectVersionId, Path, VersionInfo, OcflOption...) - Method in class io.ocfl.core.DefaultOcflRepository
putVersion(VersionNum, Version) - Method in class io.ocfl.core.model.InventoryBuilder: Inserts a version at the specified version number.

R

R1 - Static variable in class io.ocfl.core.model.RevisionNum
read(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Streams the content of the specified file
read(String) - Method in interface io.ocfl.core.storage.common.Storage: Streams the content of the specified file
read(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Streams the content of the specified file
read(String, DigestAlgorithm, InputStream) - Method in class io.ocfl.core.inventory.InventoryMapper
read(String, DigestAlgorithm, Path) - Method in class io.ocfl.core.inventory.InventoryMapper
readDigestOptional(Path) - Static method in class io.ocfl.core.inventory.SidecarMapper
readDigestRequired(Path) - Static method in class io.ocfl.core.inventory.SidecarMapper
readLazy(String, DigestAlgorithm, String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Return an OcflFileRetriever that can be used to read the specified file at a later time.
readLazy(String, DigestAlgorithm, String) - Method in interface io.ocfl.core.storage.common.Storage: Return an OcflFileRetriever that can be used to read the specified file at a later time.
readLazy(String, DigestAlgorithm, String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Return an OcflFileRetriever that can be used to read the specified file at a later time.
readMutableHead(String, RevisionNum, DigestAlgorithm, InputStream) - Method in class io.ocfl.core.inventory.InventoryMapper
readMutableHead(String, RevisionNum, DigestAlgorithm, Path) - Method in class io.ocfl.core.inventory.InventoryMapper
readMutableHeadNoDigest(String, RevisionNum, InputStream) - Method in class io.ocfl.core.inventory.InventoryMapper
readMutableHeadNoDigest(String, RevisionNum, Path) - Method in class io.ocfl.core.inventory.InventoryMapper
readNoDigest(String, InputStream) - Method in class io.ocfl.core.inventory.InventoryMapper
readNoDigest(String, Path) - Method in class io.ocfl.core.inventory.InventoryMapper
readToString(String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Read the contents of the specified file to a string
readToString(String) - Method in interface io.ocfl.core.storage.common.Storage: Read the contents of the specified file to a string
readToString(String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Read the contents of the specified file to a string
reconstructObjectVersion(Inventory, VersionNum, Path) - Method in class io.ocfl.core.storage.CachingOcflStorage: Reconstructs a complete object at the specified version in the stagingDir.
reconstructObjectVersion(Inventory, VersionNum, Path) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Reconstructs a complete object at the specified version in the stagingDir.
reconstructObjectVersion(Inventory, VersionNum, Path) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Reconstructs a complete object at the specified version in the stagingDir.
reconstructObjectVersion(Inventory, VersionNum, Path) - Method in interface io.ocfl.core.storage.OcflStorage: Reconstructs a complete object at the specified version in the stagingDir.
recursiveCopy(Path, Path, StandardCopyOption...) - Static method in class io.ocfl.core.util.FileUtil
RegexPathConstraint - Class in io.ocfl.core.path.constraint: Validates that a path or filename does or does not match a regex
RegexPathConstraint(boolean, Pattern) - Constructor for class io.ocfl.core.path.constraint.RegexPathConstraint
register(String, Class<? extends OcflExtension>) - Static method in class io.ocfl.core.extension.OcflExtensionRegistry: Registers a new extension implementation.
reinstateFile(VersionNum, String, String, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
reinstateFile(VersionNum, String, String, OcflOption...) - Method in class io.ocfl.core.inventory.InventoryUpdater: Reinstates a file from a previous version to the current version.
remove(String) - Static method in class io.ocfl.core.extension.OcflExtensionRegistry: Removes an extension from the registry.
removeContentPath(String) - Method in class io.ocfl.core.model.InventoryBuilder: Removes a file from the manifest and fixity bock by content path
removeContentPathFromFixity(String) - Method in class io.ocfl.core.model.InventoryBuilder: Removes a file from the fixity block by content path
removeFile(String) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
removeFile(String) - Method in class io.ocfl.core.inventory.InventoryUpdater: Removes a file from the current version.
removeFileId(String) - Method in class io.ocfl.core.model.InventoryBuilder: Removes a file from the manifest and fixity block
removeFileId(String) - Method in class io.ocfl.core.model.PathBiMap: Removes a fileId from the map.
removeFileId(String) - Method in class io.ocfl.core.model.VersionBuilder: Removes a fileId from the state
removeLogicalPath(String) - Method in class io.ocfl.core.model.VersionBuilder: Removes a logical path from the state
removePath(String) - Method in class io.ocfl.core.model.PathBiMap: Removes the path from the map.
renameFile(String, String, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
renameFile(String, String, OcflOption...) - Method in class io.ocfl.core.inventory.InventoryUpdater: Renames a file in the current version to a new logical path.
replicateVersionAsHead(ObjectVersionId, VersionInfo) - Method in class io.ocfl.core.DefaultOcflRepository
RepositoryConfig - Class in io.ocfl.core.storage: OCFL repository configuration as defined in the storage root.
RepositoryConfig(OcflVersion, OcflStorageLayoutExtension) - Constructor for class io.ocfl.core.storage.RepositoryConfig
requireInventory(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository
resolveContentDir(Inventory, Path) - Method in class io.ocfl.core.DefaultOcflRepository
resolveContentDirectory() - Method in class io.ocfl.core.model.Inventory: The name of the directory within a version directory that contains the object content.
ResponseMapper - Class in io.ocfl.core.util: Used to map Inventory objects to API response objects
ResponseMapper() - Constructor for class io.ocfl.core.util.ResponseMapper
retrieveFile() - Method in class io.ocfl.core.storage.cloud.CloudOcflFileRetriever
retrieveFile() - Method in class io.ocfl.core.storage.filesystem.FileSystemOcflFileRetriever
retrieveObjectDetails(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Retrieves ObjectDetails from the database.
retrieveObjectDetails(String) - Method in interface io.ocfl.core.db.ObjectDetailsDatabase: Retrieves ObjectDetails from the database.
revisionNum(RevisionNum) - Method in class io.ocfl.core.model.InventoryBuilder
RevisionNum - Class in io.ocfl.core.model: Represents the revision number of a mutable HEAD in the form of rN.
RevisionNum(long) - Constructor for class io.ocfl.core.model.RevisionNum
revisionPath(RevisionNum) - Method in class io.ocfl.core.ObjectPaths.ContentRoot
RIGHT - Enum constant in enum class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig.ZeroPadding
rollbackToVersion(ObjectVersionId) - Method in class io.ocfl.core.DefaultOcflRepository
rollbackToVersion(Inventory, VersionNum) - Method in class io.ocfl.core.storage.CachingOcflStorage: Sets the head object version to the specified version by reinstating that version's inventory into the object root, and purging all intermediary versions.
rollbackToVersion(Inventory, VersionNum) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Sets the head object version to the specified version by reinstating that version's inventory into the object root, and purging all intermediary versions.
rollbackToVersion(Inventory, VersionNum) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Sets the head object version to the specified version by reinstating that version's inventory into the object root, and purging all intermediary versions.
rollbackToVersion(Inventory, VersionNum) - Method in interface io.ocfl.core.storage.OcflStorage: Sets the head object version to the specified version by reinstating that version's inventory into the object root, and purging all intermediary versions.
rowLockQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for locking object details entries

S

safeDelete(Path) - Static method in class io.ocfl.core.util.FileUtil: Non-recursive path delete.
safeDeleteDirectory(Path) - Static method in class io.ocfl.core.util.FileUtil: Deletes the path and all of its children.
safeDeleteObjects(String...) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Deletes all of the objects and does not throw an exception on failure
safeDeleteObjects(Collection<String>) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Deletes all of the objects and does not throw an exception on failure
selectDetailsQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for selecting object details entries
selectDigestQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for selecting inventory digests
setAddress(String) - Method in class io.ocfl.core.validation.model.SimpleUser
setClock(Clock) - Method in class io.ocfl.core.DefaultOcflRepository: This is used to manipulate the clock for testing purposes.
setContentDirectory(String) - Method in class io.ocfl.core.validation.model.SimpleInventory
setContentEncoding(String) - Method in class io.ocfl.core.storage.cloud.HeadResult
setContentLength(Long) - Method in class io.ocfl.core.storage.cloud.HeadResult
setCreated(String) - Method in class io.ocfl.core.validation.model.SimpleVersion
setDelimiter(String) - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig: The case-insensitive, delimiter marking the end of the OCFL object identifier prefix; MUST consist of a character string of length one or greater.
setDelimiter(String) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: The case-insensitive, delimiter marking the end of the OCFL object identifier prefix; MUST consist of a character string of length one or greater.
setDescription(String) - Method in class io.ocfl.core.extension.storage.layout.OcflLayout: Sets the human-readable description of the layout
setDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.db.OcflObjectDetails
setDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig: The digest algorithm to apply on the OCFL object identifier; MUST be an algorithm that is allowed in the OCFL fixity block
setDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig: The digest algorithm to apply on the OCFL object identifier; MUST be an algorithm that is allowed in the OCFL fixity block
setDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.storage.common.ObjectProperties
setDigestAlgorithm(String) - Method in class io.ocfl.core.validation.model.SimpleInventory
setDirectories(List<ListResult.DirectoryListing>) - Method in class io.ocfl.core.storage.cloud.ListResult
setETag(String) - Method in class io.ocfl.core.storage.cloud.HeadResult
setExtension(String) - Method in class io.ocfl.core.extension.storage.layout.OcflLayout: Sets the storage layout extension key
setExtensionName(String) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
setExtensionName(String) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
setExtensionName(String) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
setExtensions(boolean) - Method in class io.ocfl.core.storage.common.ObjectProperties
setFixity(Map<String, Map<String, List<String>>>) - Method in class io.ocfl.core.validation.model.SimpleInventory
setHead(String) - Method in class io.ocfl.core.validation.model.SimpleInventory
setId(String) - Method in class io.ocfl.core.validation.model.SimpleInventory
setInventory(byte[]) - Method in class io.ocfl.core.db.OcflObjectDetails
setInventoryDigest(String) - Method in class io.ocfl.core.db.OcflObjectDetails
setKey(CloudObjectKey) - Method in class io.ocfl.core.storage.cloud.ListResult.ObjectListing
setKeySuffix(String) - Method in class io.ocfl.core.storage.cloud.ListResult.ObjectListing
setLastModified(Instant) - Method in class io.ocfl.core.storage.cloud.HeadResult
setLockWaitTimeout(Connection, long) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Sets the amount of time to wait for a row lock before timing out.
setLockWaitTimeout(Connection, long) - Method in class io.ocfl.core.db.H2ObjectDetailsDatabase: Sets the amount of time to wait for a row lock before timing out.
setLockWaitTimeout(Connection, long) - Method in class io.ocfl.core.db.MariaDbObjectDetailsDatabase: Sets the amount of time to wait for a row lock before timing out.
setLockWaitTimeout(Connection, long) - Method in class io.ocfl.core.db.PostgresObjectDetailsDatabase: Sets the amount of time to wait for a row lock before timing out.
setManifest(Map<String, List<String>>) - Method in class io.ocfl.core.validation.model.SimpleInventory
setMessage(String) - Method in class io.ocfl.core.validation.model.SimpleVersion
setName(String) - Method in class io.ocfl.core.validation.model.SimpleUser
setNumberOfTuples(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig: Indicates how many segments are used for path generation
setNumberOfTuples(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig: Indicates how many segments are used for path generation
setNumberOfTuples(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: The number of segments to use for path generation
setObjectId(String) - Method in class io.ocfl.core.db.OcflObjectDetails
setObjectRootPath(String) - Method in class io.ocfl.core.db.OcflObjectDetails
setObjects(List<ListResult.ObjectListing>) - Method in class io.ocfl.core.storage.cloud.ListResult
setOcflVersion(OcflVersion) - Method in class io.ocfl.core.storage.common.ObjectProperties
setPath(String) - Method in class io.ocfl.core.storage.cloud.ListResult.DirectoryListing
setReverseObjectRoot(Boolean) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: indicates that the prefix-omitted, padded object identifier should be reversed
setRevisionNum(RevisionNum) - Method in class io.ocfl.core.db.OcflObjectDetails
setShortObjectRoot(Boolean) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig: When true, indicates that the OCFL object root directory name should contain the remainder of the digest not used in the n-tuples segments
setState(Map<String, List<String>>) - Method in class io.ocfl.core.validation.model.SimpleVersion
setTupleSize(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig: Indicates the size of the segments (in characters) that the digest is split into
setTupleSize(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig: Indicates the size of the segments (in characters) that the digest is split into
setTupleSize(Integer) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: the segment size (in characters) to split the digest into
setType(String) - Method in class io.ocfl.core.validation.model.SimpleInventory
setUpdateTimestamp(LocalDateTime) - Method in class io.ocfl.core.db.OcflObjectDetails
setUser(SimpleUser) - Method in class io.ocfl.core.validation.model.SimpleVersion
setVersionNum(VersionNum) - Method in class io.ocfl.core.db.OcflObjectDetails
setVersions(Map<String, SimpleVersion>) - Method in class io.ocfl.core.validation.model.SimpleInventory
setZeroPadding(NTupleOmitPrefixStorageLayoutConfig.ZeroPadding) - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig: Indicates whether to use left or right zero padding for ids less than tupleSize * numberOfTuples
SidecarMapper - Class in io.ocfl.core.inventory
SimpleInventory - Class in io.ocfl.core.validation.model: A minimally structured representation of an OCFL inventory
SimpleInventory() - Constructor for class io.ocfl.core.validation.model.SimpleInventory
SimpleInventory(String, String, String, String, String, Map<String, Map<String, List<String>>>, Map<String, List<String>>, Map<String, SimpleVersion>) - Constructor for class io.ocfl.core.validation.model.SimpleInventory
SimpleInventoryParser - Class in io.ocfl.core.validation: Parses a JSON inventory into a minimally valid SimpleInventory object.
SimpleInventoryParser() - Constructor for class io.ocfl.core.validation.SimpleInventoryParser
SimpleInventoryParser.ParseSimpleInventoryResult - Class in io.ocfl.core.validation
SimpleInventoryValidator - Class in io.ocfl.core.validation: Validates the contents of a SimpleInventory object against the OCFL v1.0 spec
SimpleInventoryValidator() - Constructor for class io.ocfl.core.validation.SimpleInventoryValidator
SimpleInventoryValidator.VersionEquality - Enum Class in io.ocfl.core.validation
SimpleUser - Class in io.ocfl.core.validation.model: A minimally structured representation of an OCFL user
SimpleUser() - Constructor for class io.ocfl.core.validation.model.SimpleUser
SimpleUser(String, String) - Constructor for class io.ocfl.core.validation.model.SimpleUser
SimpleVersion - Class in io.ocfl.core.validation.model: A minimally structured representation of an OCFL version
SimpleVersion() - Constructor for class io.ocfl.core.validation.model.SimpleVersion
SimpleVersion(String, String, SimpleUser, Map<String, List<String>>) - Constructor for class io.ocfl.core.validation.model.SimpleVersion
size(Path) - Static method in class io.ocfl.core.util.UncheckedFiles
stageChanges(ObjectVersionId, VersionInfo, Consumer<OcflObjectUpdater>) - Method in class io.ocfl.core.DefaultMutableOcflRepository
state(PathBiMap) - Method in class io.ocfl.core.model.VersionBuilder
state(Map<String, Set<String>>) - Method in class io.ocfl.core.model.VersionBuilder
STATE_KEY - Static variable in class io.ocfl.core.validation.model.SimpleVersion
storage(Storage) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Set the storage implementation to use.
storage(OcflStorage) - Method in class io.ocfl.core.OcflRepositoryBuilder: The storage layer the repository should use.
storage(Consumer<OcflStorageBuilder>) - Method in class io.ocfl.core.OcflRepositoryBuilder: Configure the storage layer the repository should use.
Storage - Interface in io.ocfl.core.storage.common: Abstraction over any storage implementation.
storagePath(String) - Method in class io.ocfl.core.model.Inventory: Returns the path from the storage root to a file within an object.
storagePathConstraintProcessor(PathConstraintProcessor) - Method in class io.ocfl.core.path.constraint.DefaultContentPathConstraintProcessor.Builder: Sets the PathConstraintProcessor to apply to storage paths.
storeInventory(boolean) - Method in class io.ocfl.core.db.ObjectDetailsDatabaseBuilder: If serialized inventories should be stored in the database.
storeNewVersion(Inventory, Path, boolean) - Method in class io.ocfl.core.storage.CachingOcflStorage: Stores a new version of an object and writes the inventory to the cache.
storeNewVersion(Inventory, Path, boolean) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Persists a fully composed object version.
storeNewVersion(Inventory, Path, boolean) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Writes the new object version to the underlying storage within a transaction that updates the object details state within the database.
storeNewVersion(Inventory, Path, boolean) - Method in interface io.ocfl.core.storage.OcflStorage: Persists a fully composed object version.
stubInventory(String, OcflConfig, String) - Static method in class io.ocfl.core.model.Inventory: Creates a stub inventory that is useful when creating new objects.
supportEvaluator - Variable in class io.ocfl.core.storage.AbstractOcflStorage

T

TableCreator - Class in io.ocfl.core.db: Creates database tables if they don't exist.
TableCreator(DbType, DataSource) - Constructor for class io.ocfl.core.db.TableCreator
tableName(String) - Method in class io.ocfl.core.db.ObjectDetailsDatabaseBuilder: Sets the name of the table to use to store object details.
tableName(String) - Method in class io.ocfl.core.lock.ObjectLockBuilder: Sets the name of the table to use for object locking.
toContentPathPart(String) - Method in class io.ocfl.core.path.mapper.DirectLogicalPathMapper: Maps a logical path to a content path.
toContentPathPart(String) - Method in interface io.ocfl.core.path.mapper.LogicalPathMapper: Maps a logical path to a content path.
toContentPathPart(String) - Method in class io.ocfl.core.path.mapper.PercentEncodingLogicalPathMapper
toCopyOptions(OcflOption...) - Static method in class io.ocfl.core.util.FileUtil
toJson() - Method in enum class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig.ZeroPadding
toString() - Method in class io.ocfl.core.db.OcflObjectDetails
toString() - Method in class io.ocfl.core.extension.storage.layout.config.FlatLayoutConfig
toString() - Method in class io.ocfl.core.extension.storage.layout.config.FlatOmitPrefixLayoutConfig
toString() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleIdEncapsulationLayoutConfig
toString() - Method in class io.ocfl.core.extension.storage.layout.config.HashedNTupleLayoutConfig
toString() - Method in class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig
toString() - Method in class io.ocfl.core.extension.storage.layout.OcflLayout
toString() - Method in class io.ocfl.core.model.Inventory
toString() - Method in class io.ocfl.core.model.PathBiMap
toString() - Method in class io.ocfl.core.model.RevisionNum
toString() - Method in class io.ocfl.core.model.User
toString() - Method in class io.ocfl.core.model.Version
toString() - Method in enum class io.ocfl.core.path.constraint.PathLengthConstraint.Type
toString() - Method in class io.ocfl.core.storage.cloud.CloudObjectKey
toString() - Method in class io.ocfl.core.storage.cloud.HeadResult
toString() - Method in class io.ocfl.core.storage.cloud.ListResult.DirectoryListing
toString() - Method in class io.ocfl.core.storage.cloud.ListResult.ObjectListing
toString() - Method in class io.ocfl.core.storage.cloud.ListResult
toString() - Method in class io.ocfl.core.storage.common.Listing
toString() - Method in class io.ocfl.core.storage.common.ObjectProperties
toString() - Method in class io.ocfl.core.storage.RepositoryConfig
toString() - Method in class io.ocfl.core.validation.model.SimpleInventory
toString() - Method in class io.ocfl.core.validation.model.SimpleUser
toString() - Method in class io.ocfl.core.validation.model.SimpleVersion
toString() - Method in class io.ocfl.core.validation.ValidationResultsBuilder
type(InventoryType) - Method in class io.ocfl.core.model.InventoryBuilder
TYPE_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory

U

UncheckedCallable<V> - Interface in io.ocfl.core.util
UncheckedFiles - Class in io.ocfl.core.util: This class is just a wrapper around Files that converts IOExceptions into OcflIOExceptions.
unix() - Static method in class io.ocfl.core.path.constraint.ContentPathConstraints: Constructs a ContentPathConstraintProcessor that applies the minimum path constraints on a unix based filesystem.
unsafeAddPath(String, Path, String, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
unsupportedExtensionBehavior(UnsupportedExtensionBehavior) - Method in class io.ocfl.core.OcflRepositoryBuilder: Set the behavior when an unsupported extension is encountered.
UnsupportedExtensionBehavior - Enum Class in io.ocfl.core.extension: Describes how to handle extensions that do not have an implementation
updateDetailsQuery(String) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Constructs the query for updating object details entries
updateDetailsQuery(String) - Method in class io.ocfl.core.db.MariaDbObjectDetailsDatabase
updateObject(ObjectVersionId, VersionInfo, Consumer<OcflObjectUpdater>) - Method in class io.ocfl.core.DefaultOcflRepository
updateObjectDetails(Inventory, String, Path, Runnable) - Method in class io.ocfl.core.db.BaseObjectDetailsDatabase: Updates existing ObjectDetails in the database.
updateObjectDetails(Inventory, String, Path, Runnable) - Method in interface io.ocfl.core.db.ObjectDetailsDatabase: Updates existing ObjectDetails in the database.
upgradeInventory(OcflConfig) - Method in class io.ocfl.core.inventory.InventoryUpdater: Upgrades the inventory to the current default OCFL version if applicable.
uploadBytes(String, byte[], String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Uploads an object with byte content
uploadFile(Path, String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Uploads a file to the destination, and returns the object key.
uploadFile(Path, String, String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Uploads a file to the destination, and returns the object key.
uploadFileAsync(Path, String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Asynchronously uploads a file to the destination, and returns the object key.
uploadFileAsync(Path, String, String) - Method in interface io.ocfl.core.storage.cloud.CloudClient: Asynchronously uploads a file to the destination, and returns the object key.
user(User) - Method in class io.ocfl.core.model.VersionBuilder
User - Class in io.ocfl.core.model: OCFL user object.
User(String, String) - Constructor for class io.ocfl.core.model.User
USER_KEY - Static variable in class io.ocfl.core.validation.model.SimpleVersion
useUppercase(boolean) - Method in class io.ocfl.core.util.PercentEscaper.Builder

V

validateCompatibleInventories(Inventory, Inventory) - Static method in class io.ocfl.core.validation.InventoryValidator: Validates that the currentInventory is a valid next inventory state from the previousInventory.
validateInventory(SimpleInventory, String, OcflVersion, SimpleInventoryValidator.VersionEquality) - Method in class io.ocfl.core.validation.SimpleInventoryValidator: Validates the specified inventory and returns an object contain any issues that were found.
validateInventory(String) - Method in class io.ocfl.core.validation.Validator: Validates that an inventory is internally valid.
validateInventory(Path) - Static method in class io.ocfl.core.validation.Validator: Validates that the specified inventory file is internally valid
validateNonConflictingPath(String) - Method in class io.ocfl.core.model.VersionBuilder: Validates that the logical path does not conflict with any existing logical paths in this version.
validateObject(String, boolean) - Method in class io.ocfl.core.DefaultOcflRepository
validateObject(String, boolean) - Method in class io.ocfl.core.storage.CachingOcflStorage: Validates the specified object against the OCFL 1.0 spec.
validateObject(String, boolean) - Method in class io.ocfl.core.storage.DefaultOcflStorage: Validates the specified object against the OCFL 1.0 spec.
validateObject(String, boolean) - Method in class io.ocfl.core.storage.ObjectDetailsDbOcflStorage: Validates the specified object against the OCFL 1.0 spec.
validateObject(String, boolean) - Method in interface io.ocfl.core.storage.OcflStorage: Validates the specified object against the OCFL 1.0 spec.
validateObject(String, boolean) - Method in class io.ocfl.core.validation.Validator: Validates the specified directory against the OCFL 1.0 and 1.1 spec.
validateObject(Path, boolean) - Static method in class io.ocfl.core.validation.Validator: Validates that object at the specified location on disk
validateShallow(Inventory) - Static method in class io.ocfl.core.validation.InventoryValidator: Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory.
validateVersionInfo(VersionInfo) - Method in class io.ocfl.core.DefaultOcflRepository
validateVersionStates(Inventory, Inventory) - Static method in class io.ocfl.core.validation.InventoryValidator: Validates that the two inventories contain the same version states, excluding the version in the current that is not in the previous.
ValidationResultsBuilder - Class in io.ocfl.core.validation: Accumulates validation issues
ValidationResultsBuilder() - Constructor for class io.ocfl.core.validation.ValidationResultsBuilder
Validator - Class in io.ocfl.core.validation: Validates an object directory against the OCFL 1.0 and 1.1 spec
Validator(Storage) - Constructor for class io.ocfl.core.validation.Validator
valueOf(String) - Static method in enum class io.ocfl.core.db.DbType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig.ZeroPadding: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.core.extension.UnsupportedExtensionBehavior: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.core.path.constraint.PathLengthConstraint.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.core.storage.common.Listing.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.core.validation.SimpleInventoryValidator.VersionEquality: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.ocfl.core.db.DbType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.core.extension.storage.layout.config.NTupleOmitPrefixStorageLayoutConfig.ZeroPadding: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.core.extension.UnsupportedExtensionBehavior: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.core.path.constraint.PathLengthConstraint.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.core.storage.common.Listing.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.core.validation.SimpleInventoryValidator.VersionEquality: Returns an array containing the constants of this enum class, in the order they are declared.
verifyInventoryDigest(boolean) - Method in class io.ocfl.core.storage.OcflStorageBuilder: Configures whether inventory digests should be verified on read.
verifyStaging(boolean) - Method in class io.ocfl.core.OcflRepositoryBuilder: Configures whether to verify the contents of a staged version before it is moved into the OCFL object.
version(VersionNum) - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
Version - Class in io.ocfl.core.model: OCFL version object.
Version(OffsetDateTime, String, User, Map<String, Set<String>>) - Constructor for class io.ocfl.core.model.Version
VersionBuilder - Class in io.ocfl.core.model: Used to construct Version objects.
VersionBuilder() - Constructor for class io.ocfl.core.model.VersionBuilder
VersionBuilder(Version) - Constructor for class io.ocfl.core.model.VersionBuilder: Used to construct a new Version that's based on an existing version.
versionInfo(VersionInfo) - Method in class io.ocfl.core.model.VersionBuilder
versionPath(VersionNum) - Method in class io.ocfl.core.ObjectPaths.ObjectRoot
versions(Map<VersionNum, Version>) - Method in class io.ocfl.core.model.InventoryBuilder
VERSIONS_KEY - Static variable in class io.ocfl.core.validation.model.SimpleInventory

W

waitTime(long, TimeUnit) - Method in class io.ocfl.core.db.ObjectDetailsDatabaseBuilder: Used to override the amount of time the client will wait to obtain a lock.
waitTime(long, TimeUnit) - Method in class io.ocfl.core.lock.ObjectLockBuilder: Used to override the amount of time the client will wait to obtain an object lock.
WARN - Enum constant in enum class io.ocfl.core.extension.UnsupportedExtensionBehavior: Writes a WARNing to the logs and ignores the extension
windows() - Static method in class io.ocfl.core.path.constraint.ContentPathConstraints: Constructs a ContentPathConstraintProcessor that applies the minimum path constraints on a Windows based filesystem.
withContentDirectory(String) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withFixity(Map<DigestAlgorithm, Map<String, Set<String>>>) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withHead(VersionNum) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withId(String) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withInventoryDigest(String) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withLock(String, UncheckedCallable<T>) - Method in class io.ocfl.core.FileLocker: Executes the callable after acquire a lock on the specified logical path.
withLock(String, Runnable) - Method in class io.ocfl.core.FileLocker: Executes the runnable after acquire a lock on the specified logical path.
withManifest(Map<String, Set<String>>) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withMutableHead(boolean) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withObjectRootPath(String) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withRevisionNum(RevisionNum) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withType(InventoryType) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
withVersions(Map<VersionNum, Version>) - Method in class io.ocfl.core.model.Inventory.JacksonBuilder
workDir(Path) - Method in class io.ocfl.core.OcflRepositoryBuilder: The temporary workspace the repository uses to assemble object versions.
write(OutputStream, Inventory) - Method in class io.ocfl.core.inventory.InventoryMapper
write(String, byte[], String) - Method in class io.ocfl.core.storage.cloud.CloudStorage: Write the specified content to the specified path.
write(String, byte[], String) - Method in interface io.ocfl.core.storage.common.Storage: Write the specified content to the specified path.
write(String, byte[], String) - Method in class io.ocfl.core.storage.filesystem.FileSystemStorage: Write the specified content to the specified path.
write(Path, Inventory) - Method in class io.ocfl.core.inventory.InventoryMapper
writeFile(InputStream, String, OcflOption...) - Method in class io.ocfl.core.DefaultOcflObjectUpdater
writeFile(Path) - Method in class io.ocfl.core.util.NamasteTypeFile
writeInventory(Inventory, Path) - Method in class io.ocfl.core.DefaultOcflRepository
writeNewVersion(Inventory, Path, boolean, boolean) - Method in class io.ocfl.core.DefaultOcflRepository
writeSidecar(Inventory, String, Path) - Static method in class io.ocfl.core.inventory.SidecarMapper

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