Package io.jans.configapi.rest.health

Class ApiHealthCheck

java.lang.Object

io.jans.configapi.rest.health.ApiHealthCheck

@Path("/health")
@Consumes("application/json")
@Produces("application/json")
public class ApiHealthCheck
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiHealthCheck()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getApplicationVersion(String artifact)	Retrieve version information for the specified artifact.
jakarta.ws.rs.core.Response	getHealthResponse()
jakarta.ws.rs.core.Response	getLivenessResponse()
jakarta.ws.rs.core.Response	getReadinessResponse()
jakarta.ws.rs.core.Response	getServerStat()	Retrieve current application server statistics.
jakarta.ws.rs.core.Response	getServiceStatus(String service)	Retrieves status information for a specified service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiHealthCheck

public ApiHealthCheck()

Method Detail

getHealthResponse

@GET
public jakarta.ws.rs.core.Response getHealthResponse()

getLivenessResponse

@GET
@Path("/live")
public jakarta.ws.rs.core.Response getLivenessResponse()

getReadinessResponse

@GET
@Path("/ready")
public jakarta.ws.rs.core.Response getReadinessResponse()

getServerStat

@GET
@Path("/server-stat")
public jakarta.ws.rs.core.Response getServerStat()

Retrieve current application server statistics.

Returns:

a JAX-RS Response whose entity is a StatsData object containing current server statistics (returned with HTTP 200).

getApplicationVersion

@GET
@Path("/app-version")
public jakarta.ws.rs.core.Response getApplicationVersion(@DefaultValue("all") @QueryParam("artifact")
                                                         String artifact)

Retrieve version information for the specified artifact.

Parameters:

artifact - the artifact name to query; use "ALL" to request versions for all artifacts

Returns:

a Response whose entity is a JSON object containing version data for the requested artifact

getServiceStatus

@GET
@Path("/service-status")
public jakarta.ws.rs.core.Response getServiceStatus(@DefaultValue("all") @QueryParam("service")
                                                    String service)

Retrieves status information for a specified service.

Parameters:

service - the service name to check; use ApiConstants.ALL to request status for all services (default)

Returns:

a JsonNode containing the service status payload