Module io.helidon.health

Package io.helidon.health

Class HealthSupport

java.lang.Object

io.helidon.servicecommon.rest.HelidonRestServiceSupport

io.helidon.health.HealthSupport

All Implemented Interfaces:

RestServiceSupport, Service

public final class HealthSupport
extends HelidonRestServiceSupport

Health check support for integration with webserver, to expose the health endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HealthSupport.Builder	Fluent API builder for HealthSupport.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_WEB_CONTEXT	Default web context root of the Health check endpoint.

Method Summary

Modifier and Type	Method	Description
static HealthSupport.Builder	builder()	Get a builder to configure health support instance.
static HealthSupport	create()	Create a new HealthSupport with no health checks configured.
static HealthSupport	create(Config config)	Create a new HealthSupport with no health checks, configured from provided config.
protected void	postConfigureEndpoint(Routing.Rules defaultRules, Routing.Rules serviceEndpointRoutingRules)	Concrete implementations override this method to perform any service-specific routing set-up.
void	update(Routing.Rules rules)	Updates Routing.Rules with handlers representing this service.

Methods inherited from class io.helidon.servicecommon.rest.HelidonRestServiceSupport

configureEndpoint, context, logger, onShutdown

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_WEB_CONTEXT

public static final String DEFAULT_WEB_CONTEXT

Default web context root of the Health check endpoint.

See Also:

• Constant Field Values

Method Details

update

public void update(Routing.Rules rules)

Description copied from interface: Service

Updates Routing.Rules with handlers representing this service.

Parameters:

rules - a routing rules to update

postConfigureEndpoint

protected void postConfigureEndpoint(Routing.Rules defaultRules,
 Routing.Rules serviceEndpointRoutingRules)

Description copied from class: HelidonRestServiceSupport

Concrete implementations override this method to perform any service-specific routing set-up.

Specified by:

postConfigureEndpoint in class HelidonRestServiceSupport

Parameters:

defaultRules - default Routing.Rules to be updated

serviceEndpointRoutingRules - actual rules (if different from the default ones) to be updated for the service endpoint

builder

public static HealthSupport.Builder builder()

Get a builder to configure health support instance.

Returns:

fluent API builder

create

public static HealthSupport create()

Create a new HealthSupport with no health checks configured. The endpoint will always return UP.

Returns:

health support configured with no health checks

create

public static HealthSupport create(Config config)

Create a new HealthSupport with no health checks, configured from provided config. The endpoint will always return UP.

Parameters:

config - configuration of this health check, used only to get web-context property to configure HelidonRestServiceSupport.Builder.webContext(String)

Returns:

health support configured with no health checks