Module io.helidon.webserver.observe.health

Package io.helidon.webserver.observe.health

Class HealthObserverConfig.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.webserver.observe.health.HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

HealthObserverConfig.Builder

Enclosing interface:

HealthObserverConfig

public abstract static class HealthObserverConfig.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>
extends ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for HealthObserverConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HealthObserverConfig.BuilderBase.HealthObserverConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	addCheck(HealthCheck check)	Health checks with implicit types.
BUILDER	addCheck(HealthCheck check, HealthCheckType type)	Add the provided health check using an explicit type (may differ from the HealthCheck.type().
BUILDER	addCheck(Supplier<HealthCheckResponse> responseSupplier, HealthCheckType type, String name)	Add a health check using the provided response supplier, type, and name.
BUILDER	addChecks(HealthCheck[] checks)	Add the provided health checks.
BUILDER	addExclude(List<String> exclude)	Health check names to exclude in computing the overall health of the server.
BUILDER	addExcluded(String excluded)	Health check names to exclude in computing the overall health of the server.
BUILDER	addHealthChecks(List<? extends HealthCheck> healthChecks)	Health checks with implicit types.
BUILDER	clearExclude()	Clear all exclude.
BUILDER	clearHealthChecks()	Clear all healthChecks.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
boolean	details()	Whether details should be printed.
BUILDER	details(boolean details)	Whether details should be printed.
String	endpoint()	Endpoint option.
BUILDER	endpoint(String endpoint)	Endpoint option.
List<String>	exclude()	Health check names to exclude in computing the overall health of the server.
BUILDER	exclude(List<String> exclude)	Health check names to exclude in computing the overall health of the server.
BUILDER	from(HealthObserverConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(HealthObserverConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
List<HealthCheck>	healthChecks()	Health checks with implicit types.
BUILDER	healthChecks(List<? extends HealthCheck> healthChecks)	Health checks with implicit types.
protected void	preBuildPrototype()	Handles providers and decorators.
String	toString()
boolean	useSystemServices()	Whether to use services discovered by ServiceLoader.
BUILDER	useSystemServices(boolean useSystemServices)	Whether to use services discovered by ServiceLoader.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.webserver.observe.ObserverConfigBase.BuilderBase

config, enabled, enabled, from, from, name, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(HealthObserverConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(HealthObserverConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

addCheck

public BUILDER addCheck(HealthCheck check,
 HealthCheckType type)

Add the provided health check using an explicit type (may differ from the HealthCheck.type().

Parameters:

check - health check to add

type - type to use

Returns:

updated builder instance

addCheck

public BUILDER addCheck(Supplier<HealthCheckResponse> responseSupplier,
 HealthCheckType type,
 String name)

Add a health check using the provided response supplier, type, and name.

Parameters:

responseSupplier - supplier of the health check response

type - type to use

name - name to use for the health check

Returns:

updated builder instance

addChecks

public BUILDER addChecks(HealthCheck[] checks)

Add the provided health checks.

Parameters:

checks - health checks to add

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

Overrides:

config in class ObserverConfigBase.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

endpoint

public BUILDER endpoint(String endpoint)

Endpoint option.

Parameters:

endpoint - the endpoint option

Returns:

updated builder instance

See Also:

• endpoint()

details

public BUILDER details(boolean details)

Whether details should be printed. By default, health only returns a Status.NO_CONTENT_204 for success, Status.SERVICE_UNAVAILABLE_503 for health down, and Status.INTERNAL_SERVER_ERROR_500 in case of error with no entity. When details are enabled, health returns Status.OK_200 for success, same codes otherwise and a JSON entity with detailed information about each health check executed.

Parameters:

details - set to true to enable details

Returns:

updated builder instance

See Also:

• details()

clearHealthChecks

public BUILDER clearHealthChecks()

Clear all healthChecks.

Returns:

updated builder instance

See Also:

• healthChecks()

healthChecks

public BUILDER healthChecks(List<? extends HealthCheck> healthChecks)

Health checks with implicit types.

Parameters:

healthChecks - health checks to register with the observer

Returns:

updated builder instance

See Also:

• healthChecks()

addHealthChecks

public BUILDER addHealthChecks(List<? extends HealthCheck> healthChecks)

Health checks with implicit types.

Parameters:

healthChecks - health checks to register with the observer

Returns:

updated builder instance

See Also:

• healthChecks()

addCheck

public BUILDER addCheck(HealthCheck check)

Health checks with implicit types.

Parameters:

check - add single health checks to register with the observer

Returns:

updated builder instance

See Also:

• healthChecks()

useSystemServices

public BUILDER useSystemServices(boolean useSystemServices)

Whether to use services discovered by ServiceLoader. By default, all HealthCheckProvider based health checks are added.

Parameters:

useSystemServices - set to false to disable discovery

Returns:

updated builder instance

See Also:

• useSystemServices()

clearExclude

public BUILDER clearExclude()

Clear all exclude.

Returns:

updated builder instance

See Also:

• exclude()

exclude

public BUILDER exclude(List<String> exclude)

Health check names to exclude in computing the overall health of the server.

Parameters:

exclude - health check names to exclude

Returns:

updated builder instance

See Also:

• exclude()

addExclude

public BUILDER addExclude(List<String> exclude)

Health check names to exclude in computing the overall health of the server.

Parameters:

exclude - health check names to exclude

Returns:

updated builder instance

See Also:

• exclude()

addExcluded

public BUILDER addExcluded(String excluded)

Health check names to exclude in computing the overall health of the server.

Parameters:

excluded - add single health check names to exclude

Returns:

updated builder instance

See Also:

• exclude()

endpoint

public String endpoint()

Endpoint option.

Returns:

the endpoint option

details

public boolean details()

Whether details should be printed. By default, health only returns a Status.NO_CONTENT_204 for success, Status.SERVICE_UNAVAILABLE_503 for health down, and Status.INTERNAL_SERVER_ERROR_500 in case of error with no entity. When details are enabled, health returns Status.OK_200 for success, same codes otherwise and a JSON entity with detailed information about each health check executed.

Returns:

set to true to enable details

healthChecks

public List<HealthCheck> healthChecks()

Health checks with implicit types.

Returns:

health checks to register with the observer

useSystemServices

public boolean useSystemServices()

Whether to use services discovered by ServiceLoader. By default, all HealthCheckProvider based health checks are added.

Returns:

set to false to disable discovery

exclude

public List<String> exclude()

Health check names to exclude in computing the overall health of the server.

Returns:

health check names to exclude

toString

public String toString()

Overrides:

toString in class ObserverConfigBase.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ObserverConfigBase.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ObserverConfigBase.BuilderBase<BUILDER extends HealthObserverConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends HealthObserverConfig>