org.apache.fulcrum.yaafi.interceptor.performance

Class PerformanceInterceptorServiceImpl

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.fulcrum.yaafi.interceptor.baseservice.BaseInterceptorServiceImpl

org.apache.fulcrum.yaafi.interceptor.performance.PerformanceInterceptorServiceImpl

All Implemented Interfaces:

org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.configuration.Reconfigurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.thread.ThreadSafe, AvalonInterceptorService, PerformanceInterceptorService

public class PerformanceInterceptorServiceImpl
extends BaseInterceptorServiceImpl
implements PerformanceInterceptorService, org.apache.avalon.framework.configuration.Reconfigurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.thread.ThreadSafe

A service logging the execution time of service invocations.

Author:

Siegfried Goeschl

Field Summary

Fields inherited from interface org.apache.fulcrum.yaafi.framework.interceptor.AvalonInterceptorService

ON_ENTRY, ON_ERROR, ON_EXIT

Constructor Summary

Constructors

Constructor and Description
PerformanceInterceptorServiceImpl() Constructor

Method Summary

Modifier and Type	Method and Description
void	configure(org.apache.avalon.framework.configuration.Configuration configuration)
protected void	createStopWatch(AvalonInterceptorContext interceptorContext) Creates a stop watch
protected StopWatch	getStopWatch(AvalonInterceptorContext interceptorContext) Gets the stop watch
protected void	log(int mode, AvalonInterceptorContext interceptorContext, StopWatch stopWatch) Logs the execution time.
void	onEntry(AvalonInterceptorContext interceptorContext) Called before a service method is invoked.
void	onError(AvalonInterceptorContext interceptorContext, Throwable t) Called when a service method throws an exeption
void	onExit(AvalonInterceptorContext interceptorContext, Object result) Called after a service method was invoked.
void	reconfigure(org.apache.avalon.framework.configuration.Configuration configuration)
protected String	toString(AvalonInterceptorContext interceptorContext, StopWatch stopWatch, int mode) Create the log message for the performance logfile.
protected String	toString(Object[] args) Prints the argument list.

Methods inherited from class org.apache.fulcrum.yaafi.interceptor.baseservice.BaseInterceptorServiceImpl

contextualize, getClassLoader, getServiceApplicationDir, getServiceManager, getServiceName, getServiceTempDir, isEnabled, isServiceMonitored, makeAbsoluteFile

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.avalon.framework.context.Contextualizable

contextualize

Constructor Detail

PerformanceInterceptorServiceImpl

public PerformanceInterceptorServiceImpl()

Constructor

Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Overrides:

configure in class BaseInterceptorServiceImpl

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

Configurable.configure(org.apache.avalon.framework.configuration.Configuration)

reconfigure

public void reconfigure(org.apache.avalon.framework.configuration.Configuration configuration)
                 throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

reconfigure in interface org.apache.avalon.framework.configuration.Reconfigurable

Overrides:

reconfigure in class BaseInterceptorServiceImpl

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

See Also:

Reconfigurable.reconfigure(org.apache.avalon.framework.configuration.Configuration)

onEntry

public void onEntry(AvalonInterceptorContext interceptorContext)

Description copied from interface: AvalonInterceptorService

Called before a service method is invoked.

Specified by:

onEntry in interface AvalonInterceptorService

Overrides:

onEntry in class BaseInterceptorServiceImpl

Parameters:

interceptorContext - shared interceptor context

See Also:

AvalonInterceptorService.onEntry(org.apache.fulcrum.yaafi.framework.interceptor.AvalonInterceptorContext)

onError

public void onError(AvalonInterceptorContext interceptorContext,
                    Throwable t)

Description copied from interface: AvalonInterceptorService

Called when a service method throws an exeption

Specified by:

onError in interface AvalonInterceptorService

Overrides:

onError in class BaseInterceptorServiceImpl

Parameters:

interceptorContext - shared interceptor context

t - the resulting exception

See Also:

AvalonInterceptorService.onError(org.apache.fulcrum.yaafi.framework.interceptor.AvalonInterceptorContext, java.lang.Throwable)

onExit

public void onExit(AvalonInterceptorContext interceptorContext,
                   Object result)

Description copied from interface: AvalonInterceptorService

Called after a service method was invoked.

Specified by:

onExit in interface AvalonInterceptorService

Overrides:

onExit in class BaseInterceptorServiceImpl

Parameters:

interceptorContext - shared interceptor context

result - the result of the invocation

See Also:

AvalonInterceptorService.onExit(org.apache.fulcrum.yaafi.framework.interceptor.AvalonInterceptorContext, java.lang.Object)

createStopWatch

protected void createStopWatch(AvalonInterceptorContext interceptorContext)

Creates a stop watch

Parameters:

interceptorContext - the current interceptor context

getStopWatch

protected StopWatch getStopWatch(AvalonInterceptorContext interceptorContext)

Gets the stop watch

Parameters:

interceptorContext - the current interceptor context

Returns:

the stop watch

log

protected void log(int mode,
                   AvalonInterceptorContext interceptorContext,
                   StopWatch stopWatch)

Logs the execution time.

Parameters:

mode - the invocation mode (onEntry, onExit, onError)

interceptorContext - the current interceptor context

stopWatch - the stop watch

toString

protected String toString(AvalonInterceptorContext interceptorContext,
                          StopWatch stopWatch,
                          int mode)

Create the log message for the performance logfile.

Parameters:

interceptorContext - the context

stopWatch - the stopwatch

mode - the mode (onEntry, onExit, onError)

Returns:

the log message

toString

protected String toString(Object[] args)

Prints the argument list.

Parameters:

args - array of arguments

Returns:

the debug output