com.newrelic.agent.jmx.metrics

Enum JmxAction

java.lang.Object

java.lang.Enum<JmxAction>

com.newrelic.agent.jmx.metrics.JmxAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JmxAction>

public enum JmxAction
extends java.lang.Enum<JmxAction>

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUBTRACT_ALL_FROM_FIRST This will perform pAttributes[0] - pAttributes[1] - pAttributes[2] .
SUM_ALL This will perform pAttributes[0] + pAttributes[1] + pAttributes[2] .
USE_FIRST_ATT The is the typical behavior.
USE_FIRST_RECORDED_ATT This can be used when different MBean Servers are being used within the same JVM (there was a ticket for this for JBoss 5).

Method Summary

Modifier and Type	Method and Description
abstract float	performAction(java.lang.String[] attributes, java.util.Map<java.lang.String,java.lang.Float> values)
static JmxAction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JmxAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USE_FIRST_ATT

public static final JmxAction USE_FIRST_ATT

The is the typical behavior. It uses the value of the first attribute listed.

USE_FIRST_RECORDED_ATT

public static final JmxAction USE_FIRST_RECORDED_ATT

This can be used when different MBean Servers are being used within the same JVM (there was a ticket for this for JBoss 5). In this case, one server had ActiveSession while the other server had activeSession resulting in only some sessions being reported. We want to report all sessions, but we want to ensure that we only report each session once. Therefore this will grab the first value listed in the map.

SUBTRACT_ALL_FROM_FIRST

public static final JmxAction SUBTRACT_ALL_FROM_FIRST

This will perform pAttributes[0] - pAttributes[1] - pAttributes[2] . . . - pAttributes[n].

SUM_ALL

public static final JmxAction SUM_ALL

This will perform pAttributes[0] + pAttributes[1] + pAttributes[2] . . . + pAttributes[n].

Method Detail

values

public static JmxAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JmxAction c : JmxAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JmxAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

performAction

public abstract float performAction(java.lang.String[] attributes,
                                    java.util.Map<java.lang.String,java.lang.Float> values)
                             throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException