File	Doc	Category	Size	Date	Package
QueryMgr.java	API Doc	Glassfish v2 API	8510	Fri May 04 22:30:30 BST 2007	com.sun.appserv.management.base

QueryMgr

Fields Summary
public static final String	J2EE_TYPE The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.

Constructors Summary

Methods Summary
public java.util.Set	queryAllObjectNameSet() return Set of ObjectName of all AMX see #queryAllSet
public java.util.Set	queryAllSet() return Set of all AMX see #queryAllObjectNameSet
public java.util.Set	queryInterfaceObjectNameSet(java.lang.String interfaceName, java.util.Set candidateObjectNames) return Set of ObjectName
public java.util.Set	queryInterfaceSet(java.lang.String interfaceName, java.util.Set candidateObjectNames) Return all {@link AMX} that implement the specified interface, which may be any interface. This is the same as querying for all s for their interfaces, then returning the set for which the interface extends the specified interface. param interfaceName classname of the desired interface param candidateObjectNames optional (may be null) Set of ObjectName to which the search is limited return Set of AMX or empty Set if none
public java.util.Set	queryJ2EENameObjectNameSet(java.lang.String nameValue) return Set of ObjectName
public java.util.Set	queryJ2EENameSet(java.lang.String nameValue) Return all {@link AMX} whose name is equal to 'nameValue'. param nameValue the value for the j2eeType property return Set of AMX or empty Set if none
public java.util.Set	queryJ2EETypeNameObjectNameSet(java.lang.String j2eeType, java.lang.String name) return Set containing all items that have the matching j2eeType and name
public java.util.Set	queryJ2EETypeNameSet(java.lang.String j2eeType, java.lang.String name) return Set containing all items that have the matching j2eeType and name
public java.lang.String[]	queryJ2EETypeNames(java.lang.String j2eeType) Calls queryJ2EETypeSet( j2eeTypeValue ), then creates an array consisting of the names of each of the resulting objects. Note that some names could be identical. param j2eeType the value for the j2eeType property return array of names
public java.util.Set	queryJ2EETypeObjectNameSet(java.lang.String j2eeTypeValue) return Set of ObjectName
public java.util.Set	queryJ2EETypeSet(java.lang.String j2eeTypeValue) Return all {@link AMX} whose j2eeType is equal to 'j2eeTypeValue. Legal values include those defined in {@link com.sun.appserv.management.j2ee.J2EETypes} and those defined in {@link com.sun.appserv.management.base.XTypes} param j2eeTypeValue the value for the j2eeType property return Set of AMX or empty Set if none
public java.util.Set	queryJ2EETypesObjectNameSet(java.util.Set j2eeTypes) see #queryJ2EETypesSet
public java.util.Set	queryJ2EETypesSet(java.util.Set j2eeTypes) Return all {@link AMX} whose j2eeType is equal to any specified in 'j2eeTypes'. param j2eeTypes Set of String (j2eeType values). return Set of AMX or empty Set if none
public java.util.Set	queryPatternObjectNameSet(javax.management.ObjectName pattern) return Set of ObjectName
public java.util.Set	queryPatternObjectNameSet(java.lang.String domain, java.lang.String props) return Set of ObjectName
public java.util.Set	queryPatternSet(javax.management.ObjectName pattern) Return all AMX whose ObjectName matches the supplied ObjectName pattern, as defined by the JMX specification. This can be a relatively expensive operation if care is not taken to use a suitably constrained pattern. For example, querying for "*:*" will return every available AMX. param pattern an ObjectName containing a pattern as defined by JMX return Set of AMX or empty Set if none
public java.util.Set	queryPatternSet(java.lang.String domain, java.lang.String props) Makes an ObjectName pattern, then calls queryPatternSet( pat ) param domain the domain or "*" for all param props a comma-separated Properties string return Set of AMX or empty Set if none
public java.util.Set	queryPropsObjectNameSet(java.lang.String props) return Set of ObjectName
public java.util.Set	queryPropsSet(java.lang.String props) Return all objects that match the specified properties in the JMX domain governed by this QueryMgr. param props a String containing one or more name/value properties
public T	querySingletonJ2EEType(java.lang.String j2eeTypeValue) Calls getJ2EETypeSet( j2eeTypeValue ) and extracts the single result. Throws an exception if more than one object is found. param j2eeTypeValue the value for the j2eeType property return ObjectName or null if not found throws exception if not found
public java.util.Set	queryWildObjectNameSet(java.lang.String[] wildKeys, java.lang.String[] wildValues) return Set of ObjectName
public java.util.Set	queryWildSet(java.lang.String[] wildKeys, java.lang.String[] wildValues) Return all {@link AMX} 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. Caution should be used in choosing the element type of the returned set. Unless certain that a uniform type will be produced, Set<AMX> is usually the most appropriate type eg: Set<AMX> result = queryWildSet(...); param wildKeys one or more name expressions, null means all param wildValues one or more value expressions, null means all return Set of AMX or empty Set if none