Class ConfigObserveProvider

java.lang.Object

io.helidon.webserver.observe.config.ConfigObserveProvider

All Implemented Interfaces:

ConfiguredProvider<Observer>, ObserveProvider

@Singleton
public class ConfigObserveProvider
extends Object
implements ObserveProvider

Config observe provider implementation, discoverable through ServiceRegistry and ServiceLoader.

Constructor Summary

Constructors

Constructor	Description
ConfigObserveProvider()	Required public constructor for ServiceLoader.

Method Summary

Modifier and Type	Method	Description
String	configKey()	Configuration key of this provider.
Observer	create(Config config, String name)	Create a new instance from the configuration located on the provided node.
Observer	create(Config config, String name, ServiceRegistry serviceRegistry)	Create a new instance from configuration using services from the registry which owns the configured instance.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ObserveProvider

type

Modifier and Type	Method	Description
default String	type()	Type of this observe provider, to map to Observer when explicitly configured by user (so we do not duplicate observers).

Constructor Details

ConfigObserveProvider

public ConfigObserveProvider()

Required public constructor for ServiceLoader.

Method Details

configKey

public String configKey()

Description copied from interface: ObserveProvider

Configuration key of this provider. The following keys must be honored by Observe support:

• enabled - enable/disable the service
• endpoint - endpoint, if starts with / then absolute, otherwise relative to observe endpoint
• cors - CORS setup for this endpoint

Specified by:

configKey in interface ConfiguredProvider<Observer>

Specified by:

configKey in interface ObserveProvider

Returns:

configuration key of this provider (such as health)

create

public Observer create(Config config,
 String name)

Description copied from interface: ConfiguredProvider

Create a new instance from the configuration located on the provided node.

Specified by:

create in interface ConfiguredProvider<Observer>

Parameters:

config - located at ConfiguredProvider.configKey() node

name - name of the configured implementation

Returns:

a new instance created from this config node

create

public Observer create(Config config,
 String name,
 ServiceRegistry serviceRegistry)

Description copied from interface: ConfiguredProvider

Create a new instance from configuration using services from the registry which owns the configured instance.

The default implementation delegates to ConfiguredProvider.create(Config, String) for backward compatibility.

Specified by:

create in interface ConfiguredProvider<Observer>

Parameters:

config - located at ConfiguredProvider.configKey() node

name - name of the configured implementation

serviceRegistry - service registry which owns the configured instance

Returns:

a new instance created from this config node