org.jboss.weld.probe

Class ProbeFilter

java.lang.Object

org.jboss.weld.probe.ProbeFilter

All Implemented Interfaces:

javax.servlet.Filter

public class ProbeFilter
extends Object
implements javax.servlet.Filter

This filter takes care of the servlet integration. Basically, it:

• implements a simple REST API,
• allows to group together monitored invocations within the same request,
• allows to embed an informative HTML snippet to every response with Content-Type of value text/html.

An integrator is required to register this filter. The filter should only be mapped to a single URL pattern of value /*.

To disable the clippy support, set ConfigurationKey.PROBE_EMBED_INFO_SNIPPET to false. It's also possible to use the ConfigurationKey.PROBE_INVOCATION_MONITOR_EXCLUDE_TYPE to skip the monitoring.

Author:

Martin Kouba

See Also:

ConfigurationKey.PROBE_EMBED_INFO_SNIPPET, ConfigurationKey.PROBE_INVOCATION_MONITOR_EXCLUDE_TYPE

Constructor Summary

Constructors

Constructor and Description
ProbeFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbeFilter

public ProbeFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter