Package io.vertigo.vega.impl.webservice.healthcheck

Class HealthcheckWebServices

java.lang.Object

io.vertigo.vega.impl.webservice.healthcheck.HealthcheckWebServices

All Implemented Interfaces:

io.vertigo.core.node.component.Component, io.vertigo.core.node.component.CoreComponent, WebServices

@PathPrefix("/healthcheck")
public final class HealthcheckWebServices
extends Object
implements WebServices

Healthcheck WebService.

Author:

xdurand (30 mars 2017 18:00:02)

Constructor Summary

Constructors

Constructor	Description
HealthcheckWebServices()

Method Summary

Modifier and Type	Method	Description
List<io.vertigo.core.analytics.health.HealthCheck>	completeHealthcheck()	Complete node healthcheck WebService.
String	healthcheck()	Healthcheck WebService.
String	readinessHealthcheck()	Readiness node healthcheck WebService.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthcheckWebServices

public HealthcheckWebServices()

Method Details

healthcheck

@SessionLess
@AnonymousAccessAllowed
@GET("/ping")
public String healthcheck()

Healthcheck WebService.

Returns:

constant string "OK" that can be used to monitor the technical health.

completeHealthcheck

@SessionLess
@AnonymousAccessAllowed
@GET("/complete")
public List<io.vertigo.core.analytics.health.HealthCheck> completeHealthcheck()

Complete node healthcheck WebService.

Returns:

a complete health status of the node for all the monitored components.

readinessHealthcheck

@SessionLess
@AnonymousAccessAllowed
@GET("/readiness")
public String readinessHealthcheck()

Readiness node healthcheck WebService.

Returns:

a simple health status of the node for all the monitored components.

Throws:

IllegalStateException - if a component is not ready