Package edu.wisc.library.ocfl.aws

Class OcflS3Client

java.lang.Object

edu.wisc.library.ocfl.aws.OcflS3Client

All Implemented Interfaces:

CloudClient

public class OcflS3Client
extends Object
implements CloudClient

CloudClient implementation that uses Amazon's S3 synchronous v2 client

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OcflS3Client.Builder

Constructor Summary

Constructors

Constructor	Description
OcflS3Client(software.amazon.awssdk.services.s3.S3Client s3Client, String bucket)
OcflS3Client(software.amazon.awssdk.services.s3.S3Client s3Client, String bucket, String prefix, BiConsumer<String,software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> putObjectModifier, BiConsumer<String,software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder> createMultipartModifier)

Method Summary

Modifier and Type	Method	Description
String	bucket()
boolean	bucketExists()
static OcflS3Client.Builder	builder()	Used to create a new OcflS3Client instance.
CloudObjectKey	copyObject(String srcPath, String dstPath)
void	deleteObjects(Collection<String> objectPaths)
void	deletePath(String path)
boolean	directoryExists(String path)
Path	downloadFile(String srcPath, Path dstPath)
InputStream	downloadStream(String srcPath)
String	downloadString(String srcPath)
HeadResult	head(String path)
ListResult	list(String prefix)
ListResult	listDirectory(String path)
String	prefix()
void	safeDeleteObjects(String... objectPaths)
void	safeDeleteObjects(Collection<String> objectPaths)
CloudObjectKey	uploadBytes(String dstPath, byte[] bytes, String contentType)
CloudObjectKey	uploadFile(Path srcPath, String dstPath)
CloudObjectKey	uploadFile(Path srcPath, String dstPath, String contentType)

Methods inherited from class java.lang.Object

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

Constructor Detail

OcflS3Client

public OcflS3Client(software.amazon.awssdk.services.s3.S3Client s3Client,
                    String bucket)

Parameters:

s3Client - aws sdk s3 client

bucket - s3 bucket

See Also:

builder()

OcflS3Client

public OcflS3Client(software.amazon.awssdk.services.s3.S3Client s3Client,
                    String bucket,
                    String prefix,
                    BiConsumer<String,software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder> putObjectModifier,
                    BiConsumer<String,software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder> createMultipartModifier)

Parameters:

s3Client - aws sdk s3 client

bucket - s3 bucket

prefix - key prefix

putObjectModifier - hook for modifying putObject requests

createMultipartModifier - hook for modifying createMultipartUpload requests

See Also:

builder()

Method Detail

builder

public static OcflS3Client.Builder builder()

Used to create a new OcflS3Client instance.

Returns:

builder

bucket

public String bucket()

Specified by:

bucket in interface CloudClient

prefix

public String prefix()

Specified by:

prefix in interface CloudClient

uploadFile

public CloudObjectKey uploadFile(Path srcPath,
                                 String dstPath)

Specified by:

uploadFile in interface CloudClient

uploadFile

public CloudObjectKey uploadFile(Path srcPath,
                                 String dstPath,
                                 String contentType)

Specified by:

uploadFile in interface CloudClient

uploadBytes

public CloudObjectKey uploadBytes(String dstPath,
                                  byte[] bytes,
                                  String contentType)

Specified by:

uploadBytes in interface CloudClient

copyObject

public CloudObjectKey copyObject(String srcPath,
                                 String dstPath)

Specified by:

copyObject in interface CloudClient

downloadFile

public Path downloadFile(String srcPath,
                         Path dstPath)

Specified by:

downloadFile in interface CloudClient

downloadStream

public InputStream downloadStream(String srcPath)

Specified by:

downloadStream in interface CloudClient

downloadString

public String downloadString(String srcPath)

Specified by:

downloadString in interface CloudClient

head

public HeadResult head(String path)

Specified by:

head in interface CloudClient

list

public ListResult list(String prefix)

Specified by:

list in interface CloudClient

listDirectory

public ListResult listDirectory(String path)

Specified by:

listDirectory in interface CloudClient

directoryExists

public boolean directoryExists(String path)

Specified by:

directoryExists in interface CloudClient

deletePath

public void deletePath(String path)

Specified by:

deletePath in interface CloudClient

deleteObjects

public void deleteObjects(Collection<String> objectPaths)

Specified by:

deleteObjects in interface CloudClient

safeDeleteObjects

public void safeDeleteObjects(String... objectPaths)

Specified by:

safeDeleteObjects in interface CloudClient

safeDeleteObjects

public void safeDeleteObjects(Collection<String> objectPaths)

Specified by:

safeDeleteObjects in interface CloudClient

bucketExists

public boolean bucketExists()

Specified by:

bucketExists in interface CloudClient