net.anotheria.moskito.core.blueprint

Class BlueprintProducer

java.lang.Object

net.anotheria.moskito.core.blueprint.BlueprintProducer

All Implemented Interfaces:

IStatsProducer

public class BlueprintProducer
extends Object
implements IStatsProducer

This special producer type is used whenever you have monitorable objects which are created on request and should be recycled afterwards (for example command pattern, or struts 2 action). The problem with the per-request-creation of objects is that if you tie the usual moskito producer to them, they remain registered in the producer registry and your app leaks memory, since the objects never get collected. The solution is to use the BlueprintProducer which is used to gather the stats for a category or family of objects. You can think of blueprintproducer - object relationship as of object and its class.

Author:

lrosenberg

Constructor Summary

Constructors

Constructor and Description
BlueprintProducer(String aProducerId, String aCategory, String aSubsystem) Creates a new BlueprintProducer object with given parameters

Method Summary

Methods

Modifier and Type	Method and Description
Object	execute(BlueprintCallExecutor executor, Object... parameters) Called by the surrounding code whenever the action which we are measuring is actually executed.
String	getCategory() Returns the category of this producer.
protected Interval[]	getMonitoringIntervals()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlueprintProducer

public BlueprintProducer(String aProducerId,
                 String aCategory,
                 String aSubsystem)

Creates a new BlueprintProducer object with given parameters

Parameters:

aProducerId - a producer id

aCategory - the name of the category (for presentation needs)

aSubsystem - the name of the subsystem (for presentation needs)

Method Detail

execute

public Object execute(BlueprintCallExecutor executor,
             Object... parameters)
               throws Exception

Called by the surrounding code whenever the action which we are measuring is actually executed.

Parameters:

executor - the object the action is executed on

parameters - parameters for the action

Returns:

Throws:

Exception

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

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

Returns:

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

getStats

public List<IStats> getStats()

Description copied from interface: IStatsProducer

Returns the list of all stats.

Specified by:

getStats in interface IStatsProducer

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

Returns:

the id of the subsystem the producer belongs to.

getMonitoringIntervals

protected Interval[] getMonitoringIntervals()