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>, LoggingAwareProducer, TracingAwareProducer

Direct Known Subclasses:

EntryCountLimitedOnDemandStatsProducer

public class OnDemandStatsProducer<S extends IStats>
extends java.lang.Object
implements IStatsProducer<S>, Inspectable, TracingAwareProducer, AutoTieAbleProducer, LoggingAwareProducer

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 java.lang.String	CUMULATED_STATS_NAME Constant for cumulated (aggregated) stats name.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disableLogging() Disables logging of all method calls.
void	enableLogging() Enables logging of all methods calls.
protected java.util.List<S>	getCachedStatsList()
java.lang.String	getCategory() Returns the category of this producer.
CreationInfo	getCreationInfo() Returns the creation info about a producer.
S	getDefaultStats()
java.lang.String	getProducerId() Returns the meaningful id of this producer.
protected java.lang.String	getProducerNameExtension()
java.util.List<S>	getStats() Returns the list of all stats.
S	getStats(java.lang.String name)
java.lang.String	getSubsystem() Returns the subsystem the current producer is located in.
boolean	isLoggingEnabled() Returns true if logging is currently enabled.
boolean	isLoggingSupported() Returns true if the logging is supported by this producer.
protected boolean	limitForNewEntriesReached() The getStats method checked whether the limit is reached before creating a new stat object.
void	setLoggingSupported(boolean loggingSupported)
void	setTracingSupported(boolean tracingSupported)
java.lang.String	toString()
boolean	tracingSupported() Returns true if tracing is supported by this producer.

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 java.lang.String CUMULATED_STATS_NAME

Constant for cumulated (aggregated) stats name.

See Also:

Constant Field Values

Constructor Detail

OnDemandStatsProducer

public OnDemandStatsProducer(java.lang.String aProducerId,
                             java.lang.String aCategory,
                             java.lang.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(java.lang.String name)
           throws OnDemandStatsProducerException

Throws:

OnDemandStatsProducerException

getCategory

public java.lang.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 java.lang.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 java.util.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 java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.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 java.lang.String getProducerNameExtension()

getCachedStatsList

protected java.util.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()

Description copied from interface: TracingAwareProducer

Returns true if tracing is supported by this producer.

Specified by:

tracingSupported in interface TracingAwareProducer

Returns:

isLoggingEnabled

public boolean isLoggingEnabled()

Description copied from interface: LoggingAwareProducer

Returns true if logging is currently enabled.

Specified by:

isLoggingEnabled in interface LoggingAwareProducer

Returns:

isLoggingSupported

public boolean isLoggingSupported()

Description copied from interface: LoggingAwareProducer

Returns true if the logging is supported by this producer.

Specified by:

isLoggingSupported in interface LoggingAwareProducer

Returns:

enableLogging

public void enableLogging()

Description copied from interface: LoggingAwareProducer

Enables logging of all methods calls.

Specified by:

enableLogging in interface LoggingAwareProducer

disableLogging

public void disableLogging()

Description copied from interface: LoggingAwareProducer

Disables logging of all method calls.

Specified by:

disableLogging in interface LoggingAwareProducer

setLoggingSupported

public void setLoggingSupported(boolean loggingSupported)