org.apache.felix.hc.core.impl.servlet

Class HealthCheckExecutorServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.felix.hc.core.impl.servlet.HealthCheckExecutorServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class HealthCheckExecutorServlet
extends javax.servlet.http.HttpServlet

Servlet that triggers the health check executor to return results via http. Parameters:

• tags: The health check tags to take into account
• format: html|json|jsonp|txt|verbose.txt
• includeDebug: If true, debug messages from result log are included.
• callback: For jsonp, the JS callback function name (defaults to "processHealthCheckResults")
• httpStatus: health check status to http status mapping in format httpStatus=WARN:418,CRITICAL:503,HEALTH_CHECK_ERROR:500.

For omitted health check status values the next best code will be used (e.g. for httpStatus=CRITICAL:503 a result WARN will return 200, CRITICAL 503 and HEALTH_CHECK_ERROR also 503). By default all requests answer with an http status of 200.

Useful in combination with load balancers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_SPLIT_REGEX

Constructor Summary

Constructors

Constructor and Description
HealthCheckExecutorServlet()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.apache.felix.hc.core.impl.servlet.HealthCheckExecutorServletConfiguration configuration)
void	deactivate()
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String pathTokensStr, String format)

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_SPLIT_REGEX

public static final String PARAM_SPLIT_REGEX

See Also:

Constant Field Values

Constructor Detail

HealthCheckExecutorServlet

public HealthCheckExecutorServlet()

Method Detail

activate

protected final void activate(org.apache.felix.hc.core.impl.servlet.HealthCheckExecutorServletConfiguration configuration)

deactivate

public void deactivate()

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     String pathTokensStr,
                     String format)
              throws javax.servlet.ServletException,
                     IOException

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException