Package com.codahale.metrics.servlets

Class MetricsServlet.ContextListener

java.lang.Object

com.codahale.metrics.servlets.MetricsServlet.ContextListener

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

Enclosing class:

MetricsServlet

public abstract static class MetricsServlet.ContextListener
extends Object
implements javax.servlet.ServletContextListener

An abstract ServletContextListener which allows you to programmatically inject the MetricRegistry, rate and duration units, and allowed origin for MetricsServlet.

Constructor Summary

Constructors

Constructor	Description
ContextListener()

Method Summary

Modifier and Type	Method	Description
void	contextDestroyed(javax.servlet.ServletContextEvent event)
void	contextInitialized(javax.servlet.ServletContextEvent event)
protected String	getAllowedOrigin()
protected TimeUnit	getDurationUnit()
protected String	getJsonpCallbackParameter()	Returns the name of the parameter used to specify the jsonp callback, if any.
protected com.codahale.metrics.MetricFilter	getMetricFilter()	Returns the MetricFilter that shall be used to filter metrics, or MetricFilter.ALL if the default should be used.
protected abstract com.codahale.metrics.MetricRegistry	getMetricRegistry()
protected TimeUnit	getRateUnit()

Methods inherited from class java.lang.Object

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

Constructor Details

ContextListener

public ContextListener()

Method Details

getMetricRegistry

protected abstract com.codahale.metrics.MetricRegistry getMetricRegistry()

Returns:

the MetricRegistry to inject into the servlet context.

getRateUnit

protected TimeUnit getRateUnit()

Returns:

the TimeUnit to which rates should be converted, or null if the default should be used.

getDurationUnit

protected TimeUnit getDurationUnit()

Returns:

the TimeUnit to which durations should be converted, or null if the default should be used.

getAllowedOrigin

protected String getAllowedOrigin()

Returns:

the Access-Control-Allow-Origin header value, if any.

getJsonpCallbackParameter

protected String getJsonpCallbackParameter()

Returns the name of the parameter used to specify the jsonp callback, if any.

getMetricFilter

protected com.codahale.metrics.MetricFilter getMetricFilter()

Returns the MetricFilter that shall be used to filter metrics, or MetricFilter.ALL if the default should be used.

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent event)

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent event)

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener