software.amazon.awssdk.http.auth.spi.scheme

Interface AuthSchemeOption

All Superinterfaces:

ToCopyableBuilder<AuthSchemeOption.Builder,AuthSchemeOption>

All Known Implementing Classes:

DefaultAuthSchemeOption

public interface AuthSchemeOption
extends ToCopyableBuilder<AuthSchemeOption.Builder,AuthSchemeOption>

An authentication scheme option, composed of the scheme ID and properties for use when resolving the identity and signing the request.

This is used in the output from the auth scheme resolver. The resolver returns a list of these, in the order the auth scheme resolver wishes to use them.

See Also:

AuthScheme

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AuthSchemeOption.Builder A builder for a AuthSchemeOption.
static interface	AuthSchemeOption.IdentityPropertyConsumer Interface for operating on an IdentityProperty value.
static interface	AuthSchemeOption.SignerPropertyConsumer Interface for operating on an SignerProperty value.

Method Summary

Modifier and Type	Method and Description
static AuthSchemeOption.Builder	builder() Get a new builder for creating a AuthSchemeOption.
void	forEachIdentityProperty(AuthSchemeOption.IdentityPropertyConsumer consumer) A method to operate on all IdentityProperty values of this AuthSchemeOption.
void	forEachSignerProperty(AuthSchemeOption.SignerPropertyConsumer consumer) A method to operate on all SignerProperty values of this AuthSchemeOption.
<T> T	identityProperty(IdentityProperty<T> property) Retrieve the value of an IdentityProperty.
String	schemeId() Retrieve the scheme ID, a unique identifier for the authentication scheme (aws.auth#sigv4, smithy.api#httpBearerAuth).
<T> T	signerProperty(SignerProperty<T> property) Retrieve the value of an SignerProperty.

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy, toBuilder

Method Detail

builder

static AuthSchemeOption.Builder builder()

Get a new builder for creating a AuthSchemeOption.

schemeId

String schemeId()

Retrieve the scheme ID, a unique identifier for the authentication scheme (aws.auth#sigv4, smithy.api#httpBearerAuth).

identityProperty

<T> T identityProperty(IdentityProperty<T> property)

Retrieve the value of an IdentityProperty.

Type Parameters:

T - The type of the IdentityProperty.

Parameters:

property - The IdentityProperty to retrieve the value of.

signerProperty

<T> T signerProperty(SignerProperty<T> property)

Retrieve the value of an SignerProperty.

Type Parameters:

T - The type of the SignerProperty.

Parameters:

property - The SignerProperty to retrieve the value of.

forEachIdentityProperty

void forEachIdentityProperty(AuthSchemeOption.IdentityPropertyConsumer consumer)

A method to operate on all IdentityProperty values of this AuthSchemeOption.

Parameters:

consumer - The method to apply to each IdentityProperty.

forEachSignerProperty

void forEachSignerProperty(AuthSchemeOption.SignerPropertyConsumer consumer)

A method to operate on all SignerProperty values of this AuthSchemeOption.

Parameters:

consumer - The method to apply to each SignerProperty.