Package io.ocfl.core

Class DefaultOcflObjectUpdater

java.lang.Object

io.ocfl.core.DefaultOcflObjectUpdater

All Implemented Interfaces:

OcflObjectUpdater

public class DefaultOcflObjectUpdater
extends Object
implements OcflObjectUpdater

Default implementation of OcflObjectUpdater that is used by DefaultOcflRepository to provide write access to an object.

This class is thread safe, and you can concurrently use the same updater to add multiple files to the same object version.

Constructor Summary

Constructors

Constructor	Description
DefaultOcflObjectUpdater(Inventory inventory, InventoryUpdater inventoryUpdater, Path stagingDir, AddFileProcessor addFileProcessor, FileLocker fileLocker)

Method Summary

Modifier and Type	Method	Description
OcflObjectUpdater	addFileFixity(String logicalPath, DigestAlgorithm algorithm, String value)
OcflObjectUpdater	addPath(Path sourcePath, OcflOption... options)
OcflObjectUpdater	addPath(Path sourcePath, String destinationPath, OcflOption... options)
boolean	checkForEmptyDirs()	Returns true if the processor deleted a file and thus we need to look for empty directories to delete prior to writing the version.
OcflObjectUpdater	clearFixityBlock()
OcflObjectUpdater	clearVersionState()
OcflObjectUpdater	reinstateFile(VersionNum sourceVersionNum, String sourcePath, String destinationPath, OcflOption... options)
OcflObjectUpdater	removeFile(String path)
OcflObjectUpdater	renameFile(String sourcePath, String destinationPath, OcflOption... options)
OcflObjectUpdater	unsafeAddPath(String digest, Path sourcePath, String destinationPath, OcflOption... options)
OcflObjectUpdater	writeFile(InputStream input, String destinationPath, OcflOption... options)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultOcflObjectUpdater

public DefaultOcflObjectUpdater(Inventory inventory,
 InventoryUpdater inventoryUpdater,
 Path stagingDir,
 AddFileProcessor addFileProcessor,
 FileLocker fileLocker)

Method Details

addPath

public OcflObjectUpdater addPath(Path sourcePath,
 OcflOption... options)

Specified by:

addPath in interface OcflObjectUpdater

addPath

public OcflObjectUpdater addPath(Path sourcePath,
 String destinationPath,
 OcflOption... options)

Specified by:

addPath in interface OcflObjectUpdater

unsafeAddPath

public OcflObjectUpdater unsafeAddPath(String digest,
 Path sourcePath,
 String destinationPath,
 OcflOption... options)

Specified by:

unsafeAddPath in interface OcflObjectUpdater

writeFile

public OcflObjectUpdater writeFile(InputStream input,
 String destinationPath,
 OcflOption... options)

Specified by:

writeFile in interface OcflObjectUpdater

removeFile

public OcflObjectUpdater removeFile(String path)

Specified by:

removeFile in interface OcflObjectUpdater

renameFile

public OcflObjectUpdater renameFile(String sourcePath,
 String destinationPath,
 OcflOption... options)

Specified by:

renameFile in interface OcflObjectUpdater

reinstateFile

public OcflObjectUpdater reinstateFile(VersionNum sourceVersionNum,
 String sourcePath,
 String destinationPath,
 OcflOption... options)

Specified by:

reinstateFile in interface OcflObjectUpdater

clearVersionState

public OcflObjectUpdater clearVersionState()

Specified by:

clearVersionState in interface OcflObjectUpdater

addFileFixity

public OcflObjectUpdater addFileFixity(String logicalPath,
 DigestAlgorithm algorithm,
 String value)

Specified by:

addFileFixity in interface OcflObjectUpdater

clearFixityBlock

public OcflObjectUpdater clearFixityBlock()

Specified by:

clearFixityBlock in interface OcflObjectUpdater

checkForEmptyDirs

public boolean checkForEmptyDirs()

Returns true if the processor deleted a file and thus we need to look for empty directories to delete prior to writing the version.

Returns:

true if we need to look for empty directories