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 Details

    • ApiHealthCheck

      public ApiHealthCheck()

  • Method Details

    • 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