JmxBuilderTools (groovy 3.0.1 API)

groovy.jmx.builder.JmxBuilderTools

This is a utility class used as a helper for JmxBuilder.

Properties Summary

Properties
Type	Name and description
`private static String`	`ATTRIB_KEY_DEFAULT`
`private static String`	`ATTRIB_KEY_DESC`
`private static String`	`ATTRIB_KEY_DESCRIPTION`
`private static String`	`ATTRIB_KEY_TYPE`
`private static String`	`DEFAULT_DOMAIN`
`private static String`	`DEFAULT_NAME_TYPE`
`private static String`	`DESC_KEY`
`private static String`	`DESC_KEY_DISPLAY_NAME`
`private static String`	`DESC_KEY_EVENT_MESSAGE`
`private static String`	`DESC_KEY_EVENT_NAME`
`private static String`	`DESC_KEY_EVENT_SOURCE`
`private static String`	`DESC_KEY_EVENT_TYPE`
`private static String`	`DESC_KEY_GETMETHOD`
`private static String`	`DESC_KEY_JMX_NAME`
`private static String`	`DESC_KEY_MBEAN_ATTRIBS`
`private static String`	`DESC_KEY_MBEAN_CTORS`
`private static String`	`DESC_KEY_MBEAN_NOTES`
`private static String`	`DESC_KEY_MBEAN_OPS`
`private static String`	`DESC_KEY_MBEAN_RESOURCE`
`private static String`	`DESC_KEY_MBEAN_RESOURCE_TYPE`
`private static String`	`DESC_KEY_NAME`
`private static String`	`DESC_KEY_READABLE`
`private static String`	`DESC_KEY_ROLE`
`private static String`	`DESC_KEY_SETMETHOD`
`private static String`	`DESC_KEY_SIGNATURE`
`private static String`	`DESC_KEY_TYPE`
`private static String`	`DESC_KEY_WRITABLE`
`private static String`	`DESC_VAL_TYPE_ATTRIB`
`private static String`	`DESC_VAL_TYPE_CTOR`
`private static String`	`DESC_VAL_TYPE_GETTER`
`private static String`	`DESC_VAL_TYPE_MBEAN`
`private static String`	`DESC_VAL_TYPE_NOTIFICATION`
`private static String`	`DESC_VAL_TYPE_OP`
`private static String`	`DESC_VAL_TYPE_SETTER`
`private static String`	`EVENT_KEY_CALLBACK`
`private static String`	`EVENT_KEY_CALLBACK_RESULT`
`private static String`	`EVENT_KEY_CONTEXTS`
`private static String`	`EVENT_KEY_ISATTRIB`
`private static String`	`EVENT_KEY_MESSAGE`
`private static String`	`EVENT_KEY_METHOD`
`private static String`	`EVENT_KEY_METHOD_RESULT`
`private static String`	`EVENT_KEY_NAME`
`private static String`	`EVENT_KEY_NODE_TYPE`
`private static String`	`EVENT_KEY_TARGETS`
`private static String`	`EVENT_KEY_TYPE`
`private static String`	`EVENT_VAL_NODETYPE_BROADCASTER`
`private static String`	`EVENT_VAL_NODETYPE_LISTENER`
`private static String`	`JMX_KEY`
`private static String`	`NODE_NAME_ATTRIBS`
`private static String`	`NODE_NAME_ATTRIBUTES`
`private static String`	`NODE_NAME_CONSTRUCTORS`
`private static String`	`NODE_NAME_CTORS`
`private static String`	`NODE_NAME_OPERATIONS`
`private static String`	`NODE_NAME_OPS`
`private static Map`	`PRIMITIVE_TYPES`
`private static Map`	`TYPE_MAP`

Constructor Summary

