com.netflix.servo.jmx

Class OrderedObjectNameMapper

java.lang.Object

com.netflix.servo.jmx.OrderedObjectNameMapper

All Implemented Interfaces:

ObjectNameMapper

public final class OrderedObjectNameMapper
extends java.lang.Object
implements ObjectNameMapper

An ObjectNameMapper that allows the order of tags to be specified when constructing the ObjectName. The mapper will map the known ordered tag keys and then optionally append the remaining tags. While an ObjectName's properties are meant to be unordered some visual tools such as VisualVM use the given order to build a hierarchy. This ordering allows that hierarchy to be manipulated.

It is recommended to always append the remaining tags to avoid collisions in the generated ObjectName. The mapper remaps any characters that are not alphanumeric, a period, or hypen to an underscore.

Field Summary

Fields inherited from interface com.netflix.servo.jmx.ObjectNameMapper

DEFAULT

Constructor Summary

Constructors

Constructor and Description
OrderedObjectNameMapper(boolean appendRemaining, java.util.List<java.lang.String> orderedKeys) Creates the mapper specifying the order of keys to use and whether non-explicitly mentioned tag keys should then be appended or not to the resulting ObjectName.
OrderedObjectNameMapper(boolean appendRemaining, java.lang.String... orderedKeys) Creates the mapper specifying the order of keys to use and whether non-explicitly mentioned tag keys should then be appended or not to the resulting ObjectName.

Method Summary

Modifier and Type	Method and Description
javax.management.ObjectName	createObjectName(java.lang.String domain, Monitor<?> monitor) Given the domain and monitor generates an ObjectName to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedObjectNameMapper

public OrderedObjectNameMapper(boolean appendRemaining,
                               java.lang.String... orderedKeys)

Creates the mapper specifying the order of keys to use and whether non-explicitly mentioned tag keys should then be appended or not to the resulting ObjectName.

Parameters:

appendRemaining - whether to append the remaining tags

orderedKeys - the keys in order that should be used

OrderedObjectNameMapper

public OrderedObjectNameMapper(boolean appendRemaining,
                               java.util.List<java.lang.String> orderedKeys)

Creates the mapper specifying the order of keys to use and whether non-explicitly mentioned tag keys should then be appended or not to the resulting ObjectName.

Parameters:

appendRemaining - whether to append the remaining tags

orderedKeys - the list of keys in the order that should be used

Method Detail

createObjectName

public javax.management.ObjectName createObjectName(java.lang.String domain,
                                                    Monitor<?> monitor)

Description copied from interface: ObjectNameMapper

Given the domain and monitor generates an ObjectName to use.

Specified by:

createObjectName in interface ObjectNameMapper

Parameters:

domain - the JMX domain

monitor - the monitor

Returns:

The created ObjectName