Package edu.wisc.library.ocfl.core.storage

Class AbstractOcflStorage

java.lang.Object

edu.wisc.library.ocfl.core.storage.AbstractOcflStorage

All Implemented Interfaces:

OcflStorage

Direct Known Subclasses:

CachingOcflStorage, CloudOcflStorage, FileSystemOcflStorage, ObjectDetailsDbOcflStorage

public abstract class AbstractOcflStorage
extends Object
implements OcflStorage

OcflStorage abstract implementation that handles managing the repository's state, initialized, open, close.

Field Summary

Fields

Modifier and Type	Field	Description
protected InventoryMapper	inventoryMapper
protected OcflVersion	ocflVersion
protected ExtensionSupportEvaluator	supportEvaluator

Constructor Summary

Constructors

Constructor	Description
AbstractOcflStorage()

Method Summary

Modifier and Type	Method	Description
void	close()	Shutsdown any resources the OclfStorage may have open, such as ExecutorServices.
protected abstract void	doInitialize(OcflExtensionConfig layoutConfig)	Does whatever is necessary to initialize OCFL repository storage.
protected void	ensureOpen()	Throws an exception if the repository has not been initialized or is closed
void	initializeStorage(OcflVersion ocflVersion, OcflExtensionConfig layoutConfig, InventoryMapper inventoryMapper, ExtensionSupportEvaluator supportEvaluator)	Initializes the OCFL root.
void	invalidateCache()	If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache.
void	invalidateCache(String objectId)	If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.wisc.library.ocfl.core.storage.OcflStorage

commitMutableHead, containsObject, exportObject, exportVersion, getInventoryBytes, getObjectStreams, importObject, listObjectIds, loadInventory, objectRootPath, purgeMutableHead, purgeObject, reconstructObjectVersion, rollbackToVersion, storeNewVersion, validateObject

Field Detail

inventoryMapper

protected InventoryMapper inventoryMapper

ocflVersion

protected OcflVersion ocflVersion

supportEvaluator

protected ExtensionSupportEvaluator supportEvaluator

Constructor Detail

AbstractOcflStorage

public AbstractOcflStorage()

Method Detail

initializeStorage

public void initializeStorage(OcflVersion ocflVersion,
                              OcflExtensionConfig layoutConfig,
                              InventoryMapper inventoryMapper,
                              ExtensionSupportEvaluator supportEvaluator)

Initializes the OCFL root. If it is an existing OCFL repository and the root has already been initialized, then this method should do nothing. This method must be called before the object may be used.

layoutConfig may be null if the OCFL repository already exists, in which case the existing configuration is used. If layoutConfig is specified for an existing repository, initialization will fail if the configurations do not match.

Specified by:

initializeStorage in interface OcflStorage

Parameters:

ocflVersion - the OCFL version

layoutConfig - the storage layout configuration, may be null to auto-detect existing configuration

inventoryMapper - the mapper to use for inventory serialization

supportEvaluator - the evaluator that determines what to do when unsupported extensions are encountered

close

public void close()

Shutsdown any resources the OclfStorage may have open, such as ExecutorServices. Once closed, additional requests will be rejected. Calling this method is optional, and it is more efficient to just let the shutdown hooks take care of closing the resources.

Specified by:

close in interface OcflStorage

invalidateCache

public void invalidateCache(String objectId)

If the OcflStorage is using an inventory cache, then this method invalidates the cache entry for the specified object. Otherwise, nothing happens.

Specified by:

invalidateCache in interface OcflStorage

Parameters:

objectId - the ID of the object to invalidate in the cache

invalidateCache

public void invalidateCache()

If the OcflStorage is using an inventory cache, then this method invalidates all entries in the cache. Otherwise, nothing happens.

Specified by:

invalidateCache in interface OcflStorage

doInitialize

protected abstract void doInitialize(OcflExtensionConfig layoutConfig)

Does whatever is necessary to initialize OCFL repository storage.

Parameters:

layoutConfig - the storage layout configuration, may be null to auto-detect existing configuration

ensureOpen

protected void ensureOpen()

Throws an exception if the repository has not been initialized or is closed