Package edu.wisc.library.ocfl.aws

Class OcflS3Client.Builder

java.lang.Object

edu.wisc.library.ocfl.aws.OcflS3Client.Builder

Enclosing class:

OcflS3Client

public static class OcflS3Client.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OcflS3Client.Builder	bucket(String bucket)	The S3 bucket to use.
OcflS3Client	build()	Constructs a new OcflS3Client.
OcflS3Client.Builder	createMultipartModifier(BiConsumer<String,software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder> createMultipartModifier)	Provides a hook to modify createMultipartUpload requests before they are executed.
OcflS3Client.Builder	putObjectModifier(BiConsumer<String,software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> putObjectModifier)	Provides a hook to modify putObject requests before they are executed.
OcflS3Client.Builder	repoPrefix(String repoPrefix)	The key prefix to use for the repository.
OcflS3Client.Builder	s3Client(software.amazon.awssdk.services.s3.S3Client s3Client)	The AWS SDK s3 client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

s3Client

public OcflS3Client.Builder s3Client(software.amazon.awssdk.services.s3.S3Client s3Client)

The AWS SDK s3 client. Required.

Parameters:

s3Client - s3 client

Returns:

builder

bucket

public OcflS3Client.Builder bucket(String bucket)

The S3 bucket to use. Required.

Parameters:

bucket - s3 bucket

Returns:

builder

repoPrefix

public OcflS3Client.Builder repoPrefix(String repoPrefix)

The key prefix to use for the repository. Optional.

Parameters:

repoPrefix - key prefix

Returns:

builder

putObjectModifier

public OcflS3Client.Builder putObjectModifier(BiConsumer<String,software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> putObjectModifier)

Provides a hook to modify putObject requests before they are executed. It is intended to be used to set object attributes such as tags.

The first argument is the object key the request is for, and the second is the request builder to apply changes to.

Parameters:

putObjectModifier - hook for modifying putObject requests

Returns:

builder

createMultipartModifier

public OcflS3Client.Builder createMultipartModifier(BiConsumer<String,software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder> createMultipartModifier)

Provides a hook to modify createMultipartUpload requests before they are executed. It is intended to be used to set object attributes such as tags.

The first argument is the object key the request is for, and the second is the request builder to apply changes to.

Parameters:

createMultipartModifier - hook for modifying createMultipartUpload requests

Returns:

builder

build

public OcflS3Client build()

Constructs a new OcflS3Client. s3Client and bucket must be set.

Returns:

OcflS3Client