net.java.dev.moskito.core.producers
Interface IStatsProducer

All Known Implementing Classes:

AbstractStatsProducer, EntryCountLimitedOnDemandStatsProducer, OnDemandStatsProducer

public interface IStatsProducer

This interface declares a factory that creates IStats instances.

Author:

dvayanu

Method Summary

String	getCategory() Returns the category of this producer.
String	getProducerId() Returns the meaningful id of this producer.
List<IStats>	getStats() Returns the list of all stats.
String	getSubsystem() Returns the subsystem the current producer is located in.

Method Detail

getStats

List<IStats> getStats()

Returns the list of all stats.

Returns:

all stats this producer produces / generates.

getProducerId

String getProducerId()

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

Returns:

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

getCategory

String getCategory()

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 actions.

Returns:

the id of the category the producer belongs to.

getSubsystem

String getSubsystem()

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.

Returns:

the id of the subsystem the producer belongs to.