org.glassfish.admin.amx.base

Interface Query

All Superinterfaces:

AMX_SPI, AMXProxy, Singleton, Utility

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

Supports various types of queries to find MBeans in the AMX domain only; does not query all MBeans in all domains, only those in the AMX domain.

Note that the methods as declared return AMXProxy or collections thereof, but the actual result consists only of ObjectName; it is the proxy code that auto-converts to AMXProxy eg invoking with MBeanServerConnection.invoke() will return Set but using QueryMgr (as a client-side proxy) will return Set. If ObjectNames are desirable, use Util#toObjectNames.

Method Summary

Modifier and Type	Method and Description
AMXProxy	getGlobalSingleton(String type)
AMXProxy[]	getGlobalSingletons()
Set<AMXProxy>	queryAll() Return all AMX MBeans
AMXProxy[]	queryDescendants(ObjectName parentObjectName)
Set<AMXProxy>	queryName(String name) Return all AMXProxy having the specified name.
Set<AMXProxy>	queryPattern(ObjectName pattern) Return all AMX whose ObjectName matches the supplied pattern, as defined by the JMX specification.
Set<AMXProxy>	queryProps(String props) Return all AMX MBeans matching the specfied ObjectName properties
Set<AMXProxy>	queryType(String type)
Set<AMXProxy>	queryTypeName(String type, String name) Return all AMX whose type and name matches.
Set<AMXProxy>	queryTypes(Set<String> type)
Set<AMXProxy>	queryWildAll(String[] wildKeys, String[] wildValues) Return all AMX MBeans whose whose ObjectName matches all property expressions.

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

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

getChildren, getName, getParent

Method Detail

queryTypes

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans having any of the specified types")
Set<AMXProxy> queryTypes(@Param(name="type")
                                                                                                                                    Set<String> type)

queryType

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans having the specified type")
Set<AMXProxy> queryType(@Param(name="type")
                                                                                                                           String type)

queryName

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans having the specified name")
Set<AMXProxy> queryName(@Param(name="name")
                                                                                                                           String name)

Return all AMXProxy having the specified name.

queryTypeName

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans having the specified type and name")
Set<AMXProxy> queryTypeName(@Param(name="type")
                                                                                                                                        String type,
                                                                                                                                        @Param(name="name")
                                                                                                                                        String name)

Return all AMX whose type and name matches. Note that the resulting items will necessarily have a different Parent (uniqueness invariant within any parent).

queryPattern

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans matching the specfied pattern")
Set<AMXProxy> queryPattern(@Param(name="pattern")
                                                                                                                                  ObjectName pattern)

Return all AMX whose ObjectName matches the supplied pattern, as defined by the JMX specification.

Parameters:

pattern - an ObjectName containing a pattern as defined by JMX

Returns:

Set of AMX or empty Set if none

queryProps

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans matching the specfied ObjectName properties")
Set<AMXProxy> queryProps(@Param(name="props")
                                                                                                                                              String props)

Return all AMX MBeans matching the specfied ObjectName properties

Parameters:

props - a String containing one or more name/value ObjectName properties

queryWildAll

@ManagedOperation(impact=0)
 @Description(value="Return all AMX MBeans matching all specified ObjectName properties, wildcarded by key and/or value")
Set<AMXProxy> queryWildAll(@Param(name="wildKeys")
                                                                                                                                                                                 String[] wildKeys,
                                                                                                                                                                                 @Param(name="wildValues")
                                                                                                                                                                                 String[] wildValues)

Return all AMX MBeans whose whose ObjectName matches all property expressions. Each property expression consists of a key expression, and a value expression; an expression which is null is considered a "*" (match all).

Both key and value expressions may be wildcarded with the "*" character, which matches 0 or more characters.

Each property expression is matched in turn against the ObjectName. If a match fails, the ObjectName is not included in the result. If all matches succeed, then the ObjectName is included.

queryAll

@ManagedOperation(impact=0)
Set<AMXProxy> queryAll()

Return all AMX MBeans

getGlobalSingletons

@Description(value="Return  all MBeans that are global singletons")
 @ManagedAttribute
AMXProxy[] getGlobalSingletons()

getGlobalSingleton

@Description(value="Return the global singleton of the specified type, or null if not found")
 @ManagedOperation(impact=0)
AMXProxy getGlobalSingleton(@Param(name="type")
                                                                                                                                                       String type)

queryDescendants

@Description(value="List the parent followed by all descendants, depth-first traversal")
 @ManagedOperation(impact=0)
AMXProxy[] queryDescendants(@Param(name="parentObjectName")
                                                                                                                                                  ObjectName parentObjectName)