FileDocCategorySizeDatePackage
CustomMBeanConfigQueries.javaAPI DocGlassfish v2 API5593Fri May 04 22:24:10 BST 2007com.sun.enterprise.admin.mbeans.custom

CustomMBeanConfigQueries

public interface CustomMBeanConfigQueries
Defines the behavior for querying the various MBean definitions. This is to factor out the MBean related operations. The implementing classes could have specific behaviors depending upon product edition, for example.
since
SJSAS9.0

Fields Summary
Constructors Summary
Methods Summary
public booleanexistsMBean(java.lang.String target, java.lang.String name)
Returns if the given MBean is referenced from a given target.

param
target String representing the cluster or server instance
param
name String representing the name of the MBean
return
a boolean representing if the given MBean exists in the given target
throws
CustomMBeanException

public booleanisMBeanEnabled(java.lang.String target, java.lang.String name)
Returns if the given MBean is referenced from a given target and is enabled.

param
target String representing the cluster or server instance
param
name String representing the name of the MBean
return
a boolean representing if the given MBean exists in the given target and is enabled
throws
CustomMBeanException

public java.util.ListlistMBeanConfigObjectNames(java.lang.String target)
Returns access to get more information about the custom MBeans referenced from a server instance. Every Config MBean is a wrapper over the domain.xml element and the ObjectName of this MBean can allow clients to get more information such as ObjectType of the custom MBean, by standard JMX calls. This method returns such ObjectNames. This method is more useful with a caveat that getting more information from the server results in additional calls to the server.

see
#listMBeanNames(String) which returns only the names of these MBeans
param
target String representing the cluster or server instance
return
a List of ObjectNames representing the Config MBeans representing referenced MBeans
throws
CustomMBeanException

public java.util.ListlistMBeanConfigObjectNames(java.lang.String target, int type, boolean state)
A convenience method to take care of various client requests. It resembles the function of a filter. Useful in getting the List of MBeans that for example are of object-type "USER_DEFINED" and are not enabled. This is a more general purpose query interface.

param
target String representing the cluster or server instance
param
type an integer representing the type of MBean
state
boolean representing if or not the MBean is enabled
see
CustomMBeanConstants
see
#listMBeanConfigObjectNames(String)
return
the List of Config MBeans that represent an MBean definition referenced from a server instance or cluster

public java.util.ListlistMBeanNames(java.lang.String target)
Returns the collection of all the custom MBeans for a target as a List of Strings. Each element in the list the name of the custom MBean created. Thus for a standalone instance this method would return all the MBeans that are referenced from it.

param
target String representing the cluster or server instance
return
a List of Strings representing the referenced MBeans
throws
CustomMBeanException