Package org.gcube.application.geoportal.service.rest

Class GeoportalHealth

java.lang.Object

org.gcube.application.geoportal.service.rest.GeoportalHealth

@Path("/health")
public class GeoportalHealth
extends Object

The Class GeoportalHealth.

Author:

Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it Oct 22, 2024

Constructor Summary

Constructors

Constructor	Description
GeoportalHealth()	Instantiates a new geoportal health.

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	databaseCheck(String context)	Database check.
javax.ws.rs.core.Response	mongoCheck(String context, Boolean includeCollections)	Mongo check.
javax.ws.rs.core.Response	serviceCheck()	Service check.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoportalHealth

public GeoportalHealth()

Instantiates a new geoportal health.

Method Detail

serviceCheck

@GET
@Path("")
@Produces("application/json")
public javax.ws.rs.core.Response serviceCheck()
                                       throws com.fasterxml.jackson.core.JsonProcessingException

Service check.

Returns:

the response compliant to `microprofile-health` specification. 200 if is OK. Otherwise it fails.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

mongoCheck

@GET
@Path("/mongo")
@Produces("application/json")
public javax.ws.rs.core.Response mongoCheck(@QueryParam("context")
                                            String context,
                                            @QueryParam("include_collections")
                                            Boolean includeCollections)
                                     throws com.fasterxml.jackson.core.JsonProcessingException

Mongo check.

Parameters:

context - the gcube context

include_collections - if the check has to include the mongo collections in the response

Returns:

the response compliant to `microprofile-health` specification

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

databaseCheck

@GET
@Path("/database")
@Produces("application/json")
public javax.ws.rs.core.Response databaseCheck(@QueryParam("context")
                                               String context)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

Database check.

Parameters:

context - the gcube context

Returns:

the response compliant to `microprofile-health` specification

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception