Class HealthSupport

All Implemented Interfaces:
RestServiceSupport, Service

public final class HealthSupport extends HelidonRestServiceSupport
Health check support for integration with webserver, to expose the health endpoint.
  • Field Details


      public static final String DEFAULT_WEB_CONTEXT
      Default web context root of the Health check endpoint.
      See Also:
  • Method Details

    • update

      public void update(Routing.Rules rules)
      Description copied from interface: Service
      Updates Routing.Rules with handlers representing this service.
      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
      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.
      fluent API builder
    • create

      public static HealthSupport create()
      Create a new HealthSupport with no health checks configured. The endpoint will always return UP.
      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.
      config - configuration of this health check, used only to get web-context property to configure HelidonRestServiceSupport.Builder.webContext(String)
      health support configured with no health checks