Package io.ocfl.core

Class DefaultOcflRepository

java.lang.Object

io.ocfl.core.DefaultOcflRepository

All Implemented Interfaces:

OcflRepository

Direct Known Subclasses:

DefaultMutableOcflRepository

public class DefaultOcflRepository
extends Object
implements OcflRepository

Primary implementation of the OcflRepository API. It is storage agnostic. It is typically instantiated using OcflRepositoryBuilder.

See Also:

• OcflRepositoryBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final AddFileProcessor.Builder	addFileProcessorBuilder
protected final InventoryUpdater.Builder	inventoryUpdaterBuilder

Constructor Summary

Constructors

Constructor	Description
DefaultOcflRepository(OcflStorage storage, Path workDir, ObjectLock objectLock, InventoryMapper inventoryMapper, LogicalPathMapper logicalPathMapper, ContentPathConstraintProcessor contentPathConstraintProcessor, OcflConfig config, boolean verifyStaging, Duration fileLockTimeoutDuration)

Method Summary

Modifier and Type	Method	Description
protected Inventory	buildNewInventory(InventoryUpdater inventoryUpdater, VersionInfo versionInfo)
void	close()
OcflConfig	config()
boolean	containsObject(String objectId)
protected Path	createStagingDir(String objectId)
protected Inventory	createStubInventory(ObjectVersionId objectId)
ObjectDetails	describeObject(String objectId)
VersionDetails	describeVersion(ObjectVersionId objectVersionId)
protected void	enforceObjectVersionForUpdate(ObjectVersionId objectId, Inventory inventory)
protected void	ensureOpen()
void	exportObject(String objectId, Path outputPath, OcflOption... options)
void	exportVersion(ObjectVersionId objectVersionId, Path outputPath, OcflOption... options)
FileChangeHistory	fileChangeHistory(String objectId, String logicalPath)
OcflObjectVersion	getObject(ObjectVersionId objectVersionId)
void	getObject(ObjectVersionId objectVersionId, Path outputPath)
void	importObject(Path objectPath, OcflOption... options)
void	importVersion(Path versionPath, OcflOption... options)
void	invalidateCache()
void	invalidateCache(String objectId)
Stream<String>	listObjectIds()
protected Inventory	loadInventory(ObjectVersionId objectId)
protected OffsetDateTime	now(VersionInfo versionInfo)
void	purgeObject(String objectId)
ObjectVersionId	putObject(ObjectVersionId objectVersionId, Path path, VersionInfo versionInfo, OcflOption... options)
ObjectVersionId	replicateVersionAsHead(ObjectVersionId objectVersionId, VersionInfo versionInfo)
protected Inventory	requireInventory(ObjectVersionId objectId)
protected Path	resolveContentDir(Inventory inventory, Path parent)
void	rollbackToVersion(ObjectVersionId objectVersionId)
void	setClock(Clock clock)	This is used to manipulate the clock for testing purposes.
ObjectVersionId	updateObject(ObjectVersionId objectVersionId, VersionInfo versionInfo, Consumer<OcflObjectUpdater> objectUpdater)
ValidationResults	validateObject(String objectId, boolean contentFixityCheck)
protected void	validateVersionInfo(VersionInfo versionInfo)
protected Inventory	writeInventory(Inventory inventory, Path stagingDir)
protected void	writeNewVersion(Inventory inventory, Path stagingDir, boolean upgradedOcflVersion, boolean checkForEmptyDirs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

inventoryUpdaterBuilder

protected final InventoryUpdater.Builder inventoryUpdaterBuilder

addFileProcessorBuilder

protected final AddFileProcessor.Builder addFileProcessorBuilder

Constructor Details

DefaultOcflRepository

public DefaultOcflRepository(OcflStorage storage,
 Path workDir,
 ObjectLock objectLock,
 InventoryMapper inventoryMapper,
 LogicalPathMapper logicalPathMapper,
 ContentPathConstraintProcessor contentPathConstraintProcessor,
 OcflConfig config,
 boolean verifyStaging,
 Duration fileLockTimeoutDuration)

Parameters:

storage - storage layer

workDir - path to the directory to use for assembling ocfl versions

objectLock - locking client

inventoryMapper - object mapper for serializing inventories

logicalPathMapper - logical path mapper

contentPathConstraintProcessor - content path constraint processor

config - ocfl defaults configuration

verifyStaging - true if the contents of a stage version should be double-checked

fileLockTimeoutDuration - the max amount of time to wait for a file lock

See Also:

• OcflRepositoryBuilder

Method Details

putObject

public ObjectVersionId putObject(ObjectVersionId objectVersionId,
 Path path,
 VersionInfo versionInfo,
 OcflOption... options)

Specified by:

putObject in interface OcflRepository

updateObject

public ObjectVersionId updateObject(ObjectVersionId objectVersionId,
 VersionInfo versionInfo,
 Consumer<OcflObjectUpdater> objectUpdater)

Specified by:

updateObject in interface OcflRepository

getObject

public void getObject(ObjectVersionId objectVersionId,
 Path outputPath)

Specified by:

getObject in interface OcflRepository

getObject

public OcflObjectVersion getObject(ObjectVersionId objectVersionId)

Specified by:

getObject in interface OcflRepository

describeObject

public ObjectDetails describeObject(String objectId)

Specified by:

describeObject in interface OcflRepository

describeVersion

public VersionDetails describeVersion(ObjectVersionId objectVersionId)

Specified by:

describeVersion in interface OcflRepository

fileChangeHistory

public FileChangeHistory fileChangeHistory(String objectId,
 String logicalPath)

Specified by:

fileChangeHistory in interface OcflRepository

containsObject

public boolean containsObject(String objectId)

Specified by:

containsObject in interface OcflRepository

purgeObject

public void purgeObject(String objectId)

Specified by:

purgeObject in interface OcflRepository

validateObject

public ValidationResults validateObject(String objectId,
 boolean contentFixityCheck)

Specified by:

validateObject in interface OcflRepository

replicateVersionAsHead

public ObjectVersionId replicateVersionAsHead(ObjectVersionId objectVersionId,
 VersionInfo versionInfo)

Specified by:

replicateVersionAsHead in interface OcflRepository

rollbackToVersion

public void rollbackToVersion(ObjectVersionId objectVersionId)

Specified by:

rollbackToVersion in interface OcflRepository

listObjectIds

public Stream<String> listObjectIds()

Specified by:

listObjectIds in interface OcflRepository

exportVersion

public void exportVersion(ObjectVersionId objectVersionId,
 Path outputPath,
 OcflOption... options)

Specified by:

exportVersion in interface OcflRepository

exportObject

public void exportObject(String objectId,
 Path outputPath,
 OcflOption... options)

Specified by:

exportObject in interface OcflRepository

importVersion

public void importVersion(Path versionPath,
 OcflOption... options)

Specified by:

importVersion in interface OcflRepository

importObject

public void importObject(Path objectPath,
 OcflOption... options)

Specified by:

importObject in interface OcflRepository

close

public void close()

Specified by:

close in interface OcflRepository

config

public OcflConfig config()

Specified by:

config in interface OcflRepository

invalidateCache

public void invalidateCache(String objectId)

Specified by:

invalidateCache in interface OcflRepository

invalidateCache

public void invalidateCache()

Specified by:

invalidateCache in interface OcflRepository

loadInventory

protected Inventory loadInventory(ObjectVersionId objectId)

createStubInventory

protected Inventory createStubInventory(ObjectVersionId objectId)

requireInventory

protected Inventory requireInventory(ObjectVersionId objectId)

buildNewInventory

protected Inventory buildNewInventory(InventoryUpdater inventoryUpdater,
 VersionInfo versionInfo)

writeNewVersion

protected void writeNewVersion(Inventory inventory,
 Path stagingDir,
 boolean upgradedOcflVersion,
 boolean checkForEmptyDirs)

writeInventory

protected Inventory writeInventory(Inventory inventory,
 Path stagingDir)

enforceObjectVersionForUpdate

protected void enforceObjectVersionForUpdate(ObjectVersionId objectId,
 Inventory inventory)

createStagingDir

protected Path createStagingDir(String objectId)

resolveContentDir

protected Path resolveContentDir(Inventory inventory,
 Path parent)

now

protected OffsetDateTime now(VersionInfo versionInfo)

ensureOpen

protected void ensureOpen()

validateVersionInfo

protected void validateVersionInfo(VersionInfo versionInfo)

setClock

public void setClock(Clock clock)

This is used to manipulate the clock for testing purposes.

Parameters:

clock - clock