Package io.quarkiverse.openapi.generator

Class AuthConfig

java.lang.Object

io.quarkiverse.openapi.generator.AuthConfig

public class AuthConfig
extends Object

This class represents the runtime authentication related configuration for an individual securityScheme present on an OpenApi spec definition, i.e. the provided files.

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String>	authConfigParams	Configures a particular parameter value to be used by any of the different internal authentication filters that processes the different securityScheme definitions.
static final String	HEADER_NAME
Optional<String>	headerName	Configures a particular http header attribute from were to take the security token from when the token propagation is enabled.
static final String	TOKEN_PROPAGATION
Optional<Boolean>	tokenPropagation	Enables the authentication token propagation for this particular securityScheme.

Constructor Summary

Constructors

Constructor	Description
AuthConfig()

Method Summary

Modifier and Type	Method	Description
Optional<String>	getConfigParam(String paramName)
Optional<String>	getHeaderName()
Optional<Boolean>	getTokenPropagation()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

TOKEN_PROPAGATION

public static final String TOKEN_PROPAGATION

See Also:

• Constant Field Values

HEADER_NAME

public static final String HEADER_NAME

See Also:

• Constant Field Values

tokenPropagation

@ConfigItem(defaultValue="false")
public Optional<Boolean> tokenPropagation

Enables the authentication token propagation for this particular securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.token-propagation=true

See Also:

• AuthsConfig
• SpecItemConfig
• OpenApiGeneratorConfig

headerName

@ConfigItem
public Optional<String> headerName

Configures a particular http header attribute from were to take the security token from when the token propagation is enabled. Use this fine-grained configuration in very particular scenarios.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.header-name=MyParticularHttpHeaderName

See Also:

• AuthsConfig
• SpecItemConfig
• OpenApiGeneratorConfig

authConfigParams

@ConfigItem(name="<<parent>>")
public Map<String,String> authConfigParams

Configures a particular parameter value to be used by any of the different internal authentication filters that processes the different securityScheme definitions.

For example, given a file named petstore.json with a securityScheme named "petstore-basic-auth", that is of http basic authentication type, the following configuration can establish the user and password to be used. must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.username=MyUserName quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.password=MyPassword

See Also:

• AuthsConfig
• SpecItemConfig
• OpenApiGeneratorConfig
• BasicAuthenticationProvider
• BearerAuthenticationProvider
• ApiKeyAuthenticationProvider

Constructor Details

AuthConfig

public AuthConfig()

Method Details

getTokenPropagation

public Optional<Boolean> getTokenPropagation()

getHeaderName

public Optional<String> getHeaderName()

getConfigParam

public Optional<String> getConfigParam(String paramName)

toString

public String toString()

Overrides:

toString in class Object