Package software.amazon.smithy.openapi.fromsmithy.security

Class HttpBasicConverter

java.lang.Object

software.amazon.smithy.openapi.fromsmithy.security.HttpBasicConverter

All Implemented Interfaces:

SecuritySchemeConverter<HttpBasicAuthTrait>

public final class HttpBasicConverter
extends java.lang.Object
implements SecuritySchemeConverter<HttpBasicAuthTrait>

Applies Basic HTTP auth.

Constructor Summary

Constructors

Constructor	Description
HttpBasicConverter()

Method Summary

Modifier and Type	Method	Description
SecurityScheme	createSecurityScheme(Context<? extends Trait> context, HttpBasicAuthTrait trait)	Creates an OpenAPI security scheme.
java.lang.Class<HttpBasicAuthTrait>	getAuthSchemeType()	Get the U that matches this converter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.smithy.openapi.fromsmithy.SecuritySchemeConverter

createSecurityRequirements, getAuthRequestHeaders, getAuthResponseHeaders, getAuthSchemeId, getOpenApiAuthSchemeName, usesHttpCredentials

Constructor Detail

HttpBasicConverter

public HttpBasicConverter()

Method Detail

getAuthSchemeType

public java.lang.Class<HttpBasicAuthTrait> getAuthSchemeType()

Description copied from interface: SecuritySchemeConverter

Get the U that matches this converter.

Specified by:

getAuthSchemeType in interface SecuritySchemeConverter<HttpBasicAuthTrait>

Returns:

The Smithy security auth scheme ID.

createSecurityScheme

public SecurityScheme createSecurityScheme(Context<? extends Trait> context,
                                           HttpBasicAuthTrait trait)

Description copied from interface: SecuritySchemeConverter

Creates an OpenAPI security scheme.

Specified by:

createSecurityScheme in interface SecuritySchemeConverter<HttpBasicAuthTrait>

Parameters:

context - Conversion context.

trait - Authentication trait to convert.

Returns:

The generated security scheme

See Also:

Security Scheme Object