com.phloc.commons.jmx

Class ObjectNameUtils

java.lang.Object

com.phloc.commons.jmx.ObjectNameUtils

@Immutable
public final class ObjectNameUtils
extends Object

Utility class to create JMX ObjectName objects.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static ObjectName	create(Hashtable<String,String> aParams)
static ObjectName	create(Map<String,String> aParams)
static ObjectName	createWithDefaultProperties(Object aObj) Create a standard ObjectName using the default domain and only the "type" property.
static ObjectName	createWithDefaultProperties(Object aObj, String sName) Create a standard ObjectName using the default domain and the "type" and "name" properties.
static String	getCleanPropertyValue(String sPropertyValue) Create a clean property value applicable for an ObjectName property value by replacing the special chars ":" and "," with "." and "//" with "__".
static String	getDefaultJMXDomain()
static void	setDefaultJMXDomain(String sDefaultJMXDomain) Set the default JMX domain

Methods inherited from class java.lang.Object

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

Method Detail

setDefaultJMXDomain

public static void setDefaultJMXDomain(@Nonnull@Nonempty
                       String sDefaultJMXDomain)

Set the default JMX domain

Parameters:

sDefaultJMXDomain - The new JMX domain. May neither be null nor empty nor may it contains ":" or " "

getDefaultJMXDomain

@Nonnull
@Nonempty
public static String getDefaultJMXDomain()

Returns:

The default JMX domain to be used for ObjectName instances. The default value is CJMX.PHLOC_JMX_DOMAIN.

create

@Nonnull
public static ObjectName create(@Nonnull@Nonempty
                        Hashtable<String,String> aParams)

create

@Nonnull
public static ObjectName create(@Nonnull@Nonempty
                        Map<String,String> aParams)

getCleanPropertyValue

@Nonnull
public static String getCleanPropertyValue(@Nonnull
                                   String sPropertyValue)

Create a clean property value applicable for an ObjectName property value by replacing the special chars ":" and "," with "." and "//" with "__". If the input value contains a blank, the quotes value is returned.

Parameters:

sPropertyValue - The original property value. May not be null.

Returns:

The modified property value applicable for ObjectName.

See Also:

ObjectName.quote(String)

createWithDefaultProperties

@Nonnull
public static ObjectName createWithDefaultProperties(@Nonnull
                                             Object aObj)

Create a standard ObjectName using the default domain and only the "type" property. The type property is the class local name of the specified object.

Parameters:

aObj - The object from which the name is to be created.

Returns:

The non-null ObjectName.

createWithDefaultProperties

@Nonnull
public static ObjectName createWithDefaultProperties(@Nonnull
                                             Object aObj,
                                             @Nonnull
                                             String sName)

Create a standard ObjectName using the default domain and the "type" and "name" properties. The type property is the class local name of the specified object.

Parameters:

aObj - The object from which the name is to be created.

sName - The value of the "name" JMX property

Returns:

The non-null ObjectName.