Module io.helidon.webserver.observe
Package io.helidon.webserver.observe

Class ObserveFeatureConfig.BuilderBase.ObserveFeatureConfigImpl

java.lang.Object
io.helidon.webserver.observe.ObserveFeatureConfig.BuilderBase.ObserveFeatureConfigImpl
All Implemented Interfaces:
Prototype.Api, Prototype.Factory<ObserveFeature>, ObserveFeatureConfig, Supplier<ObserveFeature>
Enclosing class:
ObserveFeatureConfig.BuilderBase<BUILDER extends ObserveFeatureConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ObserveFeatureConfig>
protected static class ObserveFeatureConfig.BuilderBase.ObserveFeatureConfigImpl extends Object implements ObserveFeatureConfig, Supplier<ObserveFeature>
Generated implementation of the prototype, can be extended by descendant prototype implementations.

  • Constructor Details

    • ObserveFeatureConfigImpl

      protected ObserveFeatureConfigImpl(ObserveFeatureConfig.BuilderBase<?,?> builder)
      Create an instance providing a builder.
      Parameters:
      builder - extending builder base of this prototype

  • Method Details

    • build

      public ObserveFeature build()
      Description copied from interface: Prototype.Factory
      Create a new instance of the runtime type from this config object.
      Specified by:
      build in interface Prototype.Factory<ObserveFeature>
      Returns:
      new configured runtime instance

    • get

      public ObserveFeature get()
      Specified by:
      get in interface Supplier<ObserveFeature>

    • cors

      public CrossOriginConfig cors()
      Description copied from interface: ObserveFeatureConfig
      Cors support inherited by each observe provider, unless explicitly configured.
      Specified by:
      cors in interface ObserveFeatureConfig
      Returns:
      cors support to use

    • enabled

      public boolean enabled()
      Description copied from interface: ObserveFeatureConfig
      Whether the observe support is enabled.
      Specified by:
      enabled in interface ObserveFeatureConfig
      Returns:
      false to disable observe feature

    • endpoint

      public String endpoint()
      Description copied from interface: ObserveFeatureConfig
      Root endpoint to use for observe providers. By default, all observe endpoint are under this root endpoint.

      Example:
      If root endpoint is /observe (the default), and default health endpoint is health (relative), health endpoint would be /observe/health.

      Specified by:
      endpoint in interface ObserveFeatureConfig
      Returns:
      endpoint to use

    • weight

      public double weight()
      Description copied from interface: ObserveFeatureConfig
      Change the weight of this feature. This may change the order of registration of this feature. By default, observability weight is 80.0 so it is registered after routing.
      Specified by:
      weight in interface ObserveFeatureConfig
      Returns:
      weight to use

    • observers

      public List<Observer> observers()
      Description copied from interface: ObserveFeatureConfig
      Observers to use with this observe features. Each observer type is registered only once, unless it uses a custom name (default name is the same as the type).
      Specified by:
      observers in interface ObserveFeatureConfig
      Returns:
      list of observers to use in this feature

    • config

      public Optional<Config> config()
      Description copied from interface: ObserveFeatureConfig
      Configuration of the observe feature, if present.
      Specified by:
      config in interface ObserveFeatureConfig
      Returns:
      config node of the feature

    • sockets

      public List<String> sockets()
      Description copied from interface: ObserveFeatureConfig
      Sockets the observability endpoint should be exposed on. If not defined, defaults to the default socket ("@default". Each observer may have its own configuration of sockets that are relevant to it, this only controls the endpoints!
      Specified by:
      sockets in interface ObserveFeatureConfig
      Returns:
      list of sockets to register observe endpoint on

    • name

      public String name()
      Description copied from interface: ObserveFeatureConfig
      Name of this instance.
      Specified by:
      name in interface ObserveFeatureConfig
      Returns:
      instance name

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object