Module io.helidon.openapi
Package io.helidon.openapi

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

java.lang.Object
io.helidon.openapi.OpenApiFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
OpenApiFeatureConfig.Builder
Enclosing interface:
OpenApiFeatureConfig
public abstract static class OpenApiFeatureConfig.BuilderBase<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiFeatureConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenApiFeatureConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenApiFeatureConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(OpenApiFeatureConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiFeatureConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenApiFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenApiFeatureConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • weight

      public BUILDER weight(double weight)
      Weight of the OpenAPI feature. This is quite low, to be registered after routing. 90.0.
      Parameters:
      weight - weight of the feature
      Returns:
      updated builder instance
      See Also:

    • isEnabled

      public BUILDER isEnabled(boolean isEnabled)
      Sets whether the feature should be enabled.
      Parameters:
      isEnabled - true if enabled, false otherwise
      Returns:
      updated builder instance
      See Also:

    • webContext

      public BUILDER webContext(String webContext)
      Web context path for the OpenAPI endpoint.
      Parameters:
      webContext - webContext to use
      Returns:
      updated builder instance
      See Also:

    • clearStaticFile

      public BUILDER clearStaticFile()
      Clear existing value of staticFile.
      Returns:
      updated builder instance
      See Also:

    • staticFile

      public BUILDER staticFile(String staticFile)
      Path of the static OpenAPI document file. Default types are `json`, `yaml`, and `yml`.
      Parameters:
      staticFile - location of the static OpenAPI document file
      Returns:
      updated builder instance
      See Also:

    • clearCors

      @Deprecated(since="4.4.0", forRemoval=true) public BUILDER clearCors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      feature specific CORS configuration is deprecated and will be removed; use either config based CORS setup (configuration key cors, or programmatic setup using the io.helidon.webserver.cors.CorsFeature server feature
      Clear existing value of cors.
      Returns:
      updated builder instance
      See Also:

    • cors

      @Deprecated(since="4.4.0", forRemoval=true) public BUILDER cors(CrossOriginConfig cors)
      Deprecated, for removal: This API element is subject to removal in a future version.
      feature specific CORS configuration is deprecated and will be removed; use either config based CORS setup (configuration key cors, or programmatic setup using the io.helidon.webserver.cors.CorsFeature server feature
      CORS config.
      Parameters:
      cors - CORS config
      Returns:
      updated builder instance
      See Also:

    • cors

      @Deprecated(since="4.4.0", forRemoval=true) public BUILDER cors(Consumer<CrossOriginConfig.Builder> consumer)
      Deprecated, for removal: This API element is subject to removal in a future version.
      feature specific CORS configuration is deprecated and will be removed; use either config based CORS setup (configuration key cors, or programmatic setup using the io.helidon.webserver.cors.CorsFeature server feature
      CORS config.
      Parameters:
      consumer - consumer of builder of CORS config
      Returns:
      updated builder instance
      See Also:

    • cors

      @Deprecated(since="4.4.0", forRemoval=true) public BUILDER cors(Supplier<? extends CrossOriginConfig> supplier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      feature specific CORS configuration is deprecated and will be removed; use either config based CORS setup (configuration key cors, or programmatic setup using the io.helidon.webserver.cors.CorsFeature server feature
      CORS config.
      Parameters:
      supplier - supplier of CORS config
      Returns:
      updated builder instance
      See Also:

    • clearServices

      public BUILDER clearServices()
      Clear all services.
      Returns:
      updated builder instance
      See Also:

    • services

      public BUILDER services(List<? extends OpenApiService> services)
      OpenAPI services.
      Parameters:
      services - the OpenAPI services
      Returns:
      updated builder instance
      See Also:

    • addServices

      public BUILDER addServices(List<? extends OpenApiService> services)
      OpenAPI services.
      Parameters:
      services - the OpenAPI services
      Returns:
      updated builder instance
      See Also:

    • addService

      public BUILDER addService(OpenApiService service)
      OpenAPI services.
      Parameters:
      service - add single the OpenAPI services
      Returns:
      updated builder instance
      See Also:

    • clearManager

      public BUILDER clearManager()
      Clear existing value of manager.
      Returns:
      updated builder instance
      See Also:

    • manager

      public BUILDER manager(OpenApiManager<?> manager)
      OpenAPI manager.
      Parameters:
      manager - the OpenAPI manager
      Returns:
      updated builder instance
      See Also:

    • permitAll

      public BUILDER permitAll(boolean permitAll)
      Whether to allow anybody to access the endpoint.
      Parameters:
      permitAll - whether to permit access to metrics endpoint to anybody, defaults to true
      Returns:
      updated builder instance
      See Also:

    • clearRoles

      public BUILDER clearRoles()
      Clear all roles.
      Returns:
      updated builder instance
      See Also:

    • roles

      public BUILDER roles(List<String> roles)
      Hints for role names the user is expected to be in.
      Parameters:
      roles - list of hints
      Returns:
      updated builder instance
      See Also:

    • addRoles

      public BUILDER addRoles(List<String> roles)
      Hints for role names the user is expected to be in.
      Parameters:
      roles - list of hints
      Returns:
      updated builder instance
      See Also:

    • name

      public BUILDER name(String name)
      Name of this instance.
      Parameters:
      name - instance name, used when discovered from configuration
      Returns:
      updated builder instance
      See Also:

    • clearSockets

      public BUILDER clearSockets()
      Clear all sockets.
      Returns:
      updated builder instance
      See Also:

    • sockets

      public BUILDER sockets(Set<String> sockets)
      List of sockets to register this feature on. If empty, it would get registered on all sockets.
      Parameters:
      sockets - socket names to register on, defaults to empty (all available sockets)
      Returns:
      updated builder instance
      See Also:

    • addSockets

      public BUILDER addSockets(Set<String> sockets)
      List of sockets to register this feature on. If empty, it would get registered on all sockets.
      Parameters:
      sockets - socket names to register on, defaults to empty (all available sockets)
      Returns:
      updated builder instance
      See Also:

    • addSocket

      public BUILDER addSocket(String socket)
      List of sockets to register this feature on. If empty, it would get registered on all sockets.
      Parameters:
      socket - add single socket names to register on, defaults to empty (all available sockets)
      Returns:
      updated builder instance
      See Also:

    • servicesDiscoverServices

      public BUILDER servicesDiscoverServices(boolean servicesDiscoverServices)
      Service discovery flag for services(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      servicesDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • managerDiscoverServices

      public BUILDER managerDiscoverServices(boolean managerDiscoverServices)
      Service discovery flag for manager(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      managerDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • weight

      public double weight()
      Weight of the OpenAPI feature. This is quite low, to be registered after routing. 90.0.
      Returns:
      weight of the feature

    • isEnabled

      public boolean isEnabled()
      Sets whether the feature should be enabled.
      Returns:
      true if enabled, false otherwise

    • webContext

      public String webContext()
      Web context path for the OpenAPI endpoint.
      Returns:
      webContext to use

    • staticFile

      public Optional<String> staticFile()
      Path of the static OpenAPI document file. Default types are `json`, `yaml`, and `yml`.
      Returns:
      location of the static OpenAPI document file

    • cors

      @Deprecated(since="4.4.0", forRemoval=true) public Optional<CrossOriginConfig> cors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      feature specific CORS configuration is deprecated and will be removed; use either config based CORS setup (configuration key cors, or programmatic setup using the io.helidon.webserver.cors.CorsFeature server feature
      CORS config.
      Returns:
      CORS config

    • services

      public List<OpenApiService> services()
      OpenAPI services.
      Returns:
      the OpenAPI services

    • manager

      public Optional<OpenApiManager<?>> manager()
      OpenAPI manager.
      Returns:
      the OpenAPI manager

    • permitAll

      public boolean permitAll()
      Whether to allow anybody to access the endpoint.
      Returns:
      whether to permit access to metrics endpoint to anybody, defaults to true
      See Also:

    • roles

      public List<String> roles()
      Hints for role names the user is expected to be in.
      Returns:
      list of hints

    • name

      public String name()
      Name of this instance.
      Returns:
      instance name, used when discovered from configuration

    • sockets

      public Set<String> sockets()
      List of sockets to register this feature on. If empty, it would get registered on all sockets.
      Returns:
      socket names to register on, defaults to empty (all available sockets)

    • servicesDiscoverServices

      public boolean servicesDiscoverServices()
      Service discovery flag for services(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • managerDiscoverServices

      public boolean managerDiscoverServices()
      Service discovery flag for manager(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance