Package org.glassfish.admin.amx.base

Interface Tools

All Superinterfaces:

AMX_SPI, AMXProxy, Singleton, Utility

@Taxonomy(stability=UNCOMMITTED)
@AMXMBeanMetadata(singleton=true,
                  globalSingleton=true,
                  leaf=true)
public interface Tools
extends AMXProxy, Utility, Singleton

Useful informational tools.

Since:

GlassFish V3

Method Summary

Modifier and Type	Method	Description
String	getHierarchy()
String	getInfo()	emit information about all MBeans
String	info(String searchString)	emit information about MBeans, loosey-goosey seach string eg type alone, pattern, etc
String	infoPath(String path)	emit information about all MBeans of the specified type, or path
String	infoPP(String parentPath, boolean recursive)	emit information about all MBeans having the specified parent path (PP), recursively or not
String	infoType(String type)	emit information about all MBeans of the specified type, or path
String	java(ObjectName objectName)	Get a compilable java interface for the specified MBean
String	validate()	Validate all AMX MBeans.
String	validate(ObjectName objectNameOrPattern)	Validate a single MBean or MBeans specified by a pattern.
String	validate(ObjectName[] mbeans)	Validate MBeans: specific ObjectNames and/or patterns.

Methods inherited from interface org.glassfish.admin.amx.core.AMX_SPI

getChildren, getName, getParent

Methods inherited from interface org.glassfish.admin.amx.core.AMXProxy

as, attributeNames, attributesMap, attributesMap, child, child, childrenMap, childrenMap, childrenMaps, childrenSet, extra, invokeOp, invokeOp, java, nameProp, objectName, parent, parentPath, path, type, valid

Method Detail

getInfo

@ManagedAttribute
@Description("emit information about all MBeans")
String getInfo()

emit information about all MBeans

infoType

@Description("emit information about all MBeans of the specified type, or path")
@ManagedOperation(impact=0)
String infoType(@Param(name="type")
                String type)

emit information about all MBeans of the specified type, or path

infoPath

@Description("emit information about all MBeans of the specified type, or path")
@ManagedOperation(impact=0)
String infoPath(@Param(name="path")
                String path)

emit information about all MBeans of the specified type, or path

infoPP

@Description("emit information about all MBeans having the specified parent path (PP), recursively or not")
@ManagedOperation(impact=0)
String infoPP(@Description("path of the *parent* MBean") @Param(name="parentPath")
              String parentPath,
              @Param(name="recursive")
              boolean recursive)

emit information about all MBeans having the specified parent path (PP), recursively or not

info

@Description("emit information about MBeans, loosey-goosey seach string eg type alone")
@ManagedOperation(impact=0)
String info(@Description("loosey-goosey seach string") @Param(name="searchString")
            String searchString)

emit information about MBeans, loosey-goosey seach string eg type alone, pattern, etc

java

@Description("Get a compilable java interface for the specified MBean")
@ManagedOperation(impact=0)
String java(@Description("Get a compilable java interface for the specified MBean") @Param(name="objectName")
            ObjectName objectName)

Get a compilable java interface for the specified MBean

validate

@ManagedOperation(impact=0)
@Description("Validate all AMX MBeans and return status")
String validate()

Validate all AMX MBeans.

validate

@ManagedOperation(impact=0)
@Description("Validate a single MBean or MBeans specified by a pattern")
String validate(@Param(name="objectNameOrPattern")
                ObjectName objectNameOrPattern)

Validate a single MBean or MBeans specified by a pattern.

validate

@Description("Validate MBeans: specific ObjectNames and/or patterns")
@ManagedOperation(impact=0)
String validate(@Param(name="mbeans")
                ObjectName[] mbeans)

Validate MBeans: specific ObjectNames and/or patterns.

getHierarchy

@Description("Dump the hierarchy of AMX MBeans by recursive descent")
@ManagedAttribute
String getHierarchy()