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
ConstructorsModifierConstructorDescriptionprotected
OpenApiFeatureConfigImpl
(OpenApiFeatureConfig.BuilderBase<?, ?> builder) Create an instance providing a builder. -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Create a new instance of the runtime type from this config object.cors()
CORS config.boolean
get()
int
hashCode()
boolean
Sets whether the feature should be enabled.manager()
OpenAPI manager.name()
Name of this instance.boolean
Whether to allow anybody to access the endpoint.roles()
Hints for role names the user is expected to be in.services()
OpenAPI services.sockets()
List of sockets to register this feature on.Path of the static OpenAPI document file.toString()
Web context path for the OpenAPI endpoint.double
weight()
Weight of the OpenAPI feature.
-
Constructor Details
-
OpenApiFeatureConfigImpl
Create an instance providing a builder.- Parameters:
builder
- extending builder base of this prototype
-
-
Method Details
-
build
Description copied from interface:Prototype.Factory
Create a new instance of the runtime type from this config object.- Specified by:
build
in interfacePrototype.Factory<OpenApiFeature>
- Returns:
- new configured runtime instance
-
get
- Specified by:
get
in interfaceSupplier<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 interfaceOpenApiFeatureConfig
- 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 interfaceOpenApiFeatureConfig
- Returns:
true
if enabled,false
otherwise
-
webContext
Description copied from interface:OpenApiFeatureConfig
Web context path for the OpenAPI endpoint.- Specified by:
webContext
in interfaceOpenApiFeatureConfig
- Returns:
- webContext to use
-
staticFile
Description copied from interface:OpenApiFeatureConfig
Path of the static OpenAPI document file. Default types are `json`, `yaml`, and `yml`.- Specified by:
staticFile
in interfaceOpenApiFeatureConfig
- Returns:
- location of the static OpenAPI document file
-
cors
Description copied from interface:OpenApiFeatureConfig
CORS config.- Specified by:
cors
in interfaceOpenApiFeatureConfig
- Returns:
- CORS config
-
services
Description copied from interface:OpenApiFeatureConfig
OpenAPI services.- Specified by:
services
in interfaceOpenApiFeatureConfig
- Returns:
- the OpenAPI services
-
manager
Description copied from interface:OpenApiFeatureConfig
OpenAPI manager.- Specified by:
manager
in interfaceOpenApiFeatureConfig
- 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 interfaceOpenApiFeatureConfig
- Returns:
- whether to permit access to metrics endpoint to anybody, defaults to
true
- See Also:
-
roles
Description copied from interface:OpenApiFeatureConfig
Hints for role names the user is expected to be in.- Specified by:
roles
in interfaceOpenApiFeatureConfig
- Returns:
- list of hints
-
name
Description copied from interface:OpenApiFeatureConfig
Name of this instance.- Specified by:
name
in interfaceOpenApiFeatureConfig
- Returns:
- instance name, used when discovered from configuration
-
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 interfaceOpenApiFeatureConfig
- Returns:
- socket names to register on, defaults to empty (all available sockets)
-
toString
-
equals
-
hashCode
public int hashCode()
-