| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCredentials
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsBasicCredentials
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
class |
AwsSessionCredentials
A special type of
AwsCredentials that provides a session token to be used in service authentication. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
IBMOAuthCredentials
IBM OAuth Credentials interface.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BasicIBMOAuthCredentials
Basic implementation of the IBMOAuthCredentials interface that allows callers to
pass in the IBM api key and service instance id in the constructor.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkToken
Provides token which is used to securely authorize requests to services that use token based auth, e.g., OAuth.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SelectedAuthScheme<T extends Identity>
A container for the identity resolver, signer and auth option that we selected for use with this service call attempt.
|
| Modifier and Type | Method and Description |
|---|---|
static boolean |
CredentialUtils.isAnonymous(Identity credentials)
Determine whether the provided credentials are anonymous credentials, indicating that the customer is not attempting to
authenticate themselves.
|
| Modifier and Type | Method and Description |
|---|---|
static Checksummer |
ChecksumUtil.checksummer(BaseSignRequest<?,? extends Identity> request,
Boolean isPayloadSigningOverride) |
static boolean |
ChecksumUtil.hasChecksumHeader(BaseSignRequest<?,? extends Identity> request) |
static boolean |
ChecksumUtil.isPayloadSigning(BaseSignRequest<?,? extends Identity> request) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsV4FamilyHttpSigner<T extends Identity>
An interface shared by
AwsV4HttpSigner for defining signer properties that are common
across both signers. |
| Modifier and Type | Interface and Description |
|---|---|
static interface |
NoAuthAuthScheme.AnonymousIdentity
An anonymous identity used by the no-auth auth scheme.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAsyncSignRequest<IdentityT extends Identity> |
static class |
DefaultAsyncSignRequest.BuilderImpl<IdentityT extends Identity> |
class |
DefaultSignRequest<IdentityT extends Identity> |
static class |
DefaultSignRequest.BuilderImpl<IdentityT extends Identity> |
class |
NoOpHttpSigner<T extends Identity> |
| Modifier and Type | Method and Description |
|---|---|
static <IdentityT extends Identity> |
DefaultSignRequest.builder() |
static <IdentityT extends Identity> |
DefaultAsyncSignRequest.builder() |
static <IdentityT extends Identity> |
DefaultSignRequest.builder(IdentityT identity) |
static <IdentityT extends Identity> |
DefaultAsyncSignRequest.builder(IdentityT identity) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AuthScheme<T extends Identity>
An authentication scheme, composed of:
A scheme ID - A unique identifier for the authentication scheme.
An identity provider - An API that can be queried to acquire the customer's identity.
A signer - An API that can be used to sign HTTP requests.
See example auth schemes defined here.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncSignRequest<IdentityT extends Identity>
Input parameters to sign a request with async payload, using
HttpSigner. |
static interface |
AsyncSignRequest.Builder<IdentityT extends Identity>
A builder for a
AsyncSignRequest. |
interface |
BaseSignRequest<PayloadT,IdentityT extends Identity>
Base interface to represent input parameters to sign a request using
HttpSigner, independent of payload type. |
static interface |
BaseSignRequest.Builder<B extends BaseSignRequest.Builder<B,PayloadT,IdentityT>,PayloadT,IdentityT extends Identity>
A builder for a
BaseSignRequest. |
interface |
HttpSigner<IdentityT extends Identity>
Interface for the process of modifying a request destined for a service so that the service can authenticate the SDK
customer’s identity.
|
interface |
SignRequest<IdentityT extends Identity>
Input parameters to sign a request with sync payload, using
HttpSigner. |
static interface |
SignRequest.Builder<IdentityT extends Identity>
A builder for a
SignRequest. |
| Modifier and Type | Method and Description |
|---|---|
static <IdentityT extends Identity> |
SignRequest.builder(IdentityT identity)
Get a new builder for creating a
SignRequest. |
static <IdentityT extends Identity> |
AsyncSignRequest.builder(IdentityT identity)
Get a new builder for creating a
AsyncSignRequest. |
default <T extends Identity> |
HttpSigner.doNotSign()
Retrieve a signer that returns the input message, without signing.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
IdentityProvider<IdentityT extends Identity>
Interface for loading
Identity that is used for authentication. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCredentialsIdentity
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
interface |
AwsSessionCredentialsIdentity
A special type of
AwsCredentialsIdentity that provides a session token to be used in service authentication. |
interface |
TokenIdentity
Provides token which is used to securely authorize requests to services that use token based auth, e.g., OAuth.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends Identity> |
IdentityProviders.identityProvider(Class<T> identityType)
Retrieve an identity provider for the provided identity type.
|
<T extends Identity> |
IdentityProviders.Builder.putIdentityProvider(IdentityProvider<T> identityProvider)
Add the
IdentityProvider for a given type. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
IBMOAuthIdentity |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAwsCredentialsIdentity |
class |
DefaultAwsSessionCredentialsIdentity |
class |
DefaultIAMCredentialsIdentity |
| Modifier and Type | Method and Description |
|---|---|
<T extends Identity> |
DefaultIdentityProviders.identityProvider(Class<T> identityType) |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultS3ExpressSessionCredentials
Default implementation of
S3ExpressSessionCredentials. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3ExpressSessionCredentials
Session credentials used by
S3ExpressAuthScheme. |
Copyright © 2026. All rights reserved.