org.wicketstuff.jamon.request.cycle

Class JamonMonitoredRequestCycleContext

java.lang.Object

org.wicketstuff.jamon.request.cycle.JamonMonitoredRequestCycleContext

public class JamonMonitoredRequestCycleContext
extends Object

To use this class simply create an instance and register it to request cycle. As a shortcut to register context in request cycle you can use registerTo(RequestCycle, boolean)

The responsibility of the JamonMonitoredRequestCycleContext is to add a monitor for all actions that will cause pages or parts of pages to be rendered.
The labels of the Monitors come in these formats:

• "PageName" - When a user navigates directly to a Page, for instance the HomePage, or a bookmarked Page.
• "PageName.toNextPage -> NextPage" - When the component toNextPage on the PageName page causes the user to navigate to the "NextPage" page and this JamonMonitoredRequestCycleContext has its property includeSourceNameInMonitorLabel set to true.
• "NextPage" - When the user navigates to the "NextPage" page from whatever page he was on and this JamonMonitoredRequestCycleContext has its property includeSourceNameInMonitorLabel set to false.

Any navigations from or to the JamonAdminPage is excluded from the Monitors.

Author:

lars

Constructor Summary

Constructors

Constructor and Description
JamonMonitoredRequestCycleContext(boolean includeSourceNameInMonitorLabel) Construct.

Method Summary

Modifier and Type	Method and Description
void	comesFromPage(Class<? extends org.apache.wicket.request.component.IRequestablePage> clazz) From which Page did the request come from? This is needed for creating the Monitor label.
void	dontMonitorThisRequest()
static JamonMonitoredRequestCycleContext	get(org.apache.wicket.request.cycle.RequestCycle cycle)
static void	registerTo(org.apache.wicket.request.cycle.RequestCycle cycle, boolean includeSourceNameInMonitorLabel)
void	setSource(String source) Sets the source.
void	setTarget(Class<? extends org.apache.wicket.request.component.IRequestablePage> destination) Set the target.
void	startTimeRequest()
void	stopTimeRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

JamonMonitoredRequestCycleContext

public JamonMonitoredRequestCycleContext(boolean includeSourceNameInMonitorLabel)

Construct.

Parameters:

includeSourceNameInMonitorLabel - whether or not to include the name of the source in the Monitors label.

Method Detail

registerTo

public static void registerTo(org.apache.wicket.request.cycle.RequestCycle cycle,
                              boolean includeSourceNameInMonitorLabel)

get

public static JamonMonitoredRequestCycleContext get(org.apache.wicket.request.cycle.RequestCycle cycle)

startTimeRequest

public final void startTimeRequest()

stopTimeRequest

public final void stopTimeRequest()

setSource

public void setSource(String source)

Sets the source.

Parameters:

source - The name of the source where the request originated from.

setTarget

public void setTarget(Class<? extends org.apache.wicket.request.component.IRequestablePage> destination)

Set the target.

Parameters:

destination - The name of the page that was rendered.

comesFromPage

public void comesFromPage(Class<? extends org.apache.wicket.request.component.IRequestablePage> clazz)

From which Page did the request come from? This is needed for creating the Monitor label.

Parameters:

clazz -

dontMonitorThisRequest

public final void dontMonitorThisRequest()