org.ow2.jasmine.probe.collector
Interface JasmineCollectorService

public interface JasmineCollectorService

This interface is implemented by all the CollectorServices

Author:

durieuxp, danesa

Method Summary

JasmineCollector	getCollector(JasmineIndicator indicator, JasmineProbe probe) Create a Collector instance corresponding to a JasmineIndicator and a JasmineProbe.
JasmineCollectorInfo	getCollectorInfo() Get the Information about the Collector
List<String>	getDependantIndicators(JasmineIndicator indic) Return the List of indicators used by this indicator.
List<String>	getDependantTargets(JasmineIndicator indic) Return the list of targets used by this indicator
List<JasminePropertyInfo>	getPropertiesInfo() Deprecated.
void	removeCollectors(String name, String probeId) Remove Collectors attached to this Indicator.
void	removeTarget(String name) Remove a target.

Method Detail

getCollector

JasmineCollector getCollector(JasmineIndicator indicator,
                              JasmineProbe probe)
                              throws JasmineCollectorException

Create a Collector instance corresponding to a JasmineIndicator and a JasmineProbe.

Parameters:

indicator - the given indicator's definition

probe - the definition of the probe in which the indicator is used

Returns:

the Collector corresponding to the given indicator

Throws:

JasmineCollectorException

getPropertiesInfo

List<JasminePropertyInfo> getPropertiesInfo()

Deprecated.

Retrieve the description of all specific properties hidden in JasmineCollector Return a List of all properties with their description

Returns:

List of property descriptions

getCollectorInfo

JasmineCollectorInfo getCollectorInfo()

Get the Information about the Collector

Returns:

JasmineIndicatorTypeInfo

removeCollectors

void removeCollectors(String name,
                      String probeId)

Remove Collectors attached to this Indicator. Called usually when the indicator has changed or is removed. May be called also when a probe is removed. In this case, the probeId must be provided.

Parameters:

name - Indicator name

probeId - Probe name. If not null, only remove collectors corresponding to the given indicator and probe.

removeTarget

void removeTarget(String name)

Remove a target. This operation has no effect on collector services which use implicit targets. It has side effect on services like 'jmx' that associate workers to targets.

Parameters:

name - the name of the target to remove

getDependantIndicators

List<String> getDependantIndicators(JasmineIndicator indic)

Return the List of indicators used by this indicator.

Parameters:

indic - JasmineIndicator

Returns:

getDependantTargets

List<String> getDependantTargets(JasmineIndicator indic)

Return the list of targets used by this indicator

Parameters:

indic - JasmineIndicator

Returns: