Module io.helidon.config

Package io.helidon.config

Interface ConfiguredProvider<T extends NamedService>

Type Parameters:

T - type of the service this provider provides

All Superinterfaces:

ConfiguredProvider<T>

All Known Subinterfaces:

ContentEncodingProvider, DataSourceConfigProvider, GrpcClientServiceProvider, GrpcServerServiceProvider, JdbcConnectionPoolProvider, LimitProvider, MediaSupportProvider, ObserveProvider, OpenApiManagerProvider, OpenApiServiceProvider, ProtocolConfigProvider<T>, ProtocolConfigProvider<T>, ServerFeatureProvider<T>, TlsManagerProvider, WebClientServiceProvider

All Known Implementing Classes:

AccessLogFeatureProvider, AimdLimitProvider, ConfigObserveProvider, ContextFeatureProvider, CorsFeatureProvider, DefaultOciCertificatesTlsManagerProvider, DeflateEncodingProvider, EurekaRegistrationServerFeatureProvider, FixedLimitProvider, GrpcClientTracingProvider, GrpcProtocolConfigProvider, GrpcReflectionFeatureProvider, GrpcTracingServiceProvider, GsonMediaSupportProvider, GzipEncodingProvider, HealthObserveProvider, HikariConnectionPoolProvider, HikariDataSourceConfigProvider, Http1ProtocolConfigProvider, Http1ProtocolConfigProvider, Http2ProtocolConfigProvider, Http2ProtocolConfigProvider, InfoObserveProvider, JacksonMediaSupportProvider, JdbcDataSourceConfigProvider, JsonBindingMediaSupportProvider, JsonbMediaSupportProvider, JsonMediaSupportProvider, JsonpMediaSupportProvider, LimitsFeatureProvider, LogObserveProvider, MetricsObserveProvider, MultiPartSupportProvider, ObserveFeatureProvider, OpenApiFeatureProvider, OpenApiUiProvider, RequestScopeFeatureProvider, SecurityFeatureProvider, StaticContentFeatureProvider, ThroughputLimitProvider, TracingObserveProvider, UcpDataSourceConfigProvider, WebClientContextServiceProvider, WebClientDiscoveryProvider, WebClientMetricsProvider, WebClientSecurityProvider, WebClientTelemetryProvider, WebClientTracingProvider, WebServerValidationFeatureProvider, WsProtocolConfigProvider, WsProtocolConfigProvider

public interface ConfiguredProvider<T extends NamedService>
extends ConfiguredProvider<T>

Providers that can be loaded from configuration should implement this interface.

Method Summary

Modifier and Type	Method	Description
String	configKey()	Key this service implementation is stored under.
default T	create(Config config, String name)	Deprecated, for removal: This API element is subject to removal in a future version. use create(Config, String) instead
default T	create(Config config, String name)	Create a new instance from the configuration located on the provided node.

Method Details

configKey

String configKey()

Key this service implementation is stored under. This is also considered the service "type" when used in a list in configuration, to allow the same service defined more than once.

Specified by:

configKey in interface ConfiguredProvider<T extends NamedService>

Returns:

key of this implementation

create

@Deprecated(since="4.4.0",
            forRemoval=true)
default T create(Config config,
 String name)

Deprecated, for removal: This API element is subject to removal in a future version.

use create(Config, String) instead

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

Specified by:

create in interface ConfiguredProvider<T extends NamedService>

Parameters:

config - located at ConfiguredProvider.configKey() node

name - name of the configured implementation

Returns:

a new instance created from this config node

create

default T create(Config config,
 String name)

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

API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

Parameters:

config - located at configKey() node

name - name of the configured implementation

Returns:

a new instance created from this config node

Since:

4.4.0