GroovyMBean (groovy 2.4.21 API)

groovy.util.GroovyMBean

A GroovyObject facade for an underlying MBean which acts like a normal groovy object but which is actually implemented via an underlying JMX MBean. Properties and normal method invocations delegate to the MBeanServer to the actual MBean.
Authors:
James Strachan
Steve Button
Paul King

Constructor Summary

Constructors
Constructor and description
`GroovyMBean (MBeanServerConnection server, String objectName)`
`GroovyMBean (MBeanServerConnection server, String objectName, boolean ignoreErrors)`
`GroovyMBean (MBeanServerConnection server, ObjectName name)`
`GroovyMBean (MBeanServerConnection server, ObjectName name, boolean ignoreErrors)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected String`	`createOperationKey(String operation, int params)` Construct a simple key based on the method name and the number of parameters
	`protected String[]`	`createSignature(MBeanOperationInfo info)`
	`protected String`	`describeAttribute(MBeanAttributeInfo attr)` Description of the specified attribute name.
	`String`	`describeAttribute(String attributeName)` Description of the specified attribute name.
	`List<String>`	`describeOperation(String operationName)` Get the description of the specified operation.
	`protected String`	`describeOperation(MBeanOperationInfo operation)` Description of the operation.
	`Object`	`getProperty(String property)`
	`MBeanInfo`	`info()`
	`Object`	`invokeMethod(String method, Object arguments)`
	`Collection<String>`	`listAttributeDescriptions()` List of string representations of all of the attributes on the MBean.
	`Collection<String>`	`listAttributeNames()` List of the names of each of the attributes on the MBean
	`List<String>`	`listAttributeValues()` The values of each of the attributes on the MBean
	`Collection<String>`	`listOperationDescriptions()` Description of all of the operations available on the MBean.
	`Collection<String>`	`listOperationNames()` Names of all the operations available on the MBean.
	`ObjectName`	`name()`
	`MBeanServerConnection`	`server()`
	`void`	`setProperty(String property, Object value)`
	`String`	`toString()` Return an end user readable representation of the underlying MBean

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GroovyObjectSupport`	`getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public GroovyMBean(MBeanServerConnection server, String objectName)
  - public GroovyMBean(MBeanServerConnection server, String objectName, boolean ignoreErrors)
  - public GroovyMBean(MBeanServerConnection server, ObjectName name)
  - public GroovyMBean(MBeanServerConnection server, ObjectName name, boolean ignoreErrors)
- Method Detail
  - protected String createOperationKey(String operation, int params)
    
    Construct a simple key based on the method name and the number of parameters
    Parameters:
    operation - - the mbean operation name
    params - - the number of parameters the operation supports
    Returns:
    simple unique identifier for a method
  - protected String[] createSignature(MBeanOperationInfo info)
  - protected String describeAttribute(MBeanAttributeInfo attr)
    
    Description of the specified attribute name.
    Parameters:
    attr - - the attribute
    Returns:
    String the description
  - public String describeAttribute(String attributeName)
    
    Description of the specified attribute name.
    Parameters:
    attributeName - - stringified name of the attribute
    Returns:
    the description
  - public List<String> describeOperation(String operationName)
    
    Get the description of the specified operation. This returns a Collection since operations can be overloaded and one operationName can have multiple forms.
    Parameters:
    operationName - the name of the operation to describe
    Returns:
    Collection of operation description
  - protected String describeOperation(MBeanOperationInfo operation)
    
    Description of the operation.
    Parameters:
    operation - the operation to describe
    Returns:
    pretty-printed description
  - public Object getProperty(String property)
  - public MBeanInfo info()
  - public Object invokeMethod(String method, Object arguments)
  - public Collection<String> listAttributeDescriptions()
    
    List of string representations of all of the attributes on the MBean.
    Returns:
    list of descriptions of each attribute on the mbean
  - public Collection<String> listAttributeNames()
    
    List of the names of each of the attributes on the MBean
    Returns:
    list of attribute names
  - public List<String> listAttributeValues()
    
    The values of each of the attributes on the MBean
    Returns:
    list of values of each attribute
  - public Collection<String> listOperationDescriptions()
    
    Description of all of the operations available on the MBean.
    Returns:
    full description of each operation on the MBean
  - public Collection<String> listOperationNames()
    
    Names of all the operations available on the MBean.
    Returns:
    all the operations on the MBean
  - public ObjectName name()
  - public MBeanServerConnection server()
  - public void setProperty(String property, Object value)
  - public String toString()
    
    Return an end user readable representation of the underlying MBean
    Returns:
    the user readable description

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class GroovyMBean

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public GroovyMBean(MBeanServerConnection server, String objectName)

public GroovyMBean(MBeanServerConnection server, String objectName, boolean ignoreErrors)

public GroovyMBean(MBeanServerConnection server, ObjectName name)

public GroovyMBean(MBeanServerConnection server, ObjectName name, boolean ignoreErrors)

Method Detail

protected String createOperationKey(String operation, int params)

protected String[] createSignature(MBeanOperationInfo info)

protected String describeAttribute(MBeanAttributeInfo attr)

public String describeAttribute(String attributeName)

public List<String> describeOperation(String operationName)

protected String describeOperation(MBeanOperationInfo operation)

public Object getProperty(String property)

public MBeanInfo info()

public Object invokeMethod(String method, Object arguments)

public Collection<String> listAttributeDescriptions()

public Collection<String> listAttributeNames()

public List<String> listAttributeValues()

public Collection<String> listOperationDescriptions()

public Collection<String> listOperationNames()

public ObjectName name()

public MBeanServerConnection server()

public void setProperty(String property, Object value)

public String toString()