|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.xwork.interceptor.TimerInterceptor
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.
trace, debug, info, warn, error, fatal
)? - defaut is info
com.mycompany.app
).
Default is to use com.opensymphony.xwork.interceptor.TimerInterceptor
.invokeUnderTiming
method.
<!-- 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>This second example uses our own log category at debug level.
<!-- records only the action's execution time --> <action name="someAction" class="com.examples.SomeAction"> <interceptor-ref name="completeStack"/> <interceptor-ref name="timer"> <param name="logLevel">debug</param> <param name="logCategory">com.mycompany.myapp.actiontime</param> <interceptor-ref/> <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>
Field Summary | |
protected org.apache.commons.logging.Log |
categoryLogger
|
protected static org.apache.commons.logging.Log |
log
|
protected String |
logCategory
|
protected String |
logLevel
|
Constructor Summary | |
TimerInterceptor()
|
Method Summary | |
void |
destroy()
Called to let an interceptor clean up any resources it has allocated. |
protected void |
doLog(org.apache.commons.logging.Log logger,
String message)
Performs the actual logging. |
String |
getLogCategory()
|
protected org.apache.commons.logging.Log |
getLoggerToUse()
Get's the logger to use. |
String |
getLogLevel()
|
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. |
protected String |
invokeUnderTiming(ActionInvocation invocation)
Is called to invoke the action invocation and time the execution time. |
void |
setLogCategory(String logCatgory)
|
void |
setLogLevel(String logLevel)
|
protected boolean |
shouldLog()
Determines if we should log the time. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final org.apache.commons.logging.Log log
protected org.apache.commons.logging.Log categoryLogger
protected String logCategory
protected String logLevel
Constructor Detail |
public TimerInterceptor()
Method Detail |
public String getLogCategory()
public void setLogCategory(String logCatgory)
public String getLogLevel()
public void setLogLevel(String logLevel)
public void destroy()
Interceptor
destroy
in interface Interceptor
public void init()
Interceptor
intercept
, giving
the Interceptor a chance to initialize any needed resources.
init
in interface Interceptor
public String intercept(ActionInvocation invocation) throws Exception
Interceptor
ActionInvocation
or to short-circuit the processing and just return a String return code.
intercept
in interface Interceptor
ActionInvocation.invoke()
, or from the interceptor itself.
Exception
- any system-level error, as defined in Action.execute()
.protected String invokeUnderTiming(ActionInvocation invocation) throws Exception
invocation
- the action invocation.
Exception
- can be thrown from the action.protected boolean shouldLog()
protected org.apache.commons.logging.Log getLoggerToUse()
protected void doLog(org.apache.commons.logging.Log logger, String message)
logger
- the provided logger to use.message
- the message to log.
|
XWork Project Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |