com.opensymphony.xwork.interceptor
Class TimerInterceptor

java.lang.Object
  com.opensymphony.xwork.interceptor.TimerInterceptor

All Implemented Interfaces:

Interceptor

public class TimerInterceptor
extends Object
implements Interceptor

This interceptor logs the amount of time in milliseconds. In order for this interceptor to work properly, the logging framework must be set to at least the INFO level. This interceptor relies on the Commons Logging API to report its execution-time value. TODO: Describe the paramters for this Interceptor. TODO: Discuss some possible extension of the Interceptor.

 
 <!-- records only the action's execution time -->
 <action name="someAction" class="com.examples.SomeAction">
     <interceptor-ref name="completeStack"/>
     <interceptor-ref name="timer"/>
     <result name="success">good_result.ftl</result>
 </action>

 <!-- records action's execution time as well as other interceptors-->
 <action name="someAction" class="com.examples.SomeAction">
     <interceptor-ref name="timer"/>
     <interceptor-ref name="completeStack"/>
     <result name="success">good_result.ftl</result>
 </action>
 
 

Author:

Jason Carreira

Constructor Summary

TimerInterceptor()

Method Summary

void	destroy() Called to let an interceptor clean up any resources it has allocated.
boolean	equals(Object obj)
int	hashCode()
void	init() Called after an interceptor is created, but before any requests are processed using intercept , giving the Interceptor a chance to initialize any needed resources.
String	intercept(ActionInvocation invocation) Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the ActionInvocation or to short-circuit the processing and just return a String return code.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerInterceptor

public TimerInterceptor()

Method Detail

destroy

public void destroy()

Description copied from interface: Interceptor

Called to let an interceptor clean up any resources it has allocated.

Specified by:

destroy in interface Interceptor

init

public void init()

Description copied from interface: Interceptor

Called after an interceptor is created, but before any requests are processed using intercept , giving the Interceptor a chance to initialize any needed resources.

Specified by:

init in interface Interceptor

intercept

public String intercept(ActionInvocation invocation)
                 throws Exception

Description copied from interface: Interceptor

Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the ActionInvocation or to short-circuit the processing and just return a String return code.

Specified by:

intercept in interface Interceptor

Returns:

the return code, either returned from ActionInvocation.invoke(), or from the interceptor itself.

Throws:

Exception - any system-level error, as defined in Action.execute().

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object