Module io.helidon.webserver.observe.health

Package io.helidon.webserver.observe.health

Class HealthObserverConfig.BuilderBase.HealthObserverConfigImpl

java.lang.Object

io.helidon.webserver.observe.ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

io.helidon.webserver.observe.health.HealthObserverConfig.BuilderBase.HealthObserverConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<HealthObserver>, HealthObserverConfig, ObserverConfigBase, Supplier<HealthObserver>

Enclosing class:

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

protected static class HealthObserverConfig.BuilderBase.HealthObserverConfigImpl
extends ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl
implements HealthObserverConfig, Supplier<HealthObserver>

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.health.HealthObserverConfig

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

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

ObserverConfigBase.Builder, ObserverConfigBase.BuilderBase<BUILDER extends ObserverConfigBase.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ObserverConfigBase>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthObserverConfigImpl(HealthObserverConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
HealthObserver	build()	Create a new instance of the runtime type from this config object.
Optional<Config>	config()	Config provided by the user (if any).
boolean	details()	Whether details should be printed.
String	endpoint()
boolean	equals(Object o)
List<String>	exclude()	Health check names to exclude in computing the overall health of the server.
HealthObserver	get()
int	hashCode()
List<HealthCheck>	healthChecks()	Health checks with implicit types.
String	name()	Name of this observer.
String	toString()
boolean	useSystemServices()	Whether to use services discovered by ServiceLoader.

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

enabled, name

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.webserver.observe.ObserverConfigBase

enabled

Constructor Details

HealthObserverConfigImpl

protected HealthObserverConfigImpl(HealthObserverConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public HealthObserver 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<HealthObserver>

Returns:

new configured runtime instance

get

public HealthObserver get()

Specified by:

get in interface Supplier<HealthObserver>

endpoint

public String endpoint()

Specified by:

endpoint in interface HealthObserverConfig

details

public boolean details()

Description copied from interface: HealthObserverConfig

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.

Specified by:

details in interface HealthObserverConfig

Returns:

set to true to enable details

healthChecks

public List<HealthCheck> healthChecks()

Description copied from interface: HealthObserverConfig

Health checks with implicit types.

Specified by:

healthChecks in interface HealthObserverConfig

Returns:

health checks to register with the observer

useSystemServices

public boolean useSystemServices()

Description copied from interface: HealthObserverConfig

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

Specified by:

useSystemServices in interface HealthObserverConfig

Returns:

set to false to disable discovery

config

public Optional<Config> config()

Description copied from interface: HealthObserverConfig

Config provided by the user (if any).

Specified by:

config in interface HealthObserverConfig

Returns:

configuration

exclude

public List<String> exclude()

Description copied from interface: HealthObserverConfig

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

Specified by:

exclude in interface HealthObserverConfig

Returns:

health check names to exclude

toString

public String toString()

Overrides:

toString in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

equals

public boolean equals(Object o)

Overrides:

equals in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ObserverConfigBase.BuilderBase.ObserverConfigBaseImpl

name

String name()

Description copied from interface: ObserverConfigBase

Name of this observer. Each observer should provide its own default for this property.

Specified by:

name in interface ObserverConfigBase

Returns:

observer name