Module io.helidon.openapi

Package io.helidon.openapi

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 io.helidon.openapi.OpenApiFeatureConfig

OpenApiFeatureConfig.Builder, OpenApiFeatureConfig.BuilderBase<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends 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 instance of the runtime type from this config object.
Optional<CrossOriginConfig>	cors()	CORS config.
boolean	equals(Object o)
OpenApiFeature	get()
int	hashCode()
boolean	isEnabled()	Sets whether the feature should be enabled.
Optional<OpenApiManager<?>>	manager()	OpenAPI manager.
String	name()	Name of this instance.
boolean	permitAll()	Whether to allow anybody to access the endpoint.
List<String>	roles()	Hints for role names the user is expected to be in.
List<OpenApiService>	services()	OpenAPI services.
Set<String>	sockets()	List of sockets to register this feature on.
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 java.lang.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()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

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

cors

public Optional<CrossOriginConfig> cors()

Description copied from interface: OpenApiFeatureConfig

CORS config.

Specified by:

cors in interface OpenApiFeatureConfig

Returns:

CORS config

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)

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