com.ibm.cos.v2.services.s3.s3express

Interface S3ExpressAuthScheme

All Superinterfaces:

AuthScheme<S3ExpressSessionCredentials>

All Known Implementing Classes:

DefaultS3ExpressAuthScheme

public interface S3ExpressAuthScheme
extends AuthScheme<S3ExpressSessionCredentials>

An auth scheme for faster authentication when interacting with S3 express.

This authentication scheme performs pre-authentication with S3 express using S3Client.createSession(com.ibm.cos.v2.services.s3.model.CreateSessionRequest). These S3ExpressSessionCredentials are cached for future requests to the same bucket that are using the same credential provider.

By default, this auth scheme is included on every S3Client instance and does not need to be explicitly enabled. If S3 express authentication is not desired for any reason, you can disable it on the client with S3BaseClientBuilder.disableS3ExpressSessionAuth(Boolean). When disabled, normal sigv4 will be used instead.

See Also:

S3ExpressSessionCredentials, S3Client.createSession(CreateSessionRequest)

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEME_ID The Scheme-Id for S3Express auth scheme

Method Summary

Modifier and Type	Method and Description
static S3ExpressAuthScheme	create()
IdentityProvider<S3ExpressSessionCredentials>	identityProvider(IdentityProviders providers) Retrieve the AwsCredentialsIdentity based IdentityProvider associated with this authentication scheme.
HttpSigner<S3ExpressSessionCredentials>	signer() Retrieve the AwsV4HttpSigner associated with this authentication scheme.

Methods inherited from interface com.ibm.cos.v2.http.auth.spi.scheme.AuthScheme

schemeId

Field Detail

SCHEME_ID

static final String SCHEME_ID

The Scheme-Id for S3Express auth scheme

See Also:

Constant Field Values

Method Detail

create

static S3ExpressAuthScheme create()

identityProvider

IdentityProvider<S3ExpressSessionCredentials> identityProvider(IdentityProviders providers)

Retrieve the AwsCredentialsIdentity based IdentityProvider associated with this authentication scheme.

Specified by:

identityProvider in interface AuthScheme<S3ExpressSessionCredentials>

signer

HttpSigner<S3ExpressSessionCredentials> signer()

Retrieve the AwsV4HttpSigner associated with this authentication scheme.

Specified by:

signer in interface AuthScheme<S3ExpressSessionCredentials>