io.vertx.ext.healthchecks.impl

Class HealthCheckHandlerImpl

java.lang.Object

io.vertx.ext.healthchecks.impl.HealthCheckHandlerImpl

All Implemented Interfaces:

Handler<RoutingContext>, HealthCheckHandler

public class HealthCheckHandlerImpl
extends Object
implements HealthCheckHandler

Author:

Clement Escoffier

Constructor Summary

Constructors

Constructor and Description
HealthCheckHandlerImpl(HealthChecks hc, AuthenticationProvider provider)
HealthCheckHandlerImpl(Vertx vertx, AuthenticationProvider provider)

Method Summary

Modifier and Type	Method and Description
void	handle(RoutingContext rc) Something has happened, so handle it.
HealthCheckHandler	register(String name, Handler<Promise<Status>> procedure) Registers a health check procedure.
HealthCheckHandler	register(String name, long timeout, Handler<Promise<Status>> procedure) Registers a health check procedure.
HealthCheckHandler	unregister(String name) Unregisters a procedure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.healthchecks.HealthCheckHandler

create, create, createWithHealthChecks, createWithHealthChecks

Constructor Detail

HealthCheckHandlerImpl

public HealthCheckHandlerImpl(Vertx vertx,
                              AuthenticationProvider provider)

HealthCheckHandlerImpl

public HealthCheckHandlerImpl(HealthChecks hc,
                              AuthenticationProvider provider)

Method Detail

register

public HealthCheckHandler register(String name,
                                   Handler<Promise<Status>> procedure)

Description copied from interface: HealthCheckHandler

Registers a health check procedure.

The procedure is a Handler taking a Promise of Status as parameter. Procedures are asynchronous, and must complete or fail the given Promise. If the future object is failed, the procedure outcome is considered as `DOWN`. If the future is completed without any object, the procedure outcome is considered as `UP`. If the future is completed with a (not-null) Status, the procedure outcome is the received status.

This method uses a 1s timeout. To configure the timeout use HealthCheckHandler.register(String, long, Handler).

Specified by:

register in interface HealthCheckHandler

Parameters:

name - the name of the procedure, must not be null or empty

procedure - the procedure, must not be null

Returns:

the current HealthCheckHandler

register

public HealthCheckHandler register(String name,
                                   long timeout,
                                   Handler<Promise<Status>> procedure)

Description copied from interface: HealthCheckHandler

Registers a health check procedure.

The procedure is a Handler taking a Promise of Status as parameter. Procedures are asynchronous, and must complete or fail the given Promise. If the future object is failed, the procedure outcome is considered as `DOWN`. If the future is completed without any object, the procedure outcome is considered as `UP`. If the future is completed with a (not-null) Status, the procedure outcome is the received status.

Specified by:

register in interface HealthCheckHandler

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:

the current HealthCheckHandler

handle

public void handle(RoutingContext rc)

Description copied from interface: Handler

Something has happened, so handle it.

Specified by:

handle in interface Handler<RoutingContext>

Parameters:

rc - the event to handle

unregister

public HealthCheckHandler unregister(String name)

Description copied from interface: HealthCheckHandler

Unregisters a procedure.

Specified by:

unregister in interface HealthCheckHandler

Parameters:

name - the name of the procedure

Returns:

the current HealthCheckHandler