groovy.util
[Java] Class GroovyMBean

java.lang.Object
  groovy.lang.GroovyObjectSupport
      groovy.util.GroovyMBean

public class GroovyMBean
extends GroovyObjectSupport

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

GroovyMBean

public GroovyMBean(MBeanServerConnection server, String objectName)

GroovyMBean

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

GroovyMBean

public GroovyMBean(MBeanServerConnection server, ObjectName name)

GroovyMBean

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

createOperationKey

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

createSignature

protected String[] createSignature(MBeanOperationInfo info)

describeAttribute

protected String describeAttribute(MBeanAttributeInfo attr)

Description of the specified attribute name.

Parameters:

attr - - the attribute

Returns:

String the description

describeAttribute

public String describeAttribute(String attributeName)

Description of the specified attribute name.

Parameters:

attributeName - - stringified name of the attribute

Returns:

the description

describeOperation

public List 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

describeOperation

protected String describeOperation(MBeanOperationInfo operation)

Description of the operation.

Parameters:

operation - the operation to describe

Returns:

pretty-printed description

getProperty

public Object getProperty(String property)

info

public MBeanInfo info()

invokeMethod

public Object invokeMethod(String method, Object arguments)

listAttributeDescriptions

public Collection listAttributeDescriptions()

List of string representations of all of the attributes on the MBean.

Returns:

list of descriptions of each attribute on the mbean

listAttributeNames

public Collection listAttributeNames()

List of the names of each of the attributes on the MBean

Returns:

list of attribute names

listAttributeValues

public List listAttributeValues()

The values of each of the attributes on the MBean

Returns:

list of values of each attribute

listOperationDescriptions

public Collection listOperationDescriptions()

Description of all of the operations available on the MBean.

Returns:

full description of each operation on the MBean

listOperationNames

public Collection listOperationNames()

Names of all the operations available on the MBean.

Returns:

all the operations on the MBean

name

public ObjectName name()

server

public MBeanServerConnection server()

setProperty

public void setProperty(String property, Object value)

toString

public String toString()

Return an end user readable representation of the underlying MBean

Returns:

the user readable description

Copyright © 2003-2013 The Codehaus. All rights reserved.