Package io.vertx.mutiny.ext.healthchecks

Class HealthCheckHandler

java.lang.Object
io.vertx.mutiny.ext.healthchecks.HealthCheckHandler
All Implemented Interfaces:
MutinyDelegate, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>
public class HealthCheckHandler extends Object implements MutinyDelegate, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>
A Vert.x Web handler on which you register health check procedure. It computes the outcome status (`UP` or `DOWN`) . When the handler process a HTTP request, it computes the global outcome and build a HTTP response as follows:

  • 204 - status is `UP` but no procedures installed (no payload)
  • 200 - status is `UP`, the payload contains the result of the installed procedures
  • 503 - status is `DOWN`, the payload contains the result of the installed procedures
  • 500 - status is `DOWN`, the payload contains the result of the installed procedures, one of the procedure has failed

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • HealthCheckHandler

      public HealthCheckHandler(io.vertx.ext.healthchecks.HealthCheckHandler delegate)

    • HealthCheckHandler

      public HealthCheckHandler(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.healthchecks.HealthCheckHandler getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • handle

      public void handle(RoutingContext arg0)
      Specified by:
      handle in interface io.vertx.core.Handler<RoutingContext>

    • create

      public static HealthCheckHandler create(Vertx vertx, AuthenticationProvider provider)
      Parameters:
      vertx - the Vert.x instance, must not be null
      provider - the Authentication provider used to authenticate the HTTP request
      Returns:
      the created instance

    • create

      public static HealthCheckHandler create(Vertx vertx)
      Parameters:
      vertx - the Vert.x instance, must not be null
      Returns:
      the created instance

    • createWithHealthChecks

      public static HealthCheckHandler createWithHealthChecks(HealthChecks hc, AuthenticationProvider provider)
      Parameters:
      hc - the health checks object to use, must not be null
      provider -
      Returns:
      the created instance

    • createWithHealthChecks

      public static HealthCheckHandler createWithHealthChecks(HealthChecks hc)
      Parameters:
      hc - the health checks object to use
      Returns:
      the created instance

    • register

      public HealthCheckHandler register(String name, io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.Status> procedure)
      Parameters:
      name - the name of the procedure, must not be null or empty
      procedure - the procedure, must not be null
      Returns:

    • register

      public HealthCheckHandler register(String name, long timeout, io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.Status> procedure)
      Parameters:
      name - the name of the procedure, must not be null or empty
      timeout - the procedure timeout
      procedure - the procedure, must not be null
      Returns:

    • unregister

      public HealthCheckHandler unregister(String name)
      Parameters:
      name - the name of the procedure
      Returns:
      the current HealthCheckHandler

    • resultMapper

      public HealthCheckHandler resultMapper(Function<io.vertx.ext.healthchecks.CheckResult,io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.CheckResult>> resultMapper)
      Parameters:
      resultMapper - the used to manipulate the CheckResult, null means no result mapper function enabled.
      Returns:
      the current HealthCheckHandler

    • accept

      public void accept(RoutingContext item)
      Specified by:
      accept in interface Consumer<RoutingContext>

    • newInstance

      public static HealthCheckHandler newInstance(io.vertx.ext.healthchecks.HealthCheckHandler arg)