org.jmxtrans.agent

Class Query

java.lang.Object

org.jmxtrans.agent.Query

public class Query
extends Object

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attribute The attribute to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String))
protected String	key If the MBean attribute value is a CompositeData, the key to lookup.
protected ObjectName	objectName
protected Integer	position If the returned value is a Collectionor an array, the position of the entry to lookup.
protected String	resultAlias
protected ResultNameStrategy	resultNameStrategy

Constructor Summary

Constructors

Constructor and Description
Query(String objectName, String attribute, int position, ResultNameStrategy resultNameStrategy)
Query(String objectName, String attribute, ResultNameStrategy resultNameStrategy)
Query(String objectName, String attribute, String key, Integer position, String type, String resultAlias, ResultNameStrategy resultNameStrategy)
Query(String objectName, String attribute, String resultAlias, ResultNameStrategy resultNameStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
void	collectAndExport(MBeanServer mbeanServer, OutputWriter outputWriter)
String	getAttribute()
String	getKey()
ObjectName	getObjectName()
Integer	getPosition()
String	getResultAlias()
String	getType()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

resultNameStrategy

@Nonnull
protected ResultNameStrategy resultNameStrategy

objectName

@Nonnull
protected final ObjectName objectName

resultAlias

@Nonnull
protected final String resultAlias

attribute

@Nonnull
protected final String attribute

The attribute to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String))

key

@Nullable
protected final String key

If the MBean attribute value is a CompositeData, the key to lookup.

position

@Nullable
protected final Integer position

If the returned value is a Collectionor an array, the position of the entry to lookup.

Constructor Detail

Query

public Query(@Nonnull
     String objectName,
     @Nonnull
     String attribute,
     @Nonnull
     ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
     String objectName,
     @Nonnull
     String attribute,
     int position,
     @Nonnull
     ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
     String objectName,
     @Nonnull
     String attribute,
     @Nonnull
     String resultAlias,
     @Nonnull
     ResultNameStrategy resultNameStrategy)

See Also:

Query(String, String, String, Integer, String, String, ResultNameStrategy)

Query

public Query(@Nonnull
     String objectName,
     @Nonnull
     String attribute,
     @Nullable
     String key,
     @Nullable
     Integer position,
     @Nullable
     String type,
     @Nonnull
     String resultAlias,
     @Nonnull
     ResultNameStrategy resultNameStrategy)

Parameters:

objectName - The ObjectName to search for (MBeanServer.queryMBeans(javax.management.ObjectName, javax.management.QueryExp)), can contain wildcards and return several entries.

attribute - The attribute to retrieve (MBeanServer.getAttribute(javax.management.ObjectName, String))

key - if the MBean attribute value is a CompositeData, the key to lookup.

position - if the returned value is a Collection or an array, the position of the entry to lookup.

type - type of the metric ('counter', 'gauge', ...)

resultAlias -

resultNameStrategy - the ResultNameStrategy used during the collectAndExport(javax.management.MBeanServer, OutputWriter) phase.

Method Detail

collectAndExport

public void collectAndExport(@Nonnull
                    MBeanServer mbeanServer,
                    @Nonnull
                    OutputWriter outputWriter)

toString

public String toString()

Overrides:

toString in class Object

getObjectName

@Nonnull
public ObjectName getObjectName()

getResultAlias

@Nonnull
public String getResultAlias()

getAttribute

@Nonnull
public String getAttribute()

getKey

@Nullable
public String getKey()

getPosition

@Nullable
public Integer getPosition()

getType

@Nullable
public String getType()