org.apache.hadoop.fs.s3a.impl

Interface ClientManager

All Superinterfaces:

AutoCloseable, Closeable, org.apache.hadoop.service.Service

All Known Subinterfaces:

S3AStore

All Known Implementing Classes:

ClientManagerImpl, S3AStoreImpl

public interface ClientManager
extends org.apache.hadoop.service.Service

Interface for on-demand/async creation of AWS clients and extension services.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Method Summary

Modifier and Type	Method and Description
software.amazon.awssdk.services.s3.S3AsyncClient	getOrCreateAsyncClient() Get the Async S3Client,raising a failure to create as an IOException.
software.amazon.awssdk.services.s3.S3Client	getOrCreateAsyncS3ClientUnchecked() Get the AsyncS3Client, raising a failure to create as an UncheckedIOException.
software.amazon.awssdk.services.s3.S3Client	getOrCreateS3Client() Get the S3Client, raising a failure to create as an IOException.
software.amazon.awssdk.services.s3.S3Client	getOrCreateS3ClientUnchecked() Get the S3Client, raising a failure to create as an UncheckedIOException.
software.amazon.awssdk.transfer.s3.S3TransferManager	getOrCreateTransferManager() Get the transfer manager, creating it and any dependencies if needed.
software.amazon.awssdk.services.s3.S3Client	getOrCreateUnencryptedS3Client() Get or create an unencrypted S3 client.

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Method Detail

getOrCreateTransferManager

software.amazon.awssdk.transfer.s3.S3TransferManager getOrCreateTransferManager()
                                                                         throws IOException

Get the transfer manager, creating it and any dependencies if needed.

Returns:

a transfer manager

Throws:

IOException - on any failure to create the manager

getOrCreateS3Client

software.amazon.awssdk.services.s3.S3Client getOrCreateS3Client()
                                                         throws IOException

Get the S3Client, raising a failure to create as an IOException.

Returns:

the S3 client

Throws:

IOException - failure to create the client.

getOrCreateS3ClientUnchecked

software.amazon.awssdk.services.s3.S3Client getOrCreateS3ClientUnchecked()
                                                                  throws UncheckedIOException

Get the S3Client, raising a failure to create as an UncheckedIOException.

Returns:

the S3 client

Throws:

UncheckedIOException - failure to create the client.

getOrCreateAsyncClient

software.amazon.awssdk.services.s3.S3AsyncClient getOrCreateAsyncClient()
                                                                 throws IOException

Get the Async S3Client,raising a failure to create as an IOException.

Returns:

the Async S3 client

Throws:

IOException - failure to create the client.

getOrCreateUnencryptedS3Client

software.amazon.awssdk.services.s3.S3Client getOrCreateUnencryptedS3Client()
                                                                    throws IOException

Get or create an unencrypted S3 client. This is used for unencrypted operations when CSE is enabled with V1 compatibility.

Returns:

unencrypted S3 client

Throws:

IOException - on any failure

getOrCreateAsyncS3ClientUnchecked

software.amazon.awssdk.services.s3.S3Client getOrCreateAsyncS3ClientUnchecked()
                                                                       throws UncheckedIOException

Get the AsyncS3Client, raising a failure to create as an UncheckedIOException.

Returns:

the S3 client

Throws:

UncheckedIOException - failure to create the client.