com.nimbusds.common.servlet

Class MonitorServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.codahale.metrics.servlets.AdminServlet

com.nimbusds.common.servlet.MonitorServlet

All Implemented Interfaces:

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

public class MonitorServlet
extends com.codahale.metrics.servlets.AdminServlet

Monitor servlet for exposing Dropwizard metrics and health checks, requires an OAuth 2.0 bearer token for access.

The token is defined in a Java property obtained from 1) system properties or from 2) a properties file specified by servlet context parameter.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_TOKEN_PROPERTY_NAME The property name for the API access token.
static int	MIN_TOKEN_LENGTH The min accepted web access token character length.
protected BasicAccessTokenValidator	tokenValidator The access token validator.

Fields inherited from class com.codahale.metrics.servlets.AdminServlet

DEFAULT_HEALTHCHECK_URI, DEFAULT_METRICS_URI, DEFAULT_PING_URI, DEFAULT_THREADS_URI, HEALTHCHECK_URI_PARAM_KEY, METRICS_URI_PARAM_KEY, PING_URI_PARAM_KEY, SERVICE_NAME_PARAM_KEY, THREADS_URI_PARAM_KEY

Constructor Summary

Constructors

Constructor and Description
MonitorServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
void	init(javax.servlet.ServletConfig config)
protected void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

API_TOKEN_PROPERTY_NAME

public static final String API_TOKEN_PROPERTY_NAME

The property name for the API access token.

See Also:

Constant Field Values

MIN_TOKEN_LENGTH

public static final int MIN_TOKEN_LENGTH

The min accepted web access token character length.

See Also:

Constant Field Values

tokenValidator

protected BasicAccessTokenValidator tokenValidator

The access token validator.

Constructor Detail

MonitorServlet

public MonitorServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class com.codahale.metrics.servlets.AdminServlet

Throws:

javax.servlet.ServletException

doGet

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

Overrides:

doGet in class com.codahale.metrics.servlets.AdminServlet

Throws:

javax.servlet.ServletException

IOException

service

protected void service(javax.servlet.http.HttpServletRequest req,
           javax.servlet.http.HttpServletResponse resp)
                throws javax.servlet.ServletException,
                       IOException

Overrides:

service in class com.codahale.metrics.servlets.AdminServlet

Throws:

javax.servlet.ServletException

IOException