Constructors
Constructor and description
`JmxBuilderTools ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static String`	`capitalize(String value)` Capitalize the string passed.
	`static ObjectName`	`getDefaultObjectName(Object obj)` Builds a default ObjectName() instance for a given backing POJO/POGO Parameters: `obj` - - the backing pojo/pogo Returns: the generated ObjectName() instance.
	`static MBeanServerConnection`	`getMBeanServer()` Returns an MBeanServerConnection instance.
	`static String`	`getNormalizedType(String type)` Returns the proper type's class name when a short version is provided (i.e.
	`static Class[]`	`getSignatureFromParamInfo(Object params)` Returns method signature (as Class[]) given the meta map that describes the method.
	`static boolean`	`isClassMBean(Class cls)` Tests whether the provided class implements MBean.
	`static GroovyMBean`	`registerMBeanFromMap(String regPolicy, Map metaMap)`
	`static String`	`uncapitalize(String value)` Uncapitalizes a string.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - private static String ATTRIB_KEY_DEFAULT
  - private static String ATTRIB_KEY_DESC
  - private static String ATTRIB_KEY_DESCRIPTION
  - private static String ATTRIB_KEY_TYPE
  - private static String DEFAULT_DOMAIN
  - private static String DEFAULT_NAME_TYPE
  - private static String DESC_KEY
  - private static String DESC_KEY_DISPLAY_NAME
  - private static String DESC_KEY_EVENT_MESSAGE
  - private static String DESC_KEY_EVENT_NAME
  - private static String DESC_KEY_EVENT_SOURCE
  - private static String DESC_KEY_EVENT_TYPE
  - private static String DESC_KEY_GETMETHOD
  - private static String DESC_KEY_JMX_NAME
  - private static String DESC_KEY_MBEAN_ATTRIBS
  - private static String DESC_KEY_MBEAN_CTORS
  - private static String DESC_KEY_MBEAN_NOTES
  - private static String DESC_KEY_MBEAN_OPS
  - private static String DESC_KEY_MBEAN_RESOURCE
  - private static String DESC_KEY_MBEAN_RESOURCE_TYPE
  - private static String DESC_KEY_NAME
  - private static String DESC_KEY_READABLE
  - private static String DESC_KEY_ROLE
  - private static String DESC_KEY_SETMETHOD
  - private static String DESC_KEY_SIGNATURE
  - private static String DESC_KEY_TYPE
  - private static String DESC_KEY_WRITABLE
  - private static String DESC_VAL_TYPE_ATTRIB
  - private static String DESC_VAL_TYPE_CTOR
  - private static String DESC_VAL_TYPE_GETTER
  - private static String DESC_VAL_TYPE_MBEAN
  - private static String DESC_VAL_TYPE_NOTIFICATION
  - private static String DESC_VAL_TYPE_OP
  - private static String DESC_VAL_TYPE_SETTER
  - private static String EVENT_KEY_CALLBACK
  - private static String EVENT_KEY_CALLBACK_RESULT
  - private static String EVENT_KEY_CONTEXTS
  - private static String EVENT_KEY_ISATTRIB
  - private static String EVENT_KEY_MESSAGE
  - private static String EVENT_KEY_METHOD
  - private static String EVENT_KEY_METHOD_RESULT
  - private static String EVENT_KEY_NAME
  - private static String EVENT_KEY_NODE_TYPE
  - private static String EVENT_KEY_TARGETS
  - private static String EVENT_KEY_TYPE
  - private static String EVENT_VAL_NODETYPE_BROADCASTER
  - private static String EVENT_VAL_NODETYPE_LISTENER
  - private static String JMX_KEY
  - private static String NODE_NAME_ATTRIBS
  - private static String NODE_NAME_ATTRIBUTES
  - private static String NODE_NAME_CONSTRUCTORS
  - private static String NODE_NAME_CTORS
  - private static String NODE_NAME_OPERATIONS
  - private static String NODE_NAME_OPS
  - private static Map PRIMITIVE_TYPES
  - private static Map TYPE_MAP
- Constructor Detail
  - JmxBuilderTools()
- Method Detail
  - static String capitalize(String value)
    
    Capitalize the string passed.
    Parameters:
    value - - string to capitalize.
    Returns:
    - a capitalized string.
  - static ObjectName getDefaultObjectName(Object obj)
    
    Builds a default ObjectName() instance for a given backing POJO/POGO
    Parameters:
    obj - - the backing pojo/pogo
    Returns:
    the generated ObjectName() instance.
  - static MBeanServerConnection getMBeanServer()
    
    Returns an MBeanServerConnection instance. It searches for declared MBeanServers from the MBeanServerFactory. If none is found, the default Platform MBeanServer is returned.
  - static String getNormalizedType(String type)
    
    Returns the proper type's class name when a short version is provided (i.e. String returns java.lang.String)
    Parameters:
    type - - the type name to normalize
    Returns:
    the normalized type name.
  - static Class[] getSignatureFromParamInfo(Object params)
    
    Returns method signature (as Class[]) given the meta map that describes the method.
    Parameters:
    params - - the map with parameter info.
    Returns:
    Class[] that represent the method signature.
  - static boolean isClassMBean(Class cls)
    
    Tests whether the provided class implements MBean. It uses the following runes
```
 if(
     DynamicMBean.class.isAssignable(cls) ||
     cls.getName().endsWith("MBean") ||
     cls.getName().endsWith("MXBean")
 ) then class is MBean
 
```
    Parameters:
    cls - - class to test
    Returns:
    true = if class implements DynamicMBean or interface name that ends in MBean or MXBean.
  - static GroovyMBean registerMBeanFromMap(String regPolicy, Map metaMap)
  - static String uncapitalize(String value)
    
    Uncapitalizes a string.
    Parameters:
    value - - string to uncap.
    Returns:
    uncap'ed string.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class JmxBuilderTools

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private static String ATTRIB_KEY_DEFAULT

private static String ATTRIB_KEY_DESC

private static String ATTRIB_KEY_DESCRIPTION

private static String ATTRIB_KEY_TYPE

private static String DEFAULT_DOMAIN

private static String DEFAULT_NAME_TYPE

private static String DESC_KEY

private static String DESC_KEY_DISPLAY_NAME

private static String DESC_KEY_EVENT_MESSAGE

private static String DESC_KEY_EVENT_NAME

private static String DESC_KEY_EVENT_SOURCE

private static String DESC_KEY_EVENT_TYPE

private static String DESC_KEY_GETMETHOD

private static String DESC_KEY_JMX_NAME

private static String DESC_KEY_MBEAN_ATTRIBS

private static String DESC_KEY_MBEAN_CTORS

private static String DESC_KEY_MBEAN_NOTES

private static String DESC_KEY_MBEAN_OPS

private static String DESC_KEY_MBEAN_RESOURCE

private static String DESC_KEY_MBEAN_RESOURCE_TYPE

private static String DESC_KEY_NAME

private static String DESC_KEY_READABLE

private static String DESC_KEY_ROLE

private static String DESC_KEY_SETMETHOD

private static String DESC_KEY_SIGNATURE

private static String DESC_KEY_TYPE

private static String DESC_KEY_WRITABLE

private static String DESC_VAL_TYPE_ATTRIB

private static String DESC_VAL_TYPE_CTOR

private static String DESC_VAL_TYPE_GETTER

private static String DESC_VAL_TYPE_MBEAN

private static String DESC_VAL_TYPE_NOTIFICATION

private static String DESC_VAL_TYPE_OP

private static String DESC_VAL_TYPE_SETTER

private static String EVENT_KEY_CALLBACK

private static String EVENT_KEY_CALLBACK_RESULT

private static String EVENT_KEY_CONTEXTS

private static String EVENT_KEY_ISATTRIB

private static String EVENT_KEY_MESSAGE

private static String EVENT_KEY_METHOD

private static String EVENT_KEY_METHOD_RESULT

private static String EVENT_KEY_NAME

private static String EVENT_KEY_NODE_TYPE

private static String EVENT_KEY_TARGETS

private static String EVENT_KEY_TYPE

private static String EVENT_VAL_NODETYPE_BROADCASTER

private static String EVENT_VAL_NODETYPE_LISTENER

private static String JMX_KEY

private static String NODE_NAME_ATTRIBS

private static String NODE_NAME_ATTRIBUTES

private static String NODE_NAME_CONSTRUCTORS

private static String NODE_NAME_CTORS

private static String NODE_NAME_OPERATIONS

private static String NODE_NAME_OPS

private static Map PRIMITIVE_TYPES

private static Map TYPE_MAP

Constructor Detail

JmxBuilderTools()

Method Detail

static String capitalize(String value)

static ObjectName getDefaultObjectName(Object obj)

static MBeanServerConnection getMBeanServer()

static String getNormalizedType(String type)

static Class[] getSignatureFromParamInfo(Object params)

static boolean isClassMBean(Class cls)

static GroovyMBean registerMBeanFromMap(String regPolicy, Map metaMap)

static String uncapitalize(String value)