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

Interface RestServiceSettings

public interface RestServiceSettings
Common settings across REST services.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    RestServiceSettings.Builder
    Builder for RestServiceSettings.

  • Method Summary

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

  • Method Details

    • create

      static RestServiceSettings create()
      Creates a new instance with default settings.
      Returns:
      new defaulted settings

    • create

      static RestServiceSettings create(io.helidon.config.Config config)
      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()
      Creates a builder to construct a new instance.
      Returns:
      new builder with defaulted settings

    • webContext

      String webContext()
      Returns the web context at which the service's endpoint can be accessed.
      Returns:
      web context for the endpoint

    • routing

      String routing()
      Returns the routing name to be used for the service's endpoint.
      Returns:
      routing name

    • crossOriginConfig

      io.helidon.cors.CrossOriginConfig crossOriginConfig()
      Returns the cross-origin config settings to be used for the service's endpoint.
      Returns:
      cross-origin settings

    • enabled

      boolean enabled()
      Whether this service is enabled and should be exposed.
      Returns:
      true for enabled services