Package mc.core.domain.system

Class HealthCheckRI

java.lang.Object

mc.core.system.base.BaseBean

mc.core.domain.system.HealthCheckRI

@Path("/")
@Produces("text/plain")
public class HealthCheckRI
extends mc.core.system.base.BaseBean

The health check class provides a single HTTP endpoint

 /mc/rs/healthcheck
 

to check the health of an MC system without having to perform an authentication. The health check returns SYSTEM_STATUS_OK or SYSTEM_STATUS_ERROR. Any additional information regarding the nature of the error are available in the logfile but not exposed to the external consumer. The primary use case is for load balancing proxies to determine whether a node is available for use in the cluster.

Constructor Summary

Constructors

Constructor	Description
HealthCheckRI()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	healthCheck()	basic health check: can server connect to database and retrieve the DBInfo singleton
javax.ws.rs.core.Response	refreshLicence()

Methods inherited from class java.lang.Object

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

Constructor Details

HealthCheckRI

public HealthCheckRI()

Method Details

healthCheck

@GET
@Path("healthcheck")
public javax.ws.rs.core.Response healthCheck()
                                      throws ApplicationException

basic health check: can server connect to database and retrieve the DBInfo singleton

Throws:

ApplicationException

refreshLicence

@GET
@Path("refreshlicence")
public javax.ws.rs.core.Response refreshLicence()
                                         throws ApplicationException

Throws:

ApplicationException