| Modifier and Type | Class and Description |
|---|---|
class |
IBMInternalFlag |
| Modifier and Type | Method and Description |
|---|---|
AwsBasicCredentials.Builder |
AwsBasicCredentials.Builder.validateCredentials(Boolean validateCredentials)
Whether this class should verify that accessKeyId and secretAccessKey are not null.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CredentialSourceType |
class |
LazyAwsCredentialsProvider
A wrapper for
AwsCredentialsProvider that defers creation of the underlying provider until the first time the
AwsCredentialsProvider.resolveCredentials() method is invoked. |
class |
ProfileCredentialsUtils
Utility class to load
ProfileCredentialsUtils.credentialsProvider() configured in a profile. |
class |
SystemSettingsCredentialsProvider
Loads credentials providers from the
//SdkSystemSetting#AWS_ACCESS_KEY_ID,
//SdkSystemSetting#AWS_SECRET_ACCESS_KEY, and //SdkSystemSetting#AWS_SESSION_TOKEN system settings. |
class |
WebIdentityCredentialsUtils
Utility class used to configure credential providers based on JWT web identity tokens.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractAws4Signer<T extends Aws4SignerParams,U extends Aws4PresignerParams>
Abstract base class for the AWS SigV4 signer implementations.
|
class |
AbstractAwsS3V4Signer
AWS4 signer implementation for AWS S3
|
class |
AbstractAwsSigner
Abstract base class for AWS signing protocol implementations.
|
class |
Aws4SignerRequestParams
Parameters that are used for computing a AWS 4 signature for a request.
|
class |
Aws4SignerUtils
Utility methods that is used by the different AWS Signer implementations.
|
class |
BaseAws4Signer
Deprecated.
|
class |
ContentChecksum
Encapsulates Hash in String format and FlexibleChecksum Instance for a Request Content.
|
class |
FifoCache<T>
A bounded cache that has a FIFO eviction policy when the cache is full.
|
class |
SignerConstant |
class |
SignerKey
Holds the signing key and the number of days since epoch for the date for
which the signing key was generated.
|
class |
SigningAlgorithm |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsChunkSigner
Represents a signer for a chunk of data, that returns a new signature based on the data and the
previous signature.
|
class |
AwsS3V4ChunkSigner
An implementation of AwsChunkSigner that can calculate a Sigv4 compatible chunk
signature.
|
class |
AwsSignedChunkedEncodingInputStream
A wrapper of InputStream that implements chunked encoding.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HeaderTransformsHelper
Helper class for transforming headers required during signing of headers.
|
class |
SignerMethodResolver |
| Modifier and Type | Class and Description |
|---|---|
class |
LazyTokenProvider
A wrapper for
SdkTokenProvider that defers creation of the underlying provider until the first time the
SdkTokenProvider.resolveToken() method is invoked. |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCrt4aSigningAdapter
This class mirrors the publicly available API of the AwsSigner class in CRT.
|
class |
CrtHttpRequestConverter |
class |
DefaultAwsCrtS3V4aSigner |
class |
DefaultAwsCrtV4aSigner |
class |
SdkSigningResult |
class |
SigningConfigProvider |
class |
SigningUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsS3V4aChunkSigner
An implementation of AwsChunkSigner that can calculate a Sigv4a compatible chunk signature.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultsModeConfiguration
Contains a collection of default configuration options for each DefaultsMode
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsErrorCode
Contains AWS error codes.
|
class |
AwsExecutionContextBuilder |
class |
AwsStatusCode
Contains AWS-specific meanings behind status codes.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Sigv4aSigningRegionSetProvider |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthorizationStrategy
Deprecated.
This is only used for compatibility with pre-SRA authorization logic. After we are comfortable that the new code
paths are working, we should migrate old clients to the new code paths (where possible) and delete this code.
|
class |
AuthorizationStrategyFactory
Deprecated.
This is only used for compatibility with pre-SRA authorization logic. After we are comfortable that the new code
paths are working, we should migrate old clients to the new code paths (where possible) and delete this code.
|
class |
AwsCredentialsAuthorizationStrategy
Deprecated.
This is only used for compatibility with pre-SRA authorization logic. After we are comfortable that the new code
paths are working, we should migrate old clients to the new code paths (where possible) and delete this code.
|
class |
TokenAuthorizationStrategy
Deprecated.
This is only used for compatibility with pre-SRA authorization logic. After we are comfortable that the new code
paths are working, we should migrate old clients to the new code paths (where possible) and delete this code.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsClientOptionValidation
A set of static methods used to validate that a
SdkClientConfiguration contains all of
the values required for the AWS client handlers to function. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultsModeResolver
Allows customizing the variables used during determination of a
DefaultsMode. |
| Modifier and Type | Class and Description |
|---|---|
class |
TracingSystemSetting
Tracing specific System Setting.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CachedTokenRefresher<TokenT extends SdkToken>
Class to cache Tokens which are supplied by the Suppliers while constructing this class.
|
interface |
TokenManager<T extends SdkToken>
An object that knows how to load and optionally, store, an SSO token.
|
interface |
TokenRefresher<T extends SdkToken>
Interface to refresh token.
|
interface |
TokenTransformer<T extends SdkToken,R extends AwsResponse>
Transformer to convert the response received from service to respective Token objects.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BaseCrcChecksum
Base class for CRC related checksums
|
class |
ConstructorCache
A cache that stores classes and their constructors by class name and class loader.
|
class |
Crc32Checksum |
class |
Crc64NvmeChecksum
Implementation of
SdkChecksum to calculate an CRC64NVME checksum. |
class |
CrcChecksumProvider
Utility class providing implementations of CRC checksums, specifically CRC32C and CRC64NVME.
|
class |
CrcCloneOnMarkChecksum
Class that provides functionality for combining CRC checksums with mark and reset capabilities.
|
class |
CrcCombineChecksumUtil
Utility class that provides methods for combining CRC checksums using Galois Field arithmetic.
|
interface |
CrcCombineFunction
Functional interface for combining two CRC values along with the data length.
|
class |
CrcCombineOnMarkChecksum
Class that provides functionality for combining CRC checksums with mark and reset capabilities.
|
class |
DigestAlgorithm |
class |
DigestAlgorithmChecksum
An implementation of
SdkChecksum that uses a DigestAlgorithm. |
class |
SdkCrc32CChecksum |
class |
SdkCrc32Checksum |
| Modifier and Type | Class and Description |
|---|---|
class |
HttpChecksumConstant
Defines all the constants that are used while adding and validating Http checksum for an operation.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
AsyncRequestBodyListener.NotifyingAsyncRequestBody |
static class |
AsyncResponseTransformerListener.NotifyingAsyncResponseTransformer<ResponseT,ResultT> |
static class |
PublisherListener.NoOpPublisherListener |
static class |
PublisherListener.NotifyingPublisher<T> |
static class |
SubscriberListener.NotifyingSubscriber<T> |
| Modifier and Type | Class and Description |
|---|---|
class |
Crc32CChecksum
Deprecated.
this class is deprecated and subject to removal.
|
class |
Crc32Checksum
Deprecated.
this class is deprecated and subject to removal.
|
class |
Md5Checksum
Deprecated.
this class is deprecated and subject to removal.
|
class |
Sha1Checksum
Deprecated.
this class is deprecated and subject to removal.
|
class |
Sha256Checksum
Deprecated.
this class is deprecated and subject to removal.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BooleanDocument
Represents a Boolean Document.
|
class |
ListDocument |
class |
MapDocument |
class |
NullDocument |
class |
NumberDocument |
class |
StringDocument |
| Modifier and Type | Interface and Description |
|---|---|
interface |
EndpointDiscoveryProvider |
class |
ProfileEndpointDiscoveryProvider |
| Modifier and Type | Class and Description |
|---|---|
class |
InternalCoreExecutionAttribute
Attributes that can be applied to all sdk requests.
|
class |
SdkInternalTestAdvancedClientOption<T>
Options of
SdkAdvancedClientOption that must not be used outside of tests that are stored in this project. |
class |
StaticClientEndpointProvider
An implementation of
ClientEndpointProvider that uses static values. |
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncStreamPrepender<T> |
class |
ByteArrayAsyncResponseTransformer<ResponseT>
Implementation of
AsyncResponseTransformer that dumps content into a byte array and supports further
conversions into types, like strings. |
class |
ByteBuffersAsyncRequestBody
An implementation of
AsyncRequestBody for providing data from the supplied ByteBuffer array. |
class |
ChecksumCalculatingAsyncRequestBody
Wrapper class to wrap an AsyncRequestBody.
|
class |
ChecksumValidatingPublisher
Publisher to update the checksum as it reads the data and
finally compares the computed checksum with expected Checksum.
|
class |
ChunkBuffer
Class that will buffer incoming BufferBytes to chunks of bufferSize.
|
class |
CompressionAsyncRequestBody
Wrapper class to wrap an AsyncRequestBody.
|
class |
DefaultAsyncResponseTransformerSplitResult<ResponseT,ResultT> |
class |
EnvelopeWrappedSdkPublisher<T>
Publisher implementation that wraps the content of another publisher in an envelope with an optional prefix (or
header) and suffix (or footer).
|
class |
FileAsyncRequestBody
Implementation of
AsyncRequestBody that reads data from a file. |
class |
FileAsyncRequestBodySplitHelper
A helper class to split a
FileAsyncRequestBody to multiple smaller async request bodies. |
class |
FileAsyncResponseTransformer<ResponseT>
AsyncResponseTransformer that writes the data to the specified file. |
class |
InputStreamResponseTransformer<ResponseT extends SdkResponse>
A
AsyncResponseTransformer that allows performing blocking reads on the response data. |
class |
InputStreamWithExecutorAsyncRequestBody
A
AsyncRequestBody that allows reading data off of an InputStream using a background
ExecutorService. |
class |
PublisherAsyncResponseTransformer<ResponseT extends SdkResponse>
|
class |
SdkPublishers
Common implementations of
SdkPublisher that are provided for convenience when building asynchronous
interceptors to be used with specific clients. |
class |
SplittingPublisher
Splits an
AsyncRequestBody to multiple smaller AsyncRequestBodys, each of which publishes a specific portion of
the original data. |
class |
SplittingTransformer<ResponseT,ResultT>
Split a
AsyncResponseTransformer into multiple ones, publishing them as a SdkPublisher. |
| Modifier and Type | Class and Description |
|---|---|
class |
TokenBucket
A lock-free implementation of a token bucket.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CrtBasedChecksumProvider
Class to load the Crt based checksum from aws-crt-java library if it is present in class path.
|
class |
SdkCrc32 |
class |
SdkCrc32C |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsChunkedEncodingConfig |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Compressor
Interface for compressors used by
CompressRequestStage to compress requests. |
class |
CompressorType
The supported compression algorithms for operations with the requestCompression trait.
|
class |
GzipCompressor |
| Modifier and Type | Class and Description |
|---|---|
class |
BaseAsyncClientHandler |
class |
BaseClientHandler |
class |
BaseSyncClientHandler |
| Modifier and Type | Class and Description |
|---|---|
class |
AmazonAsyncHttpClient |
class |
AmazonSyncHttpClient |
class |
CombinedResponseHandler<OutputT>
Unmarshalls an HTTP response into either a successful response POJO, or into a (possibly modeled) exception based
on the status code of the HTTP response.
|
class |
HttpClientDependencies
Client scoped dependencies of
AmazonSyncHttpClient and AmazonAsyncHttpClient. |
class |
IdempotentAsyncResponseHandler<T,R>
Wrapper for a
TransformingAsyncResponseHandler that allows attachment to an external scope and given a way
of evaluating whether that scope has changed or not will only allow prepare() to be called on its delegate once
per state change and will cache and reserve the future that is returned by the delegate the rest of the time. |
class |
InterruptMonitor
A set of utilities for monitoring the status of the currently-executing SDK thread.
|
class |
RequestExecutionContext
Request scoped dependencies and context for an execution of a request by
AmazonSyncHttpClient or
AmazonAsyncHttpClient. |
class |
SdkClientTime
Used for clock skew adjustment between the client JVM where the SDK is run, and the server side.
|
class |
StreamManagingStage<OutputT>
Adds additional wrapping around the request
ContentStreamProvider. |
interface |
TransformingAsyncResponseHandler<ResultT>
A response handler that returns a transformed response.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncAfterTransmissionInterceptorCallingResponseHandler<T>
Async response handler decorator to run interceptors after response is received.
|
class |
AsyncResponseHandler<T>
Response handler for asynchronous non-streaming operations.
|
class |
AsyncStreamingResponseHandler<OutputT extends SdkResponse,ReturnT>
Response handler for asynchronous streaming operations.
|
class |
CombinedResponseAsyncHttpResponseHandler<OutputT>
Detects whether the response succeeded or failed by just checking the HTTP status and delegates to appropriate
async response handler.
|
class |
FilterTransformingAsyncHttpResponseHandler<ResultT>
Decorator class that simply delegates to the wrapped
TransformingAsyncResponseHandler. |
class |
SimpleHttpContentPublisher
Implementation of
SdkHttpContentPublisher that provides all it's data at once. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultSdkAsyncHttpClientBuilder
Utility to load the default HTTP client factory and create an instance of
SdkHttpClient. |
class |
DefaultSdkHttpClientBuilder
Utility to load the default HTTP client factory and create an instance of
SdkHttpClient. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MutableRequestToRequestPipeline
Pipeline stage that takes in a mutable
SdkHttpFullRequest.Builder and returns the same builder. |
interface |
RequestPipeline<InputT,OutputT>
Represents a series of transformations when executing a SDK request.
|
class |
RequestPipelineBuilder<InputT,OutputT>
Builder for a
RequestPipeline. |
interface |
RequestToRequestPipeline
Pipeline stage that is a transformation on an immutable
SdkHttpFullRequest. |
interface |
RequestToResponsePipeline<OutputT> |
| Modifier and Type | Class and Description |
|---|---|
class |
AfterExecutionInterceptorsStage<OutputT> |
class |
AfterTransmissionExecutionInterceptorsStage |
class |
ApiCallAttemptMetricCollectionStage<OutputT>
Wrapper pipeline that initializes and tracks the API call attempt metric collection.
|
class |
ApiCallAttemptTimeoutTrackingStage<OutputT>
Wrapper around a
RequestPipeline to manage the api call attempt timeout feature. |
class |
ApiCallMetricCollectionStage<OutputT>
Wrapper pipeline that tracks the
CoreMetric.API_CALL_DURATION metric. |
class |
ApiCallTimeoutTrackingStage<OutputT>
Wrapper around a
RequestPipeline to manage the api call timeout feature. |
class |
ApplyTransactionIdStage
Generates a unique identifier for the request that is consistent across retries.
|
class |
ApplyUserAgentStage
A stage for adding the user agent header to the request, after retrieving the current string
from execution attributes and adding any additional information.
|
class |
AsyncApiCallAttemptMetricCollectionStage<OutputT>
Wrapper pipeline that initializes and tracks the API call attempt metric collection.
|
class |
AsyncApiCallMetricCollectionStage<OutputT>
Wrapper pipeline that tracks the
CoreMetric.API_CALL_DURATION metric. |
class |
AsyncApiCallTimeoutTrackingStage<OutputT> |
class |
AsyncBeforeTransmissionExecutionInterceptorsStage |
class |
AsyncExecutionFailureExceptionReportingStage<OutputT> |
class |
AsyncRetryableStage<OutputT>
Wrapper around the pipeline for a single request to provide retry, clockskew and request throttling functionality.
|
class |
AsyncSigningStage |
class |
BeforeTransmissionExecutionInterceptorsStage |
class |
BeforeUnmarshallingExecutionInterceptorsStage
Invoke the
ExecutionInterceptor.beforeUnmarshalling(com.ibm.cos.v2.core.interceptor.Context.BeforeUnmarshalling, com.ibm.cos.v2.core.interceptor.ExecutionAttributes) callback to allow for pre-processing on the SdkHttpResponse
before it is handed off to the unmarshaller. |
class |
CompressRequestStage
Compress requests whose operations are marked with the "requestCompression" C2J trait.
|
class |
ExecutionFailureExceptionReportingStage<OutputT> |
class |
HandleResponseStage<OutputT>
Pipeline stage that executes an
HttpResponseHandler to transform the response into a Response
object that contains a flag indicating success of failure and an unmarshalled response object or exception as
appropriate. |
class |
HttpChecksumStage
Stage to implement the "httpChecksum" and "httpChecksumRequired" C2J traits, and flexible checksums.
|
class |
MakeAsyncHttpRequestStage<OutputT>
Delegate to the HTTP implementation to make an HTTP request and receive the response.
|
class |
MakeHttpRequestStage
Delegate to the HTTP implementation to make an HTTP request and receive the response.
|
class |
MakeRequestImmutableStage |
class |
MakeRequestMutableStage |
class |
MergeCustomHeadersStage
Merge customer supplied headers into the marshalled request.
|
class |
MergeCustomQueryParamsStage
Merge customer supplied query params into the marshalled request.
|
class |
QueryParametersToBodyStage
Modifies an HTTP request by moving query parameters to the body under the following conditions:
- It is a POST request
- There is no content stream provider
- There are query parameters to transfer
|
class |
RetryableStage<OutputT>
Wrapper around the pipeline for a single request to provide retry, clock-skew and request throttling functionality.
|
class |
SigningStage
Sign the marshalled request (if applicable).
|
class |
TimeoutExceptionHandlingStage<OutputT>
Check if an
Exception is caused by either ApiCallTimeout or ApiAttemptTimeout and translate that
exception to a more appropriate timeout related exception so that it can be handled in other stages. |
class |
UnwrapResponseContainer<OutputT>
Unwrap a
Response container to just the POJO result. |
| Modifier and Type | Class and Description |
|---|---|
class |
ExceptionReportingUtils |
class |
RetryableStageHelper
Contains the logic shared by
RetryableStage and AsyncRetryableStage when querying and interacting with a
RetryStrategy. |
| Modifier and Type | Class and Description |
|---|---|
class |
ApiCallTimeoutTracker
Api Call Timeout Tracker to track the
TimeoutTask and the ScheduledFuture. |
class |
AsyncTimeoutTask
Implementation of
TimeoutTask for asynchronous operations to be scheduled to fail
the CompletableFuture and abort the asynchronous requests. |
class |
NoOpTimeoutTracker
A no op implementation of
TimeoutTracker. |
class |
SyncTimeoutTask
TimeoutTask to be scheduled for synchronous operations. |
interface |
TimeoutTask |
interface |
TimeoutTracker
Tracker task to track the
TimeoutTask and the ScheduledFuture that
schedules the timeout task. |
class |
TimerUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultFailedExecutionContext
An SDK-internal implementation of
Context.FailedExecution. |
class |
HttpChecksumValidationInterceptor
Interceptor to intercepts Sync and Async responses.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsChunkedEncodingInputStream
A wrapper of InputStream that implements pseudo-chunked-encoding.
|
class |
AwsChunkedInputStream
A wrapper of InputStream that implements streaming in chunks.
|
class |
AwsCompressionInputStream
A wrapper class of InputStream that implements compression in chunks.
|
class |
AwsUnsignedChunkedEncodingInputStream
A wrapper class of InputStream that implements chunked-encoding.
|
class |
ChecksumValidatingInputStream
Stream that will update the Checksum as the data is read.
|
interface |
Releasable
Used for releasing a resource.
|
class |
SdkLengthAwareInputStream
An
InputStream that is aware of its length. |
| Modifier and Type | Class and Description |
|---|---|
class |
BytesReadTrackingInputStream |
class |
BytesReadTrackingPublisher
Publisher that tracks how many bytes are published from the wrapped publisher to the downstream subscriber.
|
class |
SdkErrorType
General categories of errors that can be encountered when making an API call attempt.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ItemsSubscription<ResponseT,ItemT>
An implementation of the
Subscription interface that can be used to signal and cancel demand for
paginated items across pages |
| Modifier and Type | Class and Description |
|---|---|
class |
ClockSkewAdjuster
Suggests a clock skew adjustment that should be applied to future requests.
|
class |
DefaultTokenBucketExceptionCostFunction |
class |
RateLimitingTokenBucket |
class |
RetryPolicyAdapter
Implements the
RetryStrategy interface by wrapping a RetryPolicy instance. |
class |
SdkDefaultRetrySetting |
| Modifier and Type | Class and Description |
|---|---|
class |
SigningMethod |
| Modifier and Type | Class and Description |
|---|---|
class |
BufferingContentStreamProvider
ContentStreamProvider implementation that buffers the data stream data to memory as it's read. |
class |
CompressionContentStreamProvider
ContentStreamProvider implementation for compression. |
class |
FileContentStreamProvider
ContentStreamProvider implementation for files. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractStreamingRequestMarshaller<T> |
| Modifier and Type | Class and Description |
|---|---|
class |
AppIdResolver |
class |
BusinessMetricsUtils |
class |
IdentityProviderNameMapping
A enum class representing a short form of identity providers to record in the UA string.
|
class |
UserAgentLangValues |
| Modifier and Type | Class and Description |
|---|---|
class |
CapacityManager
Manages capacity of a finite resource.
|
class |
ChunkContentUtils |
class |
Crc32ChecksumCalculatingInputStream
Simple InputStream wrapper that examines the wrapped stream's contents as
they are read and calculates and CRC32 checksum.
|
class |
Crc32ChecksumValidatingInputStream
Wraps the provided input stream with a
Crc32ChecksumCalculatingInputStream and after the stream is closed
will validate the calculated checksum against the actual checksum. |
class |
FakeIoException
Used for simulating an IOException for test purposes.
|
class |
HttpChecksumResolver
Class to resolve the different Checksums specs from ExecutionAttributes.
|
class |
HttpChecksumUtils |
class |
Mimetype
Utility class that maintains a listing of known Mimetypes, and determines the
mimetype of files based on file extensions.
|
class |
NoopSubscription
An implementation of
Subscription that does nothing. |
class |
ThrowableUtils
Utility for use with errors or exceptions.
|
class |
UnreliableFilterInputStream
An internal class used solely for the purpose of testing via failure
injection.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncWaiterExecutor<T>
Executes async waiter operations
|
class |
DefaultAsyncWaiter<T>
Default implementation of the generic
AsyncWaiter. |
class |
DefaultWaiter<T>
Default implementation of the generic
Waiter. |
class |
DefaultWaiterResponse<T>
The default implementation of the
WaiterResponse |
class |
LegacyToNonLegacyAdapter |
class |
NonLegacyToLegacyAdapter |
class |
WaiterConfiguration
Internal waiter configuration class that provides default values if not overridden.
|
class |
WaiterExecutor<T>
Executes sync waiter operations
|
class |
WaiterExecutorHelper<T>
The waiter executor helper class.
|
| Constructor and Description |
|---|
RequestBody(ContentStreamProvider contentStreamProvider,
Long contentLength,
String contentType) |
| Modifier and Type | Class and Description |
|---|---|
static class |
SdkRequestContext.Builder
Builder for a
SdkRequestContext. |
| Modifier and Type | Method and Description |
|---|---|
static SdkRequestContext.Builder |
SdkRequestContext.builder() |
| Modifier and Type | Class and Description |
|---|---|
class |
ApacheHttpRequestConfig
Configuration needed when building an Apache request.
|
class |
DefaultConfiguration
Default configuration values.
|
class |
RepeatableInputStreamRequestEntity
Custom implementation of
HttpEntity that delegates to an
InputStreamEntity, with the one notable difference, that if
the underlying InputStream supports being reset, this RequestEntity will
report that it is repeatable and will reset the stream on all subsequent
attempts to write out the request. |
class |
SdkProxyRoutePlanner
SdkProxyRoutePlanner delegates a Proxy Route Planner from the settings instead of the
system properties.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClientConnectionManagerFactory |
class |
ClientConnectionRequestFactory |
class |
IdleConnectionReaper
Manages the reaping of idle connections.
|
class |
SdkConnectionKeepAliveStrategy
The AWS SDK for Java's implementation of the
ConnectionKeepAliveStrategy interface. |
class |
SdkTlsSocketFactory |
interface |
Wrapped
An internal marker interface to defend against accidental recursive wrappings.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ApacheHttpRequestFactory
Responsible for creating Apache HttpClient 4 request objects.
|
class |
ApacheSdkHttpClient
An instance of
ConnectionManagerAwareHttpClient that delegates all the requests to the given http client. |
interface |
ConnectionManagerAwareHttpClient
An extension of Apache's HttpClient that expose the connection manager
associated with the client.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DelegateSocket
Socket delegate class.
|
class |
DelegateSslSocket |
class |
InputShutdownCheckingSslSocket
Wrapper socket that ensures the read end of the socket is still open before performing a
write(). |
class |
SdkSocket |
class |
SdkSslSocket |
| Modifier and Type | Class and Description |
|---|---|
class |
ApacheUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
CrtInputStream |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsChunkedV4aPayloadSigner
An implementation of a V4aPayloadSigner which chunk-encodes a payload, optionally adding a chunk-signature chunk-extension,
and/or trailers representing trailing headers with their signature at the end.
|
class |
DefaultAwsCrtV4aHttpSigner
An implementation of a
AwsV4aHttpSigner that uses properties to compose v4a-signers in order to delegate signing of a
request and payload (if applicable) accordingly. |
class |
DefaultV4aPayloadSigner
A default implementation of a payload signer that is a no-op.
|
class |
RollingSigner
A class which calculates a rolling signature of arbitrary data using HMAC-SHA256.
|
class |
SigV4aChunkExtensionProvider |
class |
SigV4aTrailerProvider |
interface |
V4aPayloadSigner
An interface for defining how to sign a payload via SigV4a.
|
class |
V4aProperties
A class which contains "properties" relevant to SigV4a.
|
class |
V4aRequestSigningResult
A container for data produced during and as a result of the SigV4a request signing with CRT.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CrtHttpRequestConverter |
class |
CrtUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
SigV4DataFramePublisher
A publisher which adapts a publisher by SigV4-signing each frame, and appends an empty trailing frame.
|
class |
TrailingDataFramePublisher
A publisher which wraps a publisher and appends a trailing frame once the wrapped publisher is finished.
|
| Modifier and Type | Class and Description |
|---|---|
class |
EventStreamV4PayloadSigner
An implementation which supports async signing of event-stream payloads.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAwsV4AuthScheme
A default implementation of
AwsV4AuthScheme. |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsChunkedV4PayloadSigner
An implementation of a V4PayloadSigner which chunk-encodes a payload, optionally adding a chunk-signature chunk-extension,
and/or trailers representing trailing headers with their signature at the end.
|
interface |
Checksummer
An interface for defining how a checksum is formed from a payload synchronously and asynchronously.
|
class |
CredentialScope |
class |
DefaultAwsV4HttpSigner
An implementation of a
AwsV4HttpSigner that uses properties to compose v4-signers in order to delegate signing of a
request and payload (if applicable) accordingly. |
class |
DefaultIBMOAuthIAMHttpSigner
An implementation of a
IBMOAuthSigner that uses properties to compose IAM-signers in order to delegate signing of a
request and payload (if applicable) accordingly. |
class |
DefaultV4PayloadSigner
A default implementation of a payload signer that is a no-op, since payloads are most commonly unsigned.
|
class |
DefaultV4RequestSigner
The default implementation of a v4-request-signer.
|
class |
FlexibleChecksummer
A "flexible" implementation of a checksummer.
|
class |
PrecomputedSha256Checksummer
An implementation of a checksummer that simply passes along a computed value as a checksum.
|
class |
RollingSigner
A class which calculates a rolling signature of arbitrary data using HMAC-SHA256.
|
class |
V4CanonicalRequest
A class that represents a canonical request in AWS, as documented:
|
interface |
V4PayloadSigner
An interface for defining how to sign a payload via SigV4.
|
class |
V4Properties
A class which contains "properties" relevant to SigV4.
|
interface |
V4RequestSigner
An interface which declares an algorithm that takes a request and a content-hash and signs the request according to the SigV4
process.
|
class |
V4RequestSigningResult
A container for data produced during and as a result of the SigV4 request signing process.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConstantChecksum
Implementation of
SdkChecksum to provide a constant checksum. |
| Modifier and Type | Class and Description |
|---|---|
class |
ChecksumTrailerProvider |
interface |
Chunk
An interface which defines a "chunk" of data.
|
class |
ChunkedEncodedInputStream
An implementation of chunk-transfer encoding, but by wrapping an
InputStream. |
interface |
ChunkExtensionProvider
A functional interface for defining an extension of a chunk, where the extension is a key-value pair.
|
interface |
ChunkHeaderProvider
A functional interface for defining a header of a chunk.
|
class |
ChunkInputStream
A wrapped stream to represent a "chunk" of data
|
interface |
Resettable |
class |
SigV4ChunkExtensionProvider |
class |
SigV4TrailerProvider |
interface |
TrailerProvider
A functional interface for defining a trailer, where the trailer is a header pair.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ChecksumInputStream
An input-stream that takes a collection of checksums, and updates each checksum when it reads data.
|
class |
ChecksumSubscriber
A subscriber that takes a collection of checksums, and updates each checksum when it receives data.
|
class |
InMemoryPublisher
Temporarily used for buffering all data into memory.
|
interface |
Releasable
Used for releasing a resource.
|
class |
ResettableContentStreamProvider |
class |
SdkLengthAwareInputStream
An
InputStream that is aware of its length. |
| Modifier and Type | Class and Description |
|---|---|
class |
ChecksumUtil |
class |
CredentialUtils |
class |
FifoCache<T>
A bounded cache that has a FIFO eviction policy when the cache is full.
|
class |
OptionalDependencyLoaderUtil
Utilities for loading of classes and objects which have optional dependencies, and therefore need to be safely checked at
runtime in order to use.
|
class |
SignerConstant |
class |
SignerKey
Holds the signing key and the number of days since epoch for the date for which the signing key was generated.
|
class |
SignerUtils
Utility methods to be used by various AWS Signer implementations.
|
class |
SigningAlgorithm |
| Modifier and Type | Interface and Description |
|---|---|
interface |
IBMOAuthSigner |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultBearerAuthScheme
A default implementation of
BearerAuthScheme. |
class |
DefaultNoAuthAuthScheme
A default implementation of
NoAuthAuthScheme. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultBearerHttpSigner
A default implementation of
BearerHttpSigner. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAuthSchemeOption |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAsyncSignedRequest |
static class |
DefaultAsyncSignedRequest.BuilderImpl |
class |
DefaultAsyncSignRequest<IdentityT extends Identity> |
static class |
DefaultAsyncSignRequest.BuilderImpl<IdentityT extends Identity> |
class |
DefaultSignedRequest |
static class |
DefaultSignedRequest.BuilderImpl |
class |
DefaultSignRequest<IdentityT extends Identity> |
static class |
DefaultSignRequest.BuilderImpl<IdentityT extends Identity> |
class |
NoOpHttpSigner<T extends Identity> |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCrtClientBuilderBase<BuilderT> |
class |
AwsCrtConfigurationUtils |
class |
CrtAsyncRequestContext |
class |
CrtAsyncRequestExecutor |
class |
CrtRequestContext |
class |
CrtRequestExecutor |
class |
CrtUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
CrtRequestAdapter |
| Modifier and Type | Class and Description |
|---|---|
class |
CrtResponseAdapter
Response handler adaptor for
AwsCrtAsyncHttpClient. |
class |
InputStreamAdaptingHttpStreamResponseHandler
Response handler adaptor for
AwsCrtHttpClient. |
class |
ResponseHandlerHelper
This is the helper class that contains common logic shared between
CrtResponseAdapter and
InputStreamAdaptingHttpStreamResponseHandler. |
| Modifier and Type | Class and Description |
|---|---|
class |
AutoReadDisableChannelPoolListener
Disables auto read on in-use channels to allow upper layers to take care of flow control.
|
class |
AutoReadEnableChannelPoolListener
Enables auto read on idle channels so that any data that a service sends while it's idling can be handled.
|
class |
AwaitCloseChannelPoolMap
Implementation of
SdkChannelPoolMap that awaits channel pools to be closed upon closing. |
class |
BetterSimpleChannelPool
Extension of
SimpleChannelPool to add an asynchronous close method |
class |
BootstrapProvider
The primary purpose of this Bootstrap provider is to ensure that all Bootstraps created by it are 'unresolved'
InetSocketAddress.
|
class |
CancellableAcquireChannelPool
Simple decorator
ChannelPool that attempts to complete the promise
given to CancellableAcquireChannelPool.acquire(Promise) with the channel acquired from the underlying
pool. |
class |
ChannelAttributeKey
Keys for attributes attached via
AttributeMap.attr(AttributeKey). |
class |
ChannelDiagnostics
Diagnostic information that may be useful to help with debugging during error scenarios.
|
class |
ChannelPipelineInitializer
ChannelPoolHandler to configure the client pipeline.
|
class |
DelegatingEventLoopGroup
EventLoopGroup that just delegates to another EventLoopGroup. |
class |
FutureCancelHandler
Closes the channel if the execution future has been cancelled.
|
class |
HandlerRemovingChannelPoolListener
Removes any per-request
ChannelHandler from the pipeline when releasing it to the pool. |
class |
HealthCheckedChannelPool
An implementation of
ChannelPool that validates the health of its connections. |
class |
HonorCloseOnReleaseChannelPool
Wrap a channel pool so that
ChannelAttributeKey.CLOSE_ON_RELEASE is honored when a channel is released to the
underlying pool. |
class |
Http1TunnelConnectionPool
Connection pool that knows how to establish a tunnel using the HTTP CONNECT method.
|
class |
IdleConnectionCountingChannelPool
A channel pool implementation that tracks the number of "idle" channels in an underlying channel pool.
|
class |
IdleConnectionReaperHandler
A handler that closes unused channels that have not had any traffic on them for a configurable amount of time.
|
class |
InUseTrackingChannelPoolListener
Marks
Channels as in-use when they are leased from the pool. |
class |
ListenerInvokingChannelPool
A
SdkChannelPool that wraps and delegates to another SdkChannelPool while invoking ListenerInvokingChannelPool.ChannelPoolListeners
for important events that occur. |
static interface |
ListenerInvokingChannelPool.ChannelPoolListener
Listener which is called for various actions performed on a
SdkChannelPool. |
class |
NettyConfiguration
Internal object for configuring netty.
|
class |
NettyRequestExecutor |
class |
NettyRequestMetrics
Utilities for collecting and publishing request-level metrics.
|
class |
NonManagedEventLoopGroup
Decorator around
EventLoopGroup that prevents it from being shutdown. |
class |
OldConnectionReaperHandler
A handler that will close channels after they have reached their time-to-live, regardless of usage.
|
class |
OneTimeReadTimeoutHandler
A one-time read timeout handler that removes itself from the pipeline after
the next successful read.
|
class |
ProxyTunnelInitHandler
Handler that initializes the HTTP tunnel.
|
class |
ReleaseOnceChannelPool
Wrapper around a
ChannelPool to protect it from having the same channel released twice. |
class |
RequestAdapter |
class |
RequestContext |
class |
ResponseHandler |
class |
SdkChannelOptions |
interface |
SdkChannelPool
A
ChannelPool implementation that allows a caller to asynchronously retrieve channel-pool related metrics via
SdkChannelPool.collectChannelPoolMetrics(MetricCollector). |
class |
SdkChannelPoolMap<K,P extends io.netty.channel.pool.ChannelPool>
Replacement for
AbstractChannelPoolMap. |
class |
SharedSdkEventLoopGroup
Provides access and manages a shared
SdkEventLoopGroup. |
class |
SslCloseCompletionEventHandler
Handles
SslCloseCompletionEvents that are sent whenever an SSL channel
goes inactive. |
class |
SslContextProvider |
class |
StaticKeyManagerFactory
Factory that simply returns a statically provided set of
KeyManagers. |
class |
StaticKeyManagerFactorySpi
Factory SPI that simply returns a statically provided set of
KeyManagers. |
class |
StaticTrustManagerFactory |
class |
UnusedChannelExceptionHandler
A handler for exceptions occurring on channels not current in use (according to
ChannelAttributeKey.IN_USE). |
| Modifier and Type | Method and Description |
|---|---|
static SdkEventLoopGroup |
SharedSdkEventLoopGroup.get() |
| Modifier and Type | Class and Description |
|---|---|
class |
FlushOnReadHandler
This is an HTTP/2 related workaround for an issue where a WINDOW_UPDATE is
queued but not written to the socket, causing a read() on the channel to
hang if the remote endpoint thinks our inbound window is 0.
|
class |
GoAwayException
Exception thrown when a GOAWAY frame is sent by the service.
|
class |
Http2GoAwayEventListener
Handles
Http2GoAwayFrames sent on a connection. |
class |
Http2MultiplexedChannelPool
ChannelPool implementation that handles multiplexed streams. |
class |
Http2PingHandler
Attached to a
Channel to periodically check the health of HTTP2 connections via PING frames. |
class |
Http2ResetSendingSubscription
Wrapper around a
Subscription to send a RST_STREAM frame on cancel. |
class |
Http2SettingsFrameHandler
Configure channel based on the
Http2SettingsFrame received from server |
class |
Http2StreamExceptionHandler
Exception Handler for errors on the Http2 streams.
|
class |
Http2ToHttpInboundAdapter
Converts
Http2Frames to HttpObjects. |
class |
HttpOrHttp2ChannelPool
Channel pool that establishes an initial connection to determine protocol.
|
class |
HttpToHttp2OutboundAdapter
Translates HTTP/1.1 Netty objects to the corresponding HTTP/2 frame objects.
|
class |
MultiplexedChannelRecord
Contains a
Future for the actual socket channel and tracks available
streams based on the MAX_CONCURRENT_STREAMS setting for the connection. |
class |
PingFailedException |
class |
PingTracker
Tracking the status after sending out the PING frame
|
| Modifier and Type | Class and Description |
|---|---|
class |
CancelledSubscriber<T>
A cancelled subscriber.
|
class |
DefaultStreamedHttpRequest
A default streamed HTTP request.
|
class |
DefaultStreamedHttpResponse
A default streamed HTTP response.
|
class |
HandlerPublisher<T>
Publisher for a Netty Handler.
|
class |
HandlerSubscriber<T>
Subscriber that publishes received messages to the handler pipeline.
|
class |
HttpStreamsClientHandler
Handler that converts written
StreamedHttpRequest messages into HttpRequest messages
followed by HttpContent messages and reads HttpResponse messages followed by
HttpContent messages and produces StreamedHttpResponse messages. |
interface |
StreamedHttpMessage
Combines
HttpMessage and Publisher into one
message. |
interface |
StreamedHttpRequest
Combines
HttpRequest and StreamedHttpMessage into one
message. |
interface |
StreamedHttpResponse
Combines
HttpResponse and StreamedHttpMessage into one
message. |
| Modifier and Type | Class and Description |
|---|---|
class |
ChannelResolver |
class |
ChannelUtils |
class |
DelegatingChannelHandlerContext
An abstract implementation of
ChannelHandlerContext that delegates to another
context for non-overridden methods. |
class |
ExceptionHandlingUtils |
class |
NettyClientLogger
Logger facade similar to
Logger, that also includes channel information in the message
when provided. |
class |
NettyUtils |
class |
OrderedWriteChannelHandlerContext
An implementation of
ChannelHandlerContext that ensures all writes are performed in the order they are invoked. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAwsCredentialsIdentity |
class |
DefaultAwsSessionCredentialsIdentity |
class |
DefaultIdentityProviders
A default implementation of
IdentityProviders. |
class |
DefaultResolveIdentityRequest |
static class |
DefaultResolveIdentityRequest.BuilderImpl |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractFileStoreTlsKeyManagersProvider
Abstract
TlsKeyManagersProvider that loads the key store from a
a given file path. |
class |
LowCopyListMap
A
Map<String, List<String>> for headers and query strings in SdkHttpRequest and SdkHttpResponse that
avoids copying data during conversion between builders and buildables, unless data is modified. |
class |
NoneTlsKeyManagersProvider
Simple implementation of
TlsKeyManagersProvider that return a null array. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultMetricCollection |
class |
DefaultMetricCollector |
class |
DefaultMetricRecord<T> |
class |
DefaultSdkMetric<T> |
class |
EmptyMetricCollection |
| Modifier and Type | Class and Description |
|---|---|
class |
ProfileFileReader
Converts an
InputStream to a configuration or credentials file into a map of profiles and their properties. |
class |
ProfileFileRefresher
Class used for caching and reloading ProfileFile objects from a Supplier.
|
class |
ProfileSection
Enum describing all the valid section names supported by SDK.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsStructuredCborFactory
Creates generators and protocol handlers for CBOR wire format.
|
class |
SdkCborGenerator
Thin wrapper around Jackson's JSON generator for CBOR.
|
class |
SdkStructuredCborFactory
Creates generators and protocol handlers for CBOR wire format.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsStructuredPlainJsonFactory
Creates generators and protocol handlers for plain text JSON wire format.
|
class |
MarshallerUtil |
interface |
ProtocolFact
Represents know static facts about each protocol.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentTypeJsonMarshaller |
class |
HeaderMarshaller |
interface |
JsonMarshaller<T>
Interface to marshall data according to the JSON protocol specification.
|
class |
JsonMarshallerContext
Dependencies needed by implementations of
JsonMarshaller. |
class |
JsonMarshallerRegistry
Marshaller registry for JSON based protocols.
|
class |
JsonProtocolMarshaller
Implementation of
ProtocolMarshaller for JSON based services. |
class |
JsonProtocolMarshallerBuilder
Builder to create an appropriate implementation of
ProtocolMarshaller for JSON based services. |
class |
NullAsEmptyBodyProtocolRequestMarshaller
AWS services expect an empty body when the payload member is null instead of an explicit JSON null.
|
class |
QueryParamMarshaller |
class |
SimpleTypeJsonMarshaller |
class |
SimpleTypePathMarshaller |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsJsonErrorMessageParser |
class |
AwsJsonProtocolErrorUnmarshaller
Unmarshaller for AWS specific error responses.
|
class |
AwsJsonResponseHandler<T> |
class |
DefaultJsonUnmarshallerRegistry
Registry of
JsonUnmarshaller implementations by location and type. |
class |
DefaultProtocolUnmarshallDependencies |
interface |
ErrorMessageParser |
class |
JsonErrorCodeParser |
class |
JsonProtocolUnmarshaller
Unmarshaller implementation for both JSON RPC and REST JSON services.
|
class |
JsonResponseHandler<T extends SdkPojo>
Default implementation of HttpResponseHandler that handles a successful response from a
service and unmarshalls the result using a JSON unmarshaller.
|
interface |
JsonUnmarshaller<T>
Interface for unmarshalling a field from a JSON based service.
|
class |
JsonUnmarshallerContext
Dependencies needed by implementations of
JsonUnmarshaller. |
interface |
JsonUnmarshallerRegistry
Registry of
JsonUnmarshaller implementations by location and type. |
interface |
ProtocolUnmarshallDependencies |
class |
SdkClientJsonProtocolAdvancedOption<T> |
class |
SdkJsonErrorMessageParser |
interface |
UnmarshallerRegistryFactory
Interface used to create an
UnmarshallerRegistryFactory that will unmarshall using the given default formats for each
of the locations in the formats map. |
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentUnmarshaller |
| Modifier and Type | Class and Description |
|---|---|
class |
ArrayJsonNode
An array
JsonNode. |
class |
BooleanJsonNode
A boolean
JsonNode. |
class |
EmbeddedObjectJsonNode
An embedded object
JsonNode. |
class |
NumberJsonNode
A numeric
JsonNode. |
class |
ObjectJsonNode
An object
JsonNode. |
class |
StringJsonNode
A string
JsonNode. |
| Modifier and Type | Class and Description |
|---|---|
class |
ListQueryMarshaller
Marshaller for list types.
|
class |
MapQueryMarshaller |
interface |
QueryMarshaller<T>
Interface for marshallers for AWS/Query protocol.
|
class |
QueryMarshallerContext
Dependencies needed by
QueryProtocolUnmarshaller. |
class |
QueryMarshallerRegistry
Marshaller registry for the AWS Query protocol.
|
class |
QueryProtocolMarshaller
Implementation of
ProtocolMarshaller for AWS Query services. |
class |
SimpleTypeQueryMarshaller<T>
Simple implementation of
QueryMarshaller that converts a given value to a string using
StringToValueConverter.StringToValue and emits it as a query param. |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsQueryResponseHandler<T extends AwsResponse>
Response handler for AWS/Query services and Amazon EC2 which is a dialect of the Query protocol.
|
class |
AwsXmlErrorUnmarshaller
Unmarshalls an AWS XML exception from parsed XML.
|
class |
ListQueryUnmarshaller |
class |
MapQueryUnmarshaller |
class |
QueryProtocolUnmarshaller
Unmarshaller implementation for AWS/Query and EC2 services.
|
interface |
QueryUnmarshaller<T> |
class |
QueryUnmarshallerContext
Container for dependencies used during AWS/Query unmarshalling.
|
class |
QueryUnmarshallerRegistry
Registry of
QueryUnmarshaller implementations by location and type. |
class |
SimpleTypeQueryUnmarshaller<T>
Unmarshaller implementation for simple, scalar values.
|
| Modifier and Type | Class and Description |
|---|---|
class |
HeaderMarshaller |
class |
QueryParamMarshaller |
class |
SimpleTypePathMarshaller |
class |
XmlGenerator
Wrapper around the
XmlWriter for marshalling requests for XML protocol |
interface |
XmlMarshaller<T>
Interface to marshall data for xml protocol
|
class |
XmlMarshallerContext |
class |
XmlMarshallerRegistry |
class |
XmlPayloadMarshaller |
class |
XmlProtocolMarshaller
Implementation of
ProtocolMarshaller for REST-XML services. |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsXmlErrorTransformer
A transformer function that takes a parsed XML response and converts it into an
AwsServiceException. |
class |
AwsXmlPredicatedResponseHandler<OutputT>
Unmarshalls an HTTP response into either a successful response POJO, or into a (possibly modeled) exception based
on a predicate that the unmarshalled response can be tested against.
|
class |
AwsXmlResponseHandler<T>
Response handler that adds
AwsResponseMetadata to the response. |
class |
AwsXmlResponseTransformer<T extends AwsResponse>
A transformer function that takes a parsed XML response and converts it into an
AwsResponse. |
class |
AwsXmlUnmarshallingContext
A data class to hold all the context of an unmarshalling stage for the AWS XML protocol as orchestrated by
AwsXmlPredicatedResponseHandler. |
class |
DecorateErrorFromResponseBodyUnmarshaller
A function that decorates a
AwsXmlUnmarshallingContext that already contains the parsed XML of the
response body with parsed error XML if the HTTP response status indicates failure or a serialized error is found
in the XML body of a 'successful' response. |
class |
HeaderUnmarshaller |
class |
XmlPayloadUnmarshaller |
class |
XmlProtocolUnmarshaller |
class |
XmlResponseHandler<T extends SdkPojo>
Response handler for REST-XML services (Cloudfront, Route53, and S3).
|
class |
XmlResponseParserUtils
Static methods to assist with parsing the response of AWS XML requests.
|
interface |
XmlUnmarshaller<T>
Interface to unmarshall response fields for Xml service
|
class |
XmlUnmarshallerContext |
class |
XmlUnmarshallerRegistry |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultServicePartitionMetadata |
class |
MetadataLoader
Internal class for determining where to load region and service
metadata from.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConnectionUtils |
class |
ServiceMetadataUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
AcquireInitialTokenRequestImpl
Implementation of the
AcquireInitialTokenRequest interface. |
class |
AcquireInitialTokenResponseImpl
Implementation of the
AcquireInitialTokenResponse interface. |
class |
RecordSuccessRequestImpl
Implementation of the
RecordSuccessRequest interfface |
class |
RecordSuccessResponseImpl
Implementation of the
RecordSuccessResponse interface. |
class |
RefreshRetryTokenRequestImpl
Implementation of the
RefreshRetryTokenRequest interface. |
class |
RefreshRetryTokenResponseImpl
Implementation for the
RefreshRetryTokenResponse interface. |
| Modifier and Type | Class and Description |
|---|---|
class |
ExponentialDelayWithJitter
Strategy that waits for a random period of time between 0ms and an exponentially increasing amount of time between each
subsequent attempt of the same call.
|
class |
ExponentialDelayWithoutJitter
Strategy that waits for an exponentially increasing amount of time between each subsequent attempt of the same call.
|
class |
FixedDelayWithJitter
Strategy that waits for a random period of time between 0ms and the provided delay.
|
class |
FixedDelayWithoutJitter
Strategy that waits for a period of time equal to the provided delay.
|
class |
Immediately
Strategy that do not back off: retry immediately.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BaseRetryStrategy
Generic class that implements that common logic for all the retries strategies with extension points for specific strategies to
tailor the behavior to its needs.
|
class |
DefaultAdaptiveRetryStrategy |
class |
DefaultLegacyRetryStrategy |
class |
DefaultRetryToken
A data rich
RetryToken implementation. |
class |
DefaultStandardRetryStrategy |
| Modifier and Type | Class and Description |
|---|---|
class |
AcquireResponse
The number of tokens in the token bucket after a specific token acquisition succeeds.
|
class |
ReleaseResponse |
class |
TokenBucket
A lock-free implementation of a token bucket.
|
class |
TokenBucketStore
A store to keep token buckets per scope.
|
| Modifier and Type | Class and Description |
|---|---|
class |
RateLimiterAcquireResponse |
interface |
RateLimiterClock |
class |
RateLimiterTokenBucket
The
RateLimiterTokenBucket keeps track of past throttling responses and adapts to slow down the send rate to adapt to
the service. |
class |
RateLimiterTokenBucketStore
A store to keep token buckets per scope.
|
class |
RateLimiterUpdateResponse |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultS3AuthSchemeParams |
class |
DefaultS3AuthSchemeProvider |
class |
ModeledS3AuthSchemeProvider |
class |
S3AuthSchemeInterceptor |
interface |
S3EndpointResolverAware |
| Modifier and Type | Class and Description |
|---|---|
class |
S3ClientContextParams<T> |
| Modifier and Type | Class and Description |
|---|---|
class |
Arn
An AWS Arn.
|
class |
AwsEndpointProviderUtils |
class |
BooleanEqualsFn |
class |
Condition |
class |
DefaultEndpointAuthSchemeStrategy |
class |
DefaultPartitionDataProvider |
class |
DefaultRuleEngine |
class |
DefaultS3EndpointProvider |
interface |
EndpointAttributeProvider<T>
Link between an endpoint property and the
AwsEndpointAttribute it represents. |
interface |
EndpointAuthSchemeStrategy |
interface |
EndpointAuthSchemeStrategyFactory |
class |
EndpointResult |
class |
EndpointRule |
class |
EndpointRuleset
The set of rules that are used to compute the endpoint to use for a request.
|
class |
ErrorRule |
interface |
Eval |
class |
Expr |
interface |
ExprVisitor<R> |
class |
FatScope<T> |
class |
Fn |
class |
FnNode
Parsed but not validated function contents containing the `fn` name and `argv`
|
interface |
FnVisitor<R> |
class |
GetAttr |
class |
Identifier
Identifiers for variables declared within the rule engine, e.g.
|
class |
InnerParseError |
interface |
Into<T> |
interface |
IntoSelf<T extends IntoSelf<T>> |
class |
IsSet |
class |
IsValidHostLabel |
class |
IsVirtualHostableS3Bucket |
class |
KnownS3ExpressEndpointProperty |
class |
Literal |
class |
Not |
class |
Outputs |
class |
Parameter |
class |
ParameterReference |
class |
Parameters |
class |
ParameterType |
class |
ParseArn |
class |
ParseUrl
Function to parse a URI from a string.
|
class |
Partition |
interface |
PartitionDataProvider |
class |
PartitionFn |
class |
Partitions |
class |
Ref
A reference to a field.
|
class |
RegionOverride |
class |
Rule |
class |
RuleArn |
interface |
RuleEngine |
class |
RuleError |
class |
RuleEvaluator |
class |
RulePartition |
class |
RuleResult |
class |
RulesFunctions |
class |
RuleUrl
Represents a URL to be used internally for endpoint resolution.
|
interface |
RuleValueVisitor<R>
Visitor for the right-hand side of rules (tree, error, endpoint)
|
class |
S3EndpointAuthSchemeStrategyFactory |
class |
S3RequestSetEndpointInterceptor |
class |
S3ResolveEndpointInterceptor |
class |
Scope<T> |
class |
SingleArgFn |
class |
SourceException |
class |
StringEqualsFn |
class |
Substring |
class |
Template
Template represents a "Template Literal".
|
interface |
TemplateVisitor<T>
For code generating from a template, use a `TemplateVisitor`.
|
interface |
ToParameterReference |
class |
TreeRule |
class |
UriEncodeFn |
class |
Value
Base class for the types of values computable by the
RuleEngine. |
| Modifier and Type | Class and Description |
|---|---|
class |
BucketUtils
Utilities for working with Amazon S3 bucket names, such as validation and
checked to see if they are compatible with DNS addressing.
|
class |
ConfiguredS3SdkHttpRequest |
class |
CustomRequestTransformerUtils
This class transforms specific request parameter into a custom parameter.
|
class |
FieldWithDefault<T>
A helper class for setting a field's value to a default if it isn't specified, while still keeping track of whether the value
was from the default or from the field.
|
class |
S3ClientOption<T> |
class |
S3ServiceClientConfigurationBuilder |
class |
TaggingAdapter
TypeAdapter that converts the Tagging modeled object into a
URL encoded map of key to values. |
class |
UserAgentUtils |
| Modifier and Type | Class and Description |
|---|---|
class |
ChecksumConstant |
class |
ChecksumsEnabledValidator
Class used by
SyncChecksumValidationInterceptor and
AsyncChecksumValidationInterceptor to determine if trailing checksums
should be enabled for a given request. |
class |
S3ChecksumValidatingInputStream |
class |
S3ChecksumValidatingPublisher |
| Modifier and Type | Class and Description |
|---|---|
class |
S3AsyncClientDecorator |
class |
S3SyncClientDecorator |
| Modifier and Type | Class and Description |
|---|---|
class |
S3CrossRegionAsyncClient |
class |
S3CrossRegionSyncClient
Decorator S3 Sync client that will fetch the region name whenever there is Redirect 301 error due to cross region bucket
access.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BucketEndpointProvider
Decorator S3EndpointProvider which updates the region with the one that is supplied during its instantiation.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CrossRegionUtils |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3EndpointResolver
An S3 endpoint resolver returns a
ConfiguredS3SdkHttpRequest based on the HTTP context and previously
set execution attributes. |
class |
S3EndpointResolverContext
Contains the information needed to resolve S3 endpoints.
|
class |
S3EndpointResolverFactoryContext |
class |
S3EndpointUtils
Utilities for working with Amazon S3 bucket names and endpoints.
|
class |
S3ObjectLambdaOperationEndpointBuilder
Endpoint builder for operations specific to S3 Object Lambda.
|
class |
UseGlobalEndpointResolver
Resolve the use global endpoint setting for S3.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncChecksumValidationInterceptor |
class |
ConfigureSignerInterceptor
Don't double-url-encode or normalize path elements for S3, as per
https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
|
class |
CreateBucketInterceptor |
class |
CreateMultipartUploadRequestInterceptor |
class |
DecodeUrlEncodedResponseInterceptor
Encoding type affects the following values in the response:
V1: Delimiter, Marker, Prefix, NextMarker, Key
V2: Delimiter, Prefix, Key, and StartAfter
|
class |
DisablePayloadSigningInterceptor
Disables payload signing for all S3 operations.
|
class |
EnableChunkedEncodingInterceptor
Interceptor to enable chunked encoding on specific upload operations if the option does not already have a value.
|
class |
EnableTrailingChecksumInterceptor |
class |
ExceptionTranslationInterceptor
Translate S3Exception for the API calls that do not contain the detailed error code.
|
class |
GetBucketPolicyInterceptor
GetBucketPolicy returns just JSON so we wrap in XML so that it is unmarshalled correctly.
|
class |
GetObjectInterceptor
Interceptor for
GetObjectRequest messages. |
class |
LegacyMd5ExecutionInterceptor |
class |
ObjectMetadataInterceptor
Interceptor that trims object metadata keys of any leading or trailing whitespace for
PutObject and CreateMultipartUpload. |
class |
StreamingRequestInterceptor
Interceptor to add an 'Expect: 100-continue' header to the HTTP Request if it represents a PUT Object request.
|
class |
SyncChecksumValidationInterceptor |
| Modifier and Type | Class and Description |
|---|---|
class |
CancelledSubscriber<T> |
class |
CopyObjectHelper
An internal helper class that automatically uses multipart copy based on the size of the source object
|
class |
DownloadObjectHelper |
class |
GenericMultipartHelper<RequestT extends S3Request,ResponseT extends S3Response> |
class |
KnownContentLengthAsyncRequestBodySubscriber |
class |
MpuRequestContext |
class |
MultipartConfigurationResolver
Internal utility class to resolve
MultipartConfiguration. |
class |
MultipartDownloaderSubscriber
A subscriber implementation that will download all individual parts for a multipart get-object request.
|
class |
MultipartDownloadResumeContext
This class keep tracks of the state of a multipart download across multipart GET requests.
|
class |
MultipartDownloadUtils |
class |
MultipartS3AsyncClient
An
S3AsyncClient that automatically converts PUT, COPY requests to their respective multipart call. |
class |
MultipartUploadHelper
A base class contains common logic used by
UploadWithUnknownContentLengthHelper and
UploadWithKnownContentLengthHelper. |
class |
S3ChecksumUtils |
class |
SdkPojoConversionUtils
Request conversion utility method for POJO classes associated with multipart feature.
|
class |
UploadObjectHelper
An internal helper class that automatically uses multipart upload based on the size of the object.
|
class |
UploadWithKnownContentLengthHelper
An internal helper class that automatically uses multipart upload based on the size of the object.
|
class |
UploadWithUnknownContentLengthHelper
An internal helper class that uploads streams with unknown content length.
|
| Modifier and Type | Class and Description |
|---|---|
class |
S3DisableChunkEncodingAuthSchemeProvider
Internal plugin that sets the signer property
AwsV4FamilyHttpSigner.CHUNK_ENCODING_ENABLED to false. |
class |
S3DisableChunkEncodingIfConfiguredPlugin
Internal plugin that uses the check if
S3Configuration.chunkedEncodingEnabled() is configured and equals to
false, if so, then it installs an instance of S3DisableChunkEncodingAuthSchemeProvider wrapping the configured
S3AuthSchemeProvider that sets AwsV4FamilyHttpSigner.CHUNK_ENCODING_ENABLED to false. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ArnConverter<T extends AwsResource>
An interface for converting an AWS ARN into a service specific
AwsResource. |
interface |
AwsResource
An abstract representation of an AWS Resource.
|
class |
IntermediateOutpostResource
The intermediate outpost resource
|
class |
OutpostResourceType
An enum representing the types of resources supported by S3 outpost.
|
class |
S3AccessPointBuilder
This class is used to construct an endpoint host for an S3 access point.
|
class |
S3AccessPointResource
An
S3Resource that represents an S3 access point. |
class |
S3ArnConverter
An implementation of
ArnConverter that can be used to convert valid Arn representations of s3
resources into S3Resource objects. |
class |
S3ArnUtils |
class |
S3BucketResource
An
S3Resource that represents an S3 bucket. |
class |
S3ObjectLambdaEndpointBuilder
This class is used to construct an endpoint for an S3 Object Lambda access point.
|
class |
S3ObjectLambdaResource
An
S3Resource that represents an S3 Object Lambda resource. |
class |
S3ObjectResource
An
S3Resource that represents an S3 object. |
class |
S3OutpostAccessPointBuilder
This class is used to construct an endpoint for an S3 outpost access point.
|
class |
S3OutpostResource
An
S3Resource that represents an S3 outpost resource |
class |
S3ResourceType
An enum representing the types of resources supported by S3.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CachedS3ExpressCredentials
This class represents a single cached S3Express credential.
|
class |
DefaultS3ExpressAuthScheme |
class |
DefaultS3ExpressHttpSigner |
class |
DefaultS3ExpressIdentityProvider |
class |
DefaultS3ExpressSessionCredentials
Default implementation of
S3ExpressSessionCredentials. |
class |
S3ExpressAuthSchemeProvider |
class |
S3ExpressIdentityCache |
class |
S3ExpressIdentityKey
The true keys used in the identity cache are
- bucket
- identity (AwsCredentials)
|
class |
S3ExpressPlugin |
class |
S3ExpressUtils |
class |
UseS3ExpressAuthResolver
Resolve the use S3Express auth setting for S3.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
DisableMultiRegionProvider
Interface for loading disable multi-region configuration.
|
class |
DisableMultiRegionProviderChain
DisableMultiRegionProvider implementation that chains together multiple disable multi-region providers. |
class |
ProfileDisableMultiRegionProvider
Loads configuration from the
ProfileFile.defaultProfileFile() using the default profile name. |
class |
ProfileUseArnRegionProvider
Loads useArnRegion configuration from the
ProfileFile.defaultProfileFile() using the default profile name. |
class |
SystemsSettingsDisableMultiRegionProvider
DisableMultiRegionProvider implementation that loads configuration from system properties
and environment variables. |
class |
SystemsSettingsUseArnRegionProvider
UseArnRegionProvider implementation that loads userArnRegion configuration from system properties
and environment variables. |
interface |
UseArnRegionProvider
Interface for loading useArnRegion configuration.
|
class |
UseArnRegionProviderChain
UseArnRegionProvider implementation that chains together multiple useArnRegion providers. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultS3Presigner
The default implementation of the
S3Presigner interface. |
static class |
DefaultS3Presigner.Builder |
class |
DefaultSdkPresigner
The base class implementing the
SdkPresigner interface. |
static class |
DefaultSdkPresigner.Builder<B extends DefaultSdkPresigner.Builder<B>>
The base class implementing the
SdkPresigner.Builder interface. |
class |
S3SigningUtils
Utilities for working with S3 specific signing
|
| Modifier and Type | Class and Description |
|---|---|
class |
JmesPathRuntime |
| Modifier and Type | Class and Description |
|---|---|
class |
Retention |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultCont
A specialization of
com.ibm.cos.v2.services.s3.model.ContinuationEvent that represents the
SelectObjectContentEventStream$Cont event. |
class |
DefaultEnd
A specialization of
com.ibm.cos.v2.services.s3.model.EndEvent that represents the
SelectObjectContentEventStream$End event. |
class |
DefaultProgress
A specialization of
com.ibm.cos.v2.services.s3.model.ProgressEvent that represents the
SelectObjectContentEventStream$Progress event. |
class |
DefaultRecords
A specialization of
com.ibm.cos.v2.services.s3.model.RecordsEvent that represents the
SelectObjectContentEventStream$Records event. |
class |
DefaultStats
A specialization of
com.ibm.cos.v2.services.s3.model.StatsEvent that represents the
SelectObjectContentEventStream$Stats event. |
| Modifier and Type | Class and Description |
|---|---|
class |
WaitersRuntime
Contains classes used at runtime by the code generator classes for waiter acceptors generated from JMESPath
expressions.
|
| Modifier and Type | Class and Description |
|---|---|
class |
StaticLoggerBinder
Acts as a bridge to real SLF4J implementations of
StaticLoggerBinder. |
class |
StaticMarkerBinder |
| Modifier and Type | Class and Description |
|---|---|
class |
ErrorUtil
Utility for reporting errors.
|
class |
ILoggerFactoryAdapter
Adapts a normal, unshaded
ILoggerFactory to the shaded ILoggerFactory. |
class |
IMarkerFactoryAdapter
Adapts a normal, unshaded
IMarkerFactory to the shaded IMarkerFactory. |
class |
InvocationHelper
Utility for creating and invoke
MethodHandles. |
class |
LoggerAdapter
Adapts from the shaded
Logger to the unshaded Logger. |
class |
MarkerUtils
Utility for converting
Markers back and forth between the shaded and unshaded interfaces. |
class |
ShadedMarkerAdapter
Adapts an unshaded
Marker to the shaded Marker. |
class |
UnshadedMarkerAdapter
Adapts a shaded
Marker to the unshaded Marker. |
| Modifier and Type | Class and Description |
|---|---|
class |
ApplyUserAgentInterceptor
Apply TM specific user agent to the request
|
class |
AsyncBufferingSubscriber<T>
An implementation of
Subscriber that execute the provided function for every event and limits the number of concurrent
function execution to the given maxConcurrentRequests |
class |
DownloadDirectoryHelper
An internal helper class that sends
DownloadFileRequests while it retrieves the objects to download from S3
recursively |
class |
ListObjectsHelper
A helper class that returns all objects within a bucket given a
ListObjectsV2Request recursively. |
class |
PauseResumeHelper |
class |
S3ClientType
Enum type to indicate the implementation of
S3AsyncClient |
class |
TransferConfigurationOption<T>
A set of internal options required by the
TransferManagerFactory via TransferManagerConfiguration. |
class |
TransferManagerConfiguration
Contains resolved configuration settings for
GenericS3TransferManager. |
class |
TransferManagerFactory
An
S3TransferManager factory that instantiate an S3TransferManager implementation based on the underlying
S3AsyncClient. |
class |
UploadDirectoryHelper
An internal helper class that traverses the file tree and send the upload request
for each file.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultCopy |
class |
DefaultDirectoryDownload |
class |
DefaultDirectoryUpload |
class |
DefaultDownload<ReturnT> |
class |
DefaultFileDownload |
class |
DefaultFileUpload |
class |
DefaultUpload |
| Modifier and Type | Class and Description |
|---|---|
class |
ContentRangeParser
Parse a Content-Range header value into a total byte count.
|
class |
DefaultTransferProgress
An SDK-internal implementation of
TransferProgress. |
class |
DefaultTransferProgressSnapshot
An SDK-internal implementation of
TransferProgressSnapshot. |
class |
ResumeTransferProgress
An implementation of
TransferProgress used when resuming a transfer. |
class |
TransferListenerFailedContext
An SDK-internal implementation of
TransferListener.Context.TransferFailed. |
class |
TransferListenerInvoker
An SDK-internal helper class that composes multiple provided
TransferListeners together into a single logical chain. |
class |
TransferProgressUpdater
An SDK-internal helper class that facilitates updating a
TransferProgress and invoking TransferListeners. |
| Modifier and Type | Class and Description |
|---|---|
class |
ResumableFileDownloadSerializer |
class |
ResumableFileUploadSerializer |
interface |
TransferManagerJsonMarshaller<T>
Interface to marshall data according to the JSON protocol specification.
|
interface |
TransferManagerJsonUnmarshaller<T>
Interface for unmarshalling a field from JSON.
|
class |
TransferManagerMarshallingUtils
Marshallers and unmarshallers for serializing objects in TM, using the SDK request
MarshallingType. |
| Modifier and Type | Class and Description |
|---|---|
class |
FileUtils |
class |
ResumableRequestConverter |
| Modifier and Type | Class and Description |
|---|---|
class |
Base16
A Base 16 codec API, which encodes into hex string in upper case.
|
class |
Base16Codec
A Base 16 codec implementation.
|
class |
ClassLoaderHelperTestBackdoor
This is a backdoor to add overrides to the results of querying
ClassLoaderHelpers. |
class |
CodecUtils
Codec internal utilities
|
class |
CodegenNamingUtils
Internal class used by the code generator and release scripts to produce sanitized names.
|
class |
DefaultConditionalDecorator<T> |
class |
ReflectionUtils
Utilities that assist with Java language reflection.
|
class |
SystemSettingUtilsTestBackdoor
This is a backdoor to add overrides to the results of querying
SystemSettings. |
| Modifier and Type | Class and Description |
|---|---|
class |
EmptySubscription
A NoOp implementation of
Subscription interface. |
| Modifier and Type | Class and Description |
|---|---|
class |
ProxyEnvironmentVariableConfigProvider
An implementation of the
ProxyConfigProvider interface that retrieves proxy configuration settings from environment
variables. |
class |
ProxySystemPropertyConfigProvider
An implementation of the
ProxyConfigProvider interface that retrieves proxy configuration settings from system
properties. |
Copyright © 2026. All rights reserved.