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

Class CloudOcflStorageBuilder

java.lang.Object

edu.wisc.library.ocfl.core.storage.cloud.CloudOcflStorageBuilder

public class CloudOcflStorageBuilder
extends Object

Builder for constructing S3OcflStorage objects. It is configured with sensible defaults and can minimally be used as new S3OcflStorageBuilder().s3Client(s3Client).workDir(workDir).build(bucketName).

Constructor Summary

Constructors

Constructor	Description
CloudOcflStorageBuilder()

Method Summary

Modifier and Type	Method	Description
CloudOcflStorage	build()
CloudOcflStorageBuilder	cloudClient(CloudClient cloudClient)	Sets the cloud client.
CloudOcflStorageBuilder	initializer(CloudOcflStorageInitializer initializer)	Overrides the default CloudOcflStorageInitializer.
CloudOcflStorageBuilder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Overrides the default ObjectMapper that's used to serialize ocfl_layout.json
CloudOcflStorageBuilder	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

CloudOcflStorageBuilder

public CloudOcflStorageBuilder()

Method Detail

cloudClient

public CloudOcflStorageBuilder cloudClient(CloudClient cloudClient)

Sets the cloud client. This must be set prior to calling build().

Parameters:

cloudClient - the client to use to interface with cloud storage such as S3

Returns:

builder

objectMapper

public CloudOcflStorageBuilder 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 CloudOcflStorageBuilder initializer(CloudOcflStorageInitializer initializer)

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

Parameters:

initializer - the initializer

Returns:

builder

verifyInventoryDigest

public CloudOcflStorageBuilder 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 CloudOcflStorage build()

Returns:

a new CloudOcflStorage object