com.googlecode.jmxtrans.model.naming

Class JexlNamingStrategy

java.lang.Object

com.googlecode.jmxtrans.model.naming.JexlNamingStrategy

All Implemented Interfaces:

NamingStrategy

public class JexlNamingStrategy
extends Object
implements NamingStrategy

Naming strategy which uses an JEXL expression to format the name from the result, its class name, attribute name, and more. Note the resulting name can be used for any of a number of purposes. For example, with OpenTSDB it could be the metric name or a tag name.

In the expression, all of the following may be used: Variables

alias

the classname alias of the MBean.

attribute

the name of the attribute of the MBean queried.

class

the effective classname of the MBean (uses #alias is not null, otherwise uses #realclass).

realclass

the class name of the MBean.

result

the full Result object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EXPRESSION
protected org.apache.commons.jexl2.JexlEngine	jexl
protected org.apache.commons.jexl2.Expression	parsedExpr
static String	VAR__ATTRIBUTE_NAME
static String	VAR__CLASSNAME
static String	VAR__CLASSNAME_ALIAS
static String	VAR__EFFECTIVE_CLASSNAME
static String	VAR__RESULT
static String	VAR__TYPENAME

Constructor Summary

Constructors

Constructor and Description
JexlNamingStrategy() Create a new naming strategy using an JEXL expression and the default expression.
JexlNamingStrategy(String expr) Create a new naming strategy using an JEXL expression and the given expression.

Method Summary

Modifier and Type	Method and Description
String	formatName(Result result) Format the name for the given result.
protected void	populateContext(org.apache.commons.jexl2.JexlContext context, Result result) Populate the context with values from the result.
void	setExpression(String expr)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPRESSION

public static final String DEFAULT_EXPRESSION

See Also:

Constant Field Values

VAR__CLASSNAME

public static final String VAR__CLASSNAME

See Also:

Constant Field Values

VAR__ATTRIBUTE_NAME

public static final String VAR__ATTRIBUTE_NAME

See Also:

Constant Field Values

VAR__CLASSNAME_ALIAS

public static final String VAR__CLASSNAME_ALIAS

See Also:

Constant Field Values

VAR__EFFECTIVE_CLASSNAME

public static final String VAR__EFFECTIVE_CLASSNAME

See Also:

Constant Field Values

VAR__TYPENAME

public static final String VAR__TYPENAME

See Also:

Constant Field Values

VAR__RESULT

public static final String VAR__RESULT

See Also:

Constant Field Values

jexl

protected org.apache.commons.jexl2.JexlEngine jexl

parsedExpr

protected org.apache.commons.jexl2.Expression parsedExpr

Constructor Detail

JexlNamingStrategy

public JexlNamingStrategy()
                   throws org.apache.commons.jexl2.JexlException

Create a new naming strategy using an JEXL expression and the default expression.

Throws:

org.apache.commons.jexl2.JexlException

JexlNamingStrategy

public JexlNamingStrategy(String expr)
                   throws org.apache.commons.jexl2.JexlException

Create a new naming strategy using an JEXL expression and the given expression.

Parameters:

expr - - the JEXL expression to use to create names.

Throws:

org.apache.commons.jexl2.JexlException

Method Detail

formatName

public String formatName(Result result)

Format the name for the given result.

Specified by:

formatName in interface NamingStrategy

Parameters:

result - - the result of a JMX query.

Returns:

String - the formatted string resulting from the expression, or null if the formatting fails.

setExpression

public void setExpression(String expr)
                   throws org.apache.commons.jexl2.JexlException

Throws:

org.apache.commons.jexl2.JexlException

populateContext

protected void populateContext(org.apache.commons.jexl2.JexlContext context,
                               Result result)

Populate the context with values from the result.

Parameters:

context - - the expression context used when evaluating JEXL expressions.

result - - the result of a JMX query.