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

Interface RestServiceSettings

@Deprecated(forRemoval=true, since="4.4.0") public interface RestServiceSettings
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; as this class's reason for existence was mostly CORS, it will be removed in a future release of Helidon; implement HttpService directly instead
Common settings across REST services.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RestServiceSettings.Builder
    Deprecated, for removal: This API element is subject to removal in a future version.
    Builder for RestServiceSettings.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RestServiceSettings.Builder
    builder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a builder to construct a new instance.
    static RestServiceSettings
    create()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new instance with default settings.
    static RestServiceSettings
    create(Config config)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new instance using values from the provided config.
    CrossOriginConfig
    crossOriginConfig()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the cross-origin config settings to be used for the service's endpoint.
    boolean
    enabled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Whether this service is enabled and should be exposed.
    String
    routing()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the routing name to be used for the service's endpoint.
    String
    webContext()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the web context at which the service's endpoint can be accessed.

  • Method Details

    • create

      static RestServiceSettings create()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new instance with default settings.
      Returns:
      new defaulted settings

    • create

      static RestServiceSettings create(Config config)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new instance using values from the provided config.
      Parameters:
      config - Config node possibly containing REST service settings
      Returns:
      new initialized settings

    • builder

      static RestServiceSettings.Builder builder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a builder to construct a new instance.
      Returns:
      new builder with defaulted settings

    • webContext

      String webContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the web context at which the service's endpoint can be accessed.
      Returns:
      web context for the endpoint

    • routing

      String routing()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the routing name to be used for the service's endpoint.
      Returns:
      routing name

    • crossOriginConfig

      CrossOriginConfig crossOriginConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the cross-origin config settings to be used for the service's endpoint.
      Returns:
      cross-origin settings

    • enabled

      boolean enabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Whether this service is enabled and should be exposed.
      Returns:
      true for enabled services