Module io.helidon.servicecommon
Package io.helidon.webserver.servicecommon

Interface RestServiceSettings.Builder

All Superinterfaces:
Builder<RestServiceSettings.Builder,RestServiceSettings>, Supplier<RestServiceSettings>
Enclosing interface:
RestServiceSettings
public static interface RestServiceSettings.Builder extends Builder<RestServiceSettings.Builder,RestServiceSettings>
Builder for RestServiceSettings.

  • Field Details

    • ROUTING_NAME_CONFIG_KEY

      static final String ROUTING_NAME_CONFIG_KEY
      Config key for the routing name setting.
      See Also:

    • WEB_CONTEXT_CONFIG_KEY

      static final String WEB_CONTEXT_CONFIG_KEY
      Config key for the web context setting.
      See Also:

  • Method Details

    • webContext

      RestServiceSettings.Builder webContext(String webContext)
      Sets the web context to use for the service's endpoint.
      Parameters:
      webContext - web context
      Returns:
      updated builder

    • routing

      RestServiceSettings.Builder routing(String routing)
      Sets the routing name to use for setting up the service's endpoint.
      Parameters:
      routing - routing name as defined in the server settings
      Returns:
      updated builder

    • crossOriginConfig

      RestServiceSettings.Builder crossOriginConfig(CrossOriginConfig.Builder crossOriginConfigBuilder)
      Sets the cross-origin config builder for use in establishing CORS support for the service endpoints.
      Parameters:
      crossOriginConfigBuilder - builder for the CORS settings
      Returns:
      updated builder

    • enabled

      RestServiceSettings.Builder enabled(boolean enabled)
      Is this service enabled or not.
      Parameters:
      enabled - set to false to disable this service
      Returns:
      updated builder

    • crossOriginConfig

      RestServiceSettings.Builder crossOriginConfig(CrossOriginConfig crossOriginConfig)
      Sets the cross-origin settings from existing settings (not from a builder).
      Parameters:
      crossOriginConfig - existing cross-origin settings
      Returns:
      updated builder

    • config

      RestServiceSettings.Builder config(Config serviceConfig)
      Updates settings using the provided Config node for the service of interest.
      Parameters:
      serviceConfig - config node for the service
      Returns:
      updated builder

    • build

      RestServiceSettings build()
      Creates the RestServiceSettings instance from the builder settings.
      Specified by:
      build in interface Builder<RestServiceSettings.Builder,RestServiceSettings>
      Returns:
      new RestServiceSettings