Package net.welen.jmole.collector

Interface MBeanCollector

All Known Implementing Classes:

MBeanCollectorImpl

public interface MBeanCollector

Describes the business interface of a MBean collector

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributes()
String	getConstructedName(ObjectName objectName)	By using the supplied name (together with the NameParameters and NameAttribute lists) a complete name is constructed that may be dynamic in runtime
String	getName()
Map<String,Object>	getValues(ObjectName objectName)
void	setAttributeFormatPatterns(Map<String,String> attributeFormatPatterns)
void	setAttributeRecalculations(Map<String,String> attributeRecalculations)
void	setAttributes(List<String> attributes)	Which attributes from the found MBean should be collected
void	setDataCollectorExtractors(Map<String,DataCollectorExtractor> attributeExtractors)	Specify of any of the collected attributes needs to be collected using a CollectorExtractor
void	setName(String name)	Set the name of the measurement
void	setNameAttributes(List<String> nameAttributes)	Configure if the name of the measurement should be completed by a dynamic content from the found MBeans attributes.
void	setNameParameters(List<String> nameParameters)	Configure if the name of the measurement should be completed by a dynamic content from the found MBeans parameters.

Method Detail

setName

void setName(String name)

Set the name of the measurement

Use %s to to indicate where provided attribute/parameter values should be injected when constructing the individual name for a measurement

Parameters:

name -

getName

String getName()

setNameAttributes

void setNameAttributes(List<String> nameAttributes)

Configure if the name of the measurement should be completed by a dynamic content from the found MBeans attributes.

Parameters:

nameAttributes - A list of attributes to parse into the name of the measurement

setNameParameters

void setNameParameters(List<String> nameParameters)

Configure if the name of the measurement should be completed by a dynamic content from the found MBeans parameters.

Parameters:

nameAttributes - A list of parameters to parse into the name of the measurement

setAttributes

void setAttributes(List<String> attributes)

Which attributes from the found MBean should be collected

Parameters:

attributes - A list of the attributes names

getAttributes

List<String> getAttributes()

setDataCollectorExtractors

void setDataCollectorExtractors(Map<String,DataCollectorExtractor> attributeExtractors)

Specify of any of the collected attributes needs to be collected using a CollectorExtractor

Parameters:

attributeExtractors - A map of the attribute name and the CollectorExtractor to use

setAttributeRecalculations

void setAttributeRecalculations(Map<String,String> attributeRecalculations)

setAttributeFormatPatterns

void setAttributeFormatPatterns(Map<String,String> attributeFormatPatterns)

getConstructedName

String getConstructedName(ObjectName objectName)
                   throws MBeanException,
                          AttributeNotFoundException,
                          InstanceNotFoundException,
                          ReflectionException

By using the supplied name (together with the NameParameters and NameAttribute lists) a complete name is constructed that may be dynamic in runtime

Parameters:

objectName - The MBean of which attribute and parameters may be used

Returns:

Throws:

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

getValues

Map<String,Object> getValues(ObjectName objectName)
                            throws InstanceNotFoundException,
                                   ReflectionException,
                                   AttributeNotFoundException,
                                   MBeanException

Throws:

InstanceNotFoundException

ReflectionException

AttributeNotFoundException

MBeanException