All Classes

Class	Description
AbstractOcflStorage	OcflStorage abstract implementation that handles managing the repository's state, initialized, open, close.
AddFileProcessor	Encapsulates logic for adding files to an object, both adding them to the inventory and moving them into staging.
AddFileProcessor.Builder
BackslashPathSeparatorConstraint	Windows only: Rejects filenames that contain backslashes
BaseObjectDetailsDatabase
BeginEndPathConstraint	Validates that a path or filename does or does not begin or and with a specified value
BitSetPathCharConstraint	Constraint that applies restrictions on what characters are allowed in file names.
Cache<K,V>	Extension point that allows the OCFL repository to use any number of different cache implementations so long as they conform to this interface.
CachingOcflStorage	Adds an Inventory caching layer on top of an OcflStorage implementation.
CaffeineCache<K,V>	In-memory cache implementation that is a wrapper around a Caffeine cache.
CloudClient	Wrapper interface abstracting cloud provider clients
CloudObjectKey	Represents a key to an object in cloud storage.
CloudObjectKey.Builder
CloudOcflFileRetriever	OcflFileRetriever implementation for lazy-loading files from cloud storage.
CloudOcflFileRetriever.Builder
CloudOcflObjectRootDirIterator	Implementation of OcflObjectRootDirIterator that iterates over cloud objects
CloudOcflStorage	OcflStorage implementation for integrating with cloud storage providers.
CloudOcflStorageBuilder	Builder for constructing S3OcflStorage objects.
CloudOcflStorageInitializer	Initializes an OCFL repository in cloud storage.
CloudStorage	S3 storage implementation used when validating objects
ContentPathConstraintProcessor
ContentPathConstraints	This class provides default path constraints that can be applied to OCFL content paths to attempt to ensure portability across various filesystems.
ContentPathMapper	This maps logical paths to content paths and applies content path constraints.
ContentPathMapper.Builder
DbType	This enum describes the database types that the library supports out of the box.
DefaultContentPathConstraintProcessor	This class enforces constraints on content paths.
DefaultContentPathConstraintProcessor.Builder	Use this to construct a ContentPathConstraintProcessor
DefaultMutableOcflRepository	Extends the OCFL repository to support OCFL objects with mutable HEADs as defined by the Mutable HEAD Extension.
DefaultOcflObjectUpdater	Default implementation of OcflObjectUpdater that is used by DefaultOcflRepository to provide write access to an object.
DefaultOcflRepository	Primary implementation of the OcflRepository API.
DigestUtil
DirectLogicalPathMapper	Directly maps logical paths to content paths without making any changes.
ExtensionSupportEvaluator	Evaluates if an extension is supported and acts accordingly if it is not.
FileNameConstraint	Validates that a filename meets a defined constraint
FileSystemOcflFileRetriever	OcflFileRetriever implementation for lazy-loading files from file system storage.
FileSystemOcflObjectRootDirIterator	Implementation of OcflObjectRootDirIterator that iterates over the filesystem
FileSystemOcflStorage
FileSystemOcflStorageBuilder	Builder for constructing FileSystemOcflStorage objects.
FileSystemOcflStorageInitializer	Prepares an OCFL storage root for use.
FileSystemStorage	Filesystem storage implementation used when validating objects
FileUtil
FlatLayoutConfig	Configuration for the Flat Direct Storage Layout extension.
FlatLayoutExtension	Implementation of the Flat Storage Layout extension.
H2ObjectDetailsDatabase
H2ObjectLock
HashedNTupleIdEncapsulationLayoutConfig	Configuration for the Hashed Truncated N-tuple Trees with Object ID Encapsulating Directory extension.
HashedNTupleIdEncapsulationLayoutExtension	Implementation of the Hashed Truncated N-tuple Trees with Object ID Encapsulating Directory extension.
HashedNTupleLayoutConfig	Configuration for the Hashed N-tuple Storage Layout extension.
HashedNTupleLayoutExtension	Implementation of the Hashed N-tuple Storage Layout extension.
HeadResult	Encapsulates the results of a head operation
InMemoryObjectLock	In-memory implementation of ObjectLock that uses Java's ReentrantReadWriteLock.
Inventory	OCFL inventory object.
Inventory.JacksonBuilder	This builder is only intended to be used by Jackson for deserializing inventory files.
InventoryBuilder	Used to construct Inventory objects.
InventoryMapper	Wrapper around Jackson's ObjectMapper for serializing and deserializing Inventories.
InventoryUpdater	This class is used to record changes to OCFL objects and construct an updated inventory.
InventoryUpdater.AddFileResult	Indicates the result of an add file operation.
InventoryUpdater.Builder
InventoryUpdater.RemoveFileResult	Indicates that a file was removed from the manifest.
InventoryValidator	Validates that an Inventory meets the minimum requirements to be serialized as valid OCFL inventory.
KeyNotFoundException	This exception is thrown when a cloud storage provider cannot find the specified key.
Listing	The result of a storage list operation
Listing.Type
ListResult	Encapsulates the results of a list operation
ListResult.DirectoryListing	Encapsulates a virtual directory.
ListResult.ObjectListing	Encapsulates an object key and its suffix.
LogicalPathConstraints	Describes the constraints that are applied to logical paths.
LogicalPathMapper	Maps logical paths to content paths.
LogicalPathMappers	This class defines common LogicalPathMapper implementations.
MutableHeadInventoryCommitter	Converts a mutable HEAD version into a regular OCFL version.
NamasteTypeFile
NonEmptyFileNameConstraint	Validates that there are no empty filenames
NoOpCache<K,V>	Pass-through cache implementation that never caches.
ObjectDetailsDatabase	Interface for interacting with OCFL object details that are stored in a database.
ObjectDetailsDatabaseBuilder	Constructs ObjectDetailsDatabase instances
ObjectDetailsDbOcflStorage
ObjectLock	Extension point that allows the OCFL repository to use any number of different lock implementations so long as they conform to this interface.
ObjectLockBuilder	Constructs new ObjectLock instances
ObjectMappers
ObjectPaths	Centralizes common OCFL path locations
ObjectPaths.ContentRoot	Provides methods for navigating a version's content directory
ObjectPaths.HasInventory
ObjectPaths.ObjectRoot	Provides methods for navigating an OCFL object root
ObjectPaths.VersionRoot	Provides methods for navigating an OCFL object version directory
OcflExtension	Marker interface for an OCFL extension implementation
OcflExtensionConfig	Represents deserialized extension configuration.
OcflExtensionRegistry	Registry for mapping extensions to their implementations.
OcflLayout	This class is a representation of the ocfl_layout.json file.
OcflObjectDetails	Represents a ObjectDetails database record.
OcflObjectRootDirIterator	Iterator that iterates over OCFL object root directories.
OcflObjectRootDirIterator.Directory	Encapsulates a directory for iterating over its children
OcflRepositoryBuilder	Constructs a local file system based OCFL repository sensible defaults that can be overridden prior to calling build().
OcflStorage	Extension point that allows the OCFL repository to use any number of storage implementations so long as they conform to this interface.
OcflStorageLayoutExtension	Interface for OCFL storage layout extensions.
PathBiMap	BiDirection map implementation that focuses on OCFL structures.
PathCharConstraint	Validates that the characters in a filename meet a defined constraint
PathConstraint	Validates that a path meets a defined constraint
PathConstraintProcessor	A PathConstraintProcessor is used to apply a preconfigured set of constraints to a given path.
PathConstraintProcessor.Builder	Use this to construct a new PathConstraintProcessor
PathLengthConstraint	Validates that a path or filename are not longer than a fixed number of characters or bytes
PathLengthConstraint.Type
PercentEncodingLogicalPathMapper	A LogicalPathMapper that percent-encodes specific characters in logical paths to produce safe content paths.
PercentEscaper	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
PostgresObjectDetailsDatabase
PostgresObjectLock
RegexPathConstraint	Validates that a path or filename does or does not match a regex
ResponseMapper	Used to map Inventory objects to API response objects
RevisionNum	Represents the revision number of a mutable HEAD in the form of rN.
SidecarMapper
SimpleInventory	A minimally structured representation of an OCFL inventory
SimpleInventoryParser	Parses a JSON inventory into a minimally valid SimpleInventory object.
SimpleInventoryParser.ParseSimpleInventoryResult
SimpleInventoryValidator	Validates the contents of a SimpleInventory object against the OCFL v1.0 spec
SimpleUser	A minimally structured representation of an OCFL user
SimpleVersion	A minimally structured representation of an OCFL version
Storage	Storage abstraction used when validating objects
TableCreator	Creates database tables if they don't exist.
UncheckedFiles	This class is just a wrapper around Files that converts IOExceptions into OcflIOExceptions.
UnsupportedExtensionBehavior	Describes how to handle extensions that do not have an implementation
User	OCFL user object.
ValidationResultsBuilder	Accumulates validation issues
Validator	Validates an object directory against the OCFL 1.0 spec
Version	OCFL version object.
VersionBuilder	Used to construct Version objects.