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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.helidon.webserver.observe.ObserveFeatureConfig
ObserveFeatureConfig.Builder, ObserveFeatureConfig.BuilderBase<BUILDER extends ObserveFeatureConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends ObserveFeatureConfig> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ObserveFeatureConfigImpl
(ObserveFeatureConfig.BuilderBase<?, ?> builder) Create an instance providing a builder. -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Create a new instance of the runtime type from this config object.config()
Configuration of the observe feature, if present.cors()
Cors support inherited by each observe provider, unless explicitly configured.boolean
enabled()
Whether the observe support is enabled.endpoint()
Root endpoint to use for observe providers.boolean
get()
int
hashCode()
name()
Name of this instance.Observers to use with this observe features.sockets()
Sockets the observability endpoint should be exposed on.toString()
double
weight()
Change the weight of this feature.
-
Constructor Details
-
ObserveFeatureConfigImpl
Create an instance providing a builder.- Parameters:
builder
- extending builder base of this prototype
-
-
Method Details
-
build
Description copied from interface:Prototype.Factory
Create a new instance of the runtime type from this config object.- Specified by:
build
in interfacePrototype.Factory<ObserveFeature>
- Returns:
- new configured runtime instance
-
get
- Specified by:
get
in interfaceSupplier<ObserveFeature>
-
cors
Description copied from interface:ObserveFeatureConfig
Cors support inherited by each observe provider, unless explicitly configured.- Specified by:
cors
in interfaceObserveFeatureConfig
- Returns:
- cors support to use
-
enabled
public boolean enabled()Description copied from interface:ObserveFeatureConfig
Whether the observe support is enabled.- Specified by:
enabled
in interfaceObserveFeatureConfig
- Returns:
false
to disable observe feature
-
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 ishealth
(relative), health endpoint would be/observe/health
.- Specified by:
endpoint
in interfaceObserveFeatureConfig
- 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 interfaceObserveFeatureConfig
- Returns:
- weight to use
-
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 interfaceObserveFeatureConfig
- Returns:
- list of observers to use in this feature
-
config
Description copied from interface:ObserveFeatureConfig
Configuration of the observe feature, if present.- Specified by:
config
in interfaceObserveFeatureConfig
- Returns:
- config node of the feature
-
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 interfaceObserveFeatureConfig
- Returns:
- list of sockets to register observe endpoint on
-
name
Description copied from interface:ObserveFeatureConfig
Name of this instance.- Specified by:
name
in interfaceObserveFeatureConfig
- Returns:
- instance name
-
toString
-
equals
-
hashCode
public int hashCode()
-