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

Class OcflStorageBuilder

java.lang.Object

edu.wisc.library.ocfl.core.storage.OcflStorageBuilder

public class OcflStorageBuilder
extends Object

Builder for constructing OcflStorage objects. It is configured with sensible defaults and can minimally be used as OcflStorageBuilder.builder().fileSystem(storageRoot).build().

Constructor Summary

Constructors

Constructor	Description
OcflStorageBuilder()

Method Summary

Modifier and Type	Method	Description
OcflStorage	build()	Creates a OcflStorage object.
static OcflStorageBuilder	builder()
OcflStorageBuilder	cloud(CloudClient cloudClient)	Configure cloud based storage implementation.
OcflStorageBuilder	fileSystem(Path storageRoot)	Configure local filesystem based storage implementation.
OcflStorageBuilder	initializer(OcflStorageInitializer initializer)	Overrides the default OcflStorageInitializer.
OcflStorageBuilder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Overrides the default ObjectMapper that's used to serialize ocfl_layout.json
OcflStorageBuilder	storage(Storage storage)	Set the storage implementation to use.
OcflStorageBuilder	verifyInventoryDigest(boolean verifyInventoryDigest)	Configures whether inventory digests should be verified on read.

Methods inherited from class java.lang.Object

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

Constructor Detail

OcflStorageBuilder

public OcflStorageBuilder()

Method Detail

builder

public static OcflStorageBuilder builder()

storage

public OcflStorageBuilder storage(Storage storage)

Set the storage implementation to use. This method, fileSystem(Path), or cloud(CloudClient) must be used.

Parameters:

storage - storage implementation

Returns:

builder

fileSystem

public OcflStorageBuilder fileSystem(Path storageRoot)

Configure local filesystem based storage implementation. This method, storage(Storage), or cloud(CloudClient) must be used.

Parameters:

storageRoot - path to the OCFL storage root directory

Returns:

builder

cloud

public OcflStorageBuilder cloud(CloudClient cloudClient)

Configure cloud based storage implementation. This method, storage(Storage), or fileSystem(Path) must be used.

Parameters:

cloudClient - client to use to connect to the cloud storage

Returns:

builder

objectMapper

public OcflStorageBuilder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Overrides the default ObjectMapper that's used to serialize ocfl_layout.json

Parameters:

objectMapper - object mapper

Returns:

builder

initializer

public OcflStorageBuilder initializer(OcflStorageInitializer initializer)

Overrides the default OcflStorageInitializer. Normally, this does not need to be set.

Parameters:

initializer - the initializer

Returns:

builder

verifyInventoryDigest

public OcflStorageBuilder verifyInventoryDigest(boolean verifyInventoryDigest)

Configures whether inventory digests should be verified on read. This means computing the digest of the inventory file and comparing it with the digest in the inventory's sidecar. Default: true.

Parameters:

verifyInventoryDigest - true if inventory digests should be verified on read

Returns:

builder

build

public OcflStorage build()

Creates a OcflStorage object. One of storage(Storage), fileSystem(Path), or cloud(CloudClient) must be called before calling this method.

Returns:

a new OcflStorage object