Class OpenApiFeatureConfig.BuilderBase.OpenApiFeatureConfigImpl

java.lang.Object

io.helidon.openapi.OpenApiFeatureConfig.BuilderBase.OpenApiFeatureConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<OpenApiFeature>, OpenApiFeatureConfig, Supplier<OpenApiFeature>

Enclosing class:

OpenApiFeatureConfig.BuilderBase<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenApiFeatureConfig>

protected static class OpenApiFeatureConfig.BuilderBase.OpenApiFeatureConfigImpl
extends Object
implements OpenApiFeatureConfig, Supplier<OpenApiFeature>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface OpenApiFeatureConfig

OpenApiFeatureConfig.Builder, OpenApiFeatureConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	OpenApiFeatureConfig.Builder	Fluent API builder for OpenApiFeature.
static class	OpenApiFeatureConfig.BuilderBase<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenApiFeatureConfig>	Fluent API builder base for OpenApiFeatureConfig.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenApiFeatureConfigImpl(OpenApiFeatureConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
OpenApiFeature	build()	Create a new runtime instance from this prototype.
boolean	equals(Object o)
List<String>	generatedDocumentSources()	Named generated document metadata sources to use, in the order configured.
OpenApiGeneratedMode	generatedMode()	Generated document source handling mode.
Map<String,String>	generatedOperationIds()	Operation ids to use for generated Java methods.
boolean	generatedResolveConfigExpressions()	Whether generated document sources resolve annotation string values as Helidon config expressions at runtime.
OpenApiFeature	get()
int	hashCode()
boolean	isEnabled()	Sets whether the feature should be enabled.
Optional<OpenApiManager<?>>	manager()	OpenAPI manager.
String	name()	Name of this instance.
Optional<OpenApiVersion>	openApiVersion()	OpenAPI version implementation for rendered generated or merged documents.
boolean	permitAll()	Whether to allow anybody to access the endpoint.
List<String>	roles()	Hints for role names the user is expected to be in.
Optional<ServiceRegistry>	runtimeServiceRegistry()	Runtime service registry supplied to the builder.
List<OpenApiService>	services()	OpenAPI services.
Set<String>	sockets()	List of sockets to register this feature on.
Optional<Object>	sourceRoot()	Runtime source configuration supplied to the builder.
Optional<String>	staticFile()	Path of the static OpenAPI document file.
String	toString()
String	webContext()	Web context path for the OpenAPI endpoint.
double	weight()	Weight of the OpenAPI feature.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OpenApiFeatureConfigImpl

protected OpenApiFeatureConfigImpl(OpenApiFeatureConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public OpenApiFeature build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<OpenApiFeature>

Returns:

new configured runtime instance

get

public OpenApiFeature get()

Specified by:

get in interface Supplier<OpenApiFeature>

weight

public double weight()

Description copied from interface: OpenApiFeatureConfig

Weight of the OpenAPI feature. This is quite low, to be registered after routing. 90.0.

Specified by:

weight in interface OpenApiFeatureConfig

Returns:

weight of the feature

isEnabled

public boolean isEnabled()

Description copied from interface: OpenApiFeatureConfig

Sets whether the feature should be enabled.

Specified by:

isEnabled in interface OpenApiFeatureConfig

Returns:

true if enabled, false otherwise

webContext

public String webContext()

Description copied from interface: OpenApiFeatureConfig

Web context path for the OpenAPI endpoint.

Specified by:

webContext in interface OpenApiFeatureConfig

Returns:

webContext to use

staticFile

public Optional<String> staticFile()

Description copied from interface: OpenApiFeatureConfig

Path of the static OpenAPI document file. Default types are `json`, `yaml`, and `yml`.

Specified by:

staticFile in interface OpenApiFeatureConfig

Returns:

location of the static OpenAPI document file

generatedMode

public OpenApiGeneratedMode generatedMode()

Description copied from interface: OpenApiFeatureConfig

Generated document source handling mode.

Specified by:

generatedMode in interface OpenApiFeatureConfig

Returns:

generated document source handling mode

generatedResolveConfigExpressions

public boolean generatedResolveConfigExpressions()

Description copied from interface: OpenApiFeatureConfig

Whether generated document sources resolve annotation string values as Helidon config expressions at runtime.

When disabled, generated document sources use annotation string values literally. This is disabled by default because annotation text can be user-visible OpenAPI content.

Specified by:

generatedResolveConfigExpressions in interface OpenApiFeatureConfig

Returns:

whether to resolve generated OpenAPI annotation string values as config expressions

generatedDocumentSources

public List<String> generatedDocumentSources()

Description copied from interface: OpenApiFeatureConfig

Named generated document metadata sources to use, in the order configured.

Sources generated from @OpenApi.Document use the annotated type's dotted canonical type name. Custom OpenApiDocumentSource services must be qualified with @Service.Named to be selected by name. Unqualified sources always participate when they support the document context and cannot be filtered with this option.

Specified by:

generatedDocumentSources in interface OpenApiFeatureConfig

Returns:

generated document metadata source names

generatedOperationIds

public Map<String,String> generatedOperationIds()

Description copied from interface: OpenApiFeatureConfig

Operation ids to use for generated Java methods.

Each key is a Java method signature consisting of the fully qualified class name, #, the method name, and fully qualified parameter types separated by ,. The value is the operation id to use for that method.

Specified by:

generatedOperationIds in interface OpenApiFeatureConfig

Returns:

generated operation ids keyed by fully qualified Java method signature

openApiVersion

public Optional<OpenApiVersion> openApiVersion()

Description copied from interface: OpenApiFeatureConfig

OpenAPI version implementation for rendered generated or merged documents.

If not configured, service discovery selects the highest-weighted available OpenAPI version provider. This means that adding OpenAPI 3.1 or 3.2 support modules can change generated output to the highest available OpenAPI document version. Configure this option to pin the OpenAPI document version for generated output.

Static documents served directly by OpenApiGeneratedMode.STATIC_ONLY or by a static hit in OpenApiGeneratedMode.STATIC_FIRST are not re-rendered through this provider.

Specified by:

openApiVersion in interface OpenApiFeatureConfig

Returns:

version implementation for generated or merged OpenAPI documents

services

public List<OpenApiService> services()

Description copied from interface: OpenApiFeatureConfig

OpenAPI services.

Specified by:

services in interface OpenApiFeatureConfig

Returns:

the OpenAPI services

manager

public Optional<OpenApiManager<?>> manager()

Description copied from interface: OpenApiFeatureConfig

OpenAPI manager.

Specified by:

manager in interface OpenApiFeatureConfig

Returns:

the OpenAPI manager

permitAll

public boolean permitAll()

Description copied from interface: OpenApiFeatureConfig

Whether to allow anybody to access the endpoint.

Specified by:

permitAll in interface OpenApiFeatureConfig

Returns:

whether to permit access to metrics endpoint to anybody, defaults to true

See Also:

• OpenApiFeatureConfig.roles()

roles

public List<String> roles()

Description copied from interface: OpenApiFeatureConfig

Hints for role names the user is expected to be in.

Specified by:

roles in interface OpenApiFeatureConfig

Returns:

list of hints

name

public String name()

Description copied from interface: OpenApiFeatureConfig

Name of this instance.

Specified by:

name in interface OpenApiFeatureConfig

Returns:

instance name, used when discovered from configuration

sockets

public Set<String> sockets()

Description copied from interface: OpenApiFeatureConfig

List of sockets to register this feature on. If empty, it would get registered on all sockets.

Specified by:

sockets in interface OpenApiFeatureConfig

Returns:

socket names to register on, defaults to empty (all available sockets)

runtimeServiceRegistry

public Optional<ServiceRegistry> runtimeServiceRegistry()

Description copied from interface: OpenApiFeatureConfig

Runtime service registry supplied to the builder.

Specified by:

runtimeServiceRegistry in interface OpenApiFeatureConfig

Returns:

runtime service registry

sourceRoot

public Optional<Object> sourceRoot()

Description copied from interface: OpenApiFeatureConfig

Runtime source configuration supplied to the builder.

Specified by:

sourceRoot in interface OpenApiFeatureConfig

Returns:

runtime source configuration

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object