net.anotheria.moskito.core.dynamic

Class OnDemandStatsProducer<S extends IStats>

java.lang.Object

net.anotheria.moskito.core.dynamic.OnDemandStatsProducer<S>

All Implemented Interfaces:

AutoTieAbleProducer, Inspectable, IStatsProducer<S>, TracingAwareProducer

Direct Known Subclasses:

EntryCountLimitedOnDemandStatsProducer

public class OnDemandStatsProducer<S extends IStats>
extends Object
implements IStatsProducer<S>, Inspectable, TracingAwareProducer, AutoTieAbleProducer

This producer is used when the different method producing stats aren't known at compile time (or you don't want to use them). It is used by the InvocationProxy to add methods dynamically as they being called, but also by the filters, like RequestURIFilter dynamically adding a stat for each new uri.

Author:

lrosenberg

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUMULATED_STATS_NAME Constant for cumulated (aggregated) stats name.

Constructor Summary

Constructors

Constructor and Description
OnDemandStatsProducer(String aProducerId, String aCategory, String aSubsystem, IOnDemandStatsFactory<S> aStatsFactory) Creates a new OnDemandStatsProducer instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected List<S>	getCachedStatsList()
String	getCategory() Returns the category of this producer.
CreationInfo	getCreationInfo() Returns the creation info about a producer.
S	getDefaultStats()
String	getProducerId() Returns the meaningful id of this producer.
protected String	getProducerNameExtension()
List<S>	getStats() Returns the list of all stats.
S	getStats(String name)
String	getSubsystem() Returns the subsystem the current producer is located in.
protected boolean	limitForNewEntriesReached() The getStats method checked whether the limit is reached before creating a new stat object.
void	setTracingSupported(boolean tracingSupported)
String	toString()
boolean	tracingSupported()

Methods inherited from class java.lang.Object

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

Field Detail

CUMULATED_STATS_NAME

public static final String CUMULATED_STATS_NAME

Constant for cumulated (aggregated) stats name.

See Also:

Constant Field Values

Constructor Detail

OnDemandStatsProducer

public OnDemandStatsProducer(String aProducerId,
                     String aCategory,
                     String aSubsystem,
                     IOnDemandStatsFactory<S> aStatsFactory)

Creates a new OnDemandStatsProducer instance.

Parameters:

aProducerId - a producer id

aCategory - a category

aSubsystem - a subsystem

aStatsFactory - a factory for IStat object creation.

Method Detail

getStats

public S getStats(String name)
                          throws OnDemandStatsProducerException

Throws:

OnDemandStatsProducerException

getCategory

public String getCategory()

Description copied from interface: IStatsProducer

Returns the category of this producer. A typical categorie is something like servlet, action, service or dao. The categories are used to group different StatsProducer to get overview over a certain layer in the application, i.e. show me all action.

Specified by:

getCategory in interface IStatsProducer<S extends IStats>

Returns:

the id of the category the producer belongs to.

getProducerId

public String getProducerId()

Description copied from interface: IStatsProducer

Returns the meaningful id of this producer. This should be something like a class or interface name.

Specified by:

getProducerId in interface IStatsProducer<S extends IStats>

Returns:

a string which provides unique identification of this producer, i.e. the class name or a readable form of it.

getStats

public List<S> getStats()

Description copied from interface: IStatsProducer

Returns the list of all stats.

Specified by:

getStats in interface IStatsProducer<S extends IStats>

Returns:

all stats this producer produces / generates.

getSubsystem

public String getSubsystem()

Description copied from interface: IStatsProducer

Returns the subsystem the current producer is located in. Moskito referrs to your application as "the system". If you want to filter some parts of your system separately you should use the getSubsystem() method to separate them. Possible subsystems are: usermanagement, messaging... whatever. The getCategory() method should separate parts of the application horizontally, whether the getSubsystem() method should provide vertical separation.

Specified by:

getSubsystem in interface IStatsProducer<S extends IStats>

Returns:

the id of the subsystem the producer belongs to.

getDefaultStats

public S getDefaultStats()

toString

public String toString()

Overrides:

toString in class Object

limitForNewEntriesReached

protected boolean limitForNewEntriesReached()

The getStats method checked whether the limit is reached before creating a new stat object. Overwrite this function and return true if you want to limit the number of possible stored stats. Not limiting the stats can result in memory leak if someone can influence the stat names from the outside. Therefore MoskitoFilters are using EntryCountLimitedOnDemandStatsProducer instead.

Returns:

false

getProducerNameExtension

protected String getProducerNameExtension()

getCachedStatsList

protected List<S> getCachedStatsList()

getCreationInfo

public CreationInfo getCreationInfo()

Returns the creation info about a producer.

Specified by:

getCreationInfo in interface Inspectable

Returns:

setTracingSupported

public void setTracingSupported(boolean tracingSupported)

tracingSupported

public boolean tracingSupported()

Specified by:

tracingSupported in interface TracingAwareProducer