Class S3Source

java.lang.Object

dev.hardwood.s3.S3Source

All Implemented Interfaces:

Closeable, AutoCloseable

public final class S3Source
extends Object
implements Closeable

A configured connection to an S3-compatible object store.

Holds the region, endpoint, credentials, and HTTP client needed to create S3InputFile instances. Reuse a single S3Source across multiple files for connection pooling and credential reuse.

URL styles:

• Virtual-hosted (default): https://{bucket}.s3.{region}.amazonaws.com/{key}
• Path-style (opt-in via S3Source.Builder.pathStyle): {endpoint}/{bucket}/{key}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	S3Source.Builder	Builder for S3Source.

Method Summary

Modifier and Type	Method	Description
static S3Source.Builder	builder()	Creates a new S3Source.Builder.
void	close()
S3InputFile	inputFile(String uri)	Creates an S3InputFile from an s3://bucket/key URI.
S3InputFile	inputFile(String bucket, String key)	Creates an S3InputFile for the given bucket and key.
List<S3InputFile>	inputFiles(String... uris)	Creates S3InputFile instances from s3:// URIs (may span buckets).
List<S3InputFile>	inputFilesInBucket(String bucket, String... keys)	Creates S3InputFile instances for multiple keys in the same bucket.

Methods inherited from class Object

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

Method Details

inputFile

public S3InputFile inputFile(String bucket,
 String key)

Creates an S3InputFile for the given bucket and key. When the source is configured with RangeBacking.SPARSE_TEMPFILE, the returned file transparently caches fetched byte ranges in a mmap-backed sparse temp file; the cache is an internal implementation detail and does not change the returned type.

inputFile

public S3InputFile inputFile(String uri)

Creates an S3InputFile from an s3://bucket/key URI. See inputFile(String, String) for the RangeBacking policy.

inputFilesInBucket

public List<S3InputFile> inputFilesInBucket(String bucket,
 String... keys)

Creates S3InputFile instances for multiple keys in the same bucket.

inputFiles

public List<S3InputFile> inputFiles(String... uris)

Creates S3InputFile instances from s3:// URIs (may span buckets).

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

builder

public static S3Source.Builder builder()

Creates a new S3Source.Builder.