org.xins.server

Class StatisticsInterceptor

java.lang.Object

org.xins.common.manageable.Manageable

org.xins.server.Interceptor

org.xins.server.StatisticsInterceptor

public class StatisticsInterceptor
extends Interceptor

Maintain the call statistics.

Since:

xins 3.0

Version:

$Revision: 1.3 $ $Date: 2013/01/14 11:14:30 $

Author:

Anthony Goubard

Nested Class Summary

Nested classes/interfaces inherited from class org.xins.common.manageable.Manageable

Manageable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected long	_lastStatisticsReset Last time the statistics were reset.
protected Map<String,org.xins.server.FunctionStatistics>	statistics

Fields inherited from class org.xins.common.manageable.Manageable

BOOTSTRAPPED, BOOTSTRAPPING, DEINITIALIZING, INITIALIZING, UNUSABLE, USABLE

Constructor Summary

Constructors

Constructor and Description
StatisticsInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
FunctionResult	afterFunctionCall(FunctionRequest functionRequest, FunctionResult xinsResult, HttpServletResponse httpResponse)
protected void	bootstrapImpl(Map<String,String> properties) Performs the bootstrap procedure (actual implementation).
Map<String,org.xins.server.FunctionStatistics>	getStatistics()
protected FunctionResult	getStatistics(boolean detailed, String functionName) Returns the call statistics for all functions in this API.
protected FunctionResult	resetStatistics() Resets the statistics.

Methods inherited from class org.xins.server.Interceptor

afterCallingConvention, beforeCallingConvention, beforeFunctionCall, beginRequest, endRequest, getApi

Methods inherited from class org.xins.common.manageable.Manageable

assertUsable, bootstrap, deinit, deinitImpl, getState, init, initImpl, isBootstrapped, isUsable

Methods inherited from class java.lang.Object

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

Field Detail

statistics

protected Map<String,org.xins.server.FunctionStatistics> statistics

_lastStatisticsReset

protected long _lastStatisticsReset

Last time the statistics were reset. Initially the startup timestamp.

Constructor Detail

StatisticsInterceptor

public StatisticsInterceptor()

Method Detail

bootstrapImpl

protected void bootstrapImpl(Map<String,String> properties)
                      throws MissingRequiredPropertyException,
                             InvalidPropertyValueException,
                             BootstrapException

Description copied from class: Manageable

Performs the bootstrap procedure (actual implementation). When this method is called from Manageable.bootstrap(Map), the state and the argument will have been checked and the state will have been set to Manageable.BOOTSTRAPPING.

The implementation of this method in class Manageable is empty.

Overrides:

bootstrapImpl in class Manageable

Parameters:

properties - the bootstrap properties, not null.

Throws:

MissingRequiredPropertyException - if a required property is not given.

InvalidPropertyValueException - if the value of a certain property is invalid.

BootstrapException - if the bootstrapping failed for any other reason.

afterFunctionCall

public FunctionResult afterFunctionCall(FunctionRequest functionRequest,
                               FunctionResult xinsResult,
                               HttpServletResponse httpResponse)

Overrides:

afterFunctionCall in class Interceptor

getStatistics

protected FunctionResult getStatistics(boolean detailed,
                           String functionName)

Returns the call statistics for all functions in this API.

Parameters:

detailed - If true, the unsuccessful result will be returned sorted per error code. Otherwise the unsuccessful result won't be displayed by error code.

functionName - the name of the specific function to return the statistics for, if null, then the stats for all functions are returned.

Returns:

the call result, never null.

resetStatistics

protected FunctionResult resetStatistics()

Resets the statistics.

Returns:

the call result, never null.

getStatistics

public Map<String,org.xins.server.FunctionStatistics> getStatistics()