Package org.nuxeo.ecm.core.management.statuses

Class StatusServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.nuxeo.ecm.core.management.statuses.StatusServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class StatusServlet
extends jakarta.servlet.http.HttpServlet

Servlet for retrieving Nuxeo services running status.

Since:

9.3 this servlet returns a status based of all the probes registered for the healthCheck.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM
static final String	PARAM_RELOAD
static final String	PARAM_STARTED
static final String	PARAM_SUMMARY
static final String	PARAM_SUMMARY_KEY
static final String	PROBE_PARAM

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
StatusServlet()

Method Summary

Modifier and Type	Method	Description
protected void	doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
protected void	doPost(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
protected HealthCheckResult	getOrRunHealthCheck(String probe)
protected void	getStartedInfo(StringBuilder response)
protected void	getSummaryInfo(StringBuilder response)
void	init()
protected void	sendHealthCheckResponse(jakarta.servlet.http.HttpServletResponse resp, HealthCheckResult result)
protected void	sendResponse(jakarta.servlet.http.HttpServletResponse resp, String response)

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, init, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object

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

Field Details

PARAM

public static final String PARAM

See Also:

• Constant Field Values

PARAM_STARTED

public static final String PARAM_STARTED

See Also:

• Constant Field Values

PARAM_SUMMARY

public static final String PARAM_SUMMARY

See Also:

• Constant Field Values

PARAM_SUMMARY_KEY

public static final String PARAM_SUMMARY_KEY

See Also:

• Constant Field Values

PARAM_RELOAD

public static final String PARAM_RELOAD

See Also:

• Constant Field Values

PROBE_PARAM

public static final String PROBE_PARAM

See Also:

• Constant Field Values

Constructor Details

StatusServlet

public StatusServlet()

Method Details

doGet

protected void doGet(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp)
              throws jakarta.servlet.ServletException,
IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

sendHealthCheckResponse

protected void sendHealthCheckResponse(jakarta.servlet.http.HttpServletResponse resp,
 HealthCheckResult result)
                                throws IOException

Throws:

IOException

doPost

protected void doPost(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse resp)
               throws jakarta.servlet.ServletException,
IOException

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

sendResponse

protected void sendResponse(jakarta.servlet.http.HttpServletResponse resp,
 String response)
                     throws IOException

Throws:

IOException

getSummaryInfo

protected void getSummaryInfo(StringBuilder response)

getStartedInfo

protected void getStartedInfo(StringBuilder response)

init

public void init()
          throws jakarta.servlet.ServletException

Overrides:

init in class jakarta.servlet.GenericServlet

Throws:

jakarta.servlet.ServletException

getOrRunHealthCheck

protected HealthCheckResult getOrRunHealthCheck(String probe)