com.sun.enterprise.admin.monitor.registry

Interface MonitoringRegistry

public interface MonitoringRegistry

Provides component specific methods to enable components to register their Stats implementations for monitoring. Implementation of this interface enables a JSR77 Managed Resource's monitoring statistics to be presented through JMX's API through a DynamicMBean created on the fly and registered with the MBeanServer. Each registration method also provides the facility of passing in an implementation of MonitoringLevelListener interface. The purpose of that interface is to enable components to be notified of a change in monitoring level from/to OFF, LOW or HIGH. A notification pursuant to a change in monitoring level should result in a call to unregister previously registered Stats implementations. If the change is set at a level LOW or HIGH, a call to register alternative Stats implementations that correspond to the new monitoring level is to be made by the component. Consequently, a new MBean is registered with the MBeanServer so that clients may now request statistics corresponding to the monitoring level.
Registered Stats implementations can be unregistered through the component specific unregister() methods.

Version:

$Revision: 1.4 $

Author:

Shreedhar Ganapathy

See Also:

com.sun.enterprise.admin.monitor.registry.MonitoringLevelListener.java, com.sun.enterprise.admin.monitor.registry.MonitoringLevel.java

Method Summary

Methods

Modifier and Type	Method and Description
WebModuleStats	getWebModuleStats(String j2eeAppName, String webModuleName, String ctxRoot, String vsId) Gets the WebModuleStats associated with the web module named webModuleName that is part of the application named j2eeAppName and has been deployed on the virtual server vsId.
void	registerConnectionFactoryStats(ConnectionFactoryStats stats, String factoryName, MonitoringLevelListener listener) Registers the ConnectionFactoryStats for the jms-service
void	registerConnectorConnectionPoolStats(ConnectorConnectionPoolStats connectorConnectionPoolStats, String connectorConnectionPoolName, MonitoringLevelListener listener) Registers the Stats implementation for ConnectorConnectionPoolStats
void	registerConnectorConnectionPoolStats(ConnectorConnectionPoolStats stats, String poolName, String j2eeAppName, String moduleName, MonitoringLevelListener listener) Registers the Stats implementation for ConnectorConnectionPoolStats
void	registerConnectorWorkMgmtStats(ConnectorWorkMgmtStats stats, String j2eeAppName, String moduleName, boolean isJms, MonitoringLevelListener listener) Registers the work management stats for the connector
void	registerConnectorWorkMgmtStats(ConnectorWorkMgmtStats stats, String j2eeAppName, String moduleName, MonitoringLevelListener listener) Registers the work management stats for the connector
void	registerEJBCacheStats(EJBCacheStats ejbCacheStats, MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for EJBCacheStats
void	registerEJBMethodStats(EJBMethodStats ejbMethodStats, String ejbMethodName, MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for EJBMethodStats
void	registerEJBPoolStats(EJBPoolStats ejbPoolStats, MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for EJBPoolStats
void	registerEntityBeanStats(EntityBeanStats entityBeanStats, String entityBeanName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for EntityBeanStats
void	registerHttpListenerStats(HTTPListenerStats stats, String listenerName, String vsId, MonitoringLevelListener listener) Registeres the Stats for Http Listener for the web-server/web-container layer.
void	registerJDBCConnectionPoolStats(JDBCConnectionPoolStats jdbcConnectionPoolStats, String jdbcConnectionPoolName, MonitoringLevelListener listener) Registers the Stats implementation for JDBCConnectionPoolStats
void	registerJTAStats(GFJTAStats jtaStats, MonitoringLevelListener listener) Registers the Stats implementation for the resource JTAStats
void	registerJVMStats(JVMStats stats, MonitoringLevelListener listener)
void	registerMessageDrivenBeanStats(MessageDrivenBeanStats messageDrivenBeanStats, String messageDrivenBeanName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for MessageDrivenBeanStats
void	registerMonitoringLevelListener(MonitoringLevelListener listener, MonitoredObjectType objType) Registers the given listener for the given type of monitorable entity.
void	registerOrbConnectionManagerStats(OrbConnectionManagerStats orbConnectionManagerStats, String connectionMgrName, MonitoringLevelListener listener) Registers the Stats implementation for OrbConnectionManagerStats
void	registerPWCConnectionQueueStats(PWCConnectionQueueStats stats, MonitoringLevelListener listener) Registers the ConnectionQueueStats for PWC.
void	registerPWCDnsStats(PWCDnsStats stats, MonitoringLevelListener listener) Registers the DNSStats for PWC.
void	registerPWCFileCacheStats(PWCFileCacheStats stats, MonitoringLevelListener listener) Registers the FileCacheStats for PWC.
void	registerPWCHttpServiceStats(PWCHttpServiceStats stats, MonitoringLevelListener listener) Registers the HttpServiceStats for PWC.
void	registerPWCKeepAliveStats(PWCKeepAliveStats stats, MonitoringLevelListener listener) Registers the KeepAliveStats for PWC.
void	registerPWCRequestStats(PWCRequestStats stats, String vsId, MonitoringLevelListener listener) Registers the RequestStats for PWC.
void	registerPWCThreadPoolStats(PWCThreadPoolStats stats, MonitoringLevelListener listener) Registers the ThreadPoolStats for PWC.
void	registerPWCVirtualServerStats(PWCVirtualServerStats stats, String vsId, MonitoringLevelListener listener) Registers the VirtualServerStats for PWC.
void	registerServletStats(ServletStats stats, String j2eeAppName, String webModuleName, String ctxRoot, String vsId, String servletName, MonitoringLevelListener listener) registers a servlet/JSP, with the monitoring infrastructure The servlet/Jsp could be part of a J2EE Application or a stand-alone web module.
void	registerStatefulSessionBeanStats(StatefulSessionBeanStats statefulSessionBeanStats, String statefulSessionBeanName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for StatefulSessionBeanStats
void	registerStatefulSessionStoreStats(StatefulSessionStoreStats stats, MonitoredObjectType ejbType, String ejbName, String moduleName, String j2eeAppName, MonitoringLevelListener listener) Registers the Sessionstore stats for an ejb
void	registerStatelessSessionBeanStats(StatelessSessionBeanStats statelessSessionBeanStats, String statelessSessionBeanName, String moduleName, String applicationName, MonitoringLevelListener listener) Registers the Stats implementation for StatelessSessionBeanStats
void	registerThreadPoolStats(ThreadPoolStats ThreadPoolStats, String threadPoolId, MonitoringLevelListener listener) Registers the Stats implementation for ThreadPoolStats.
void	registerTimerStats(TimerServiceStats stats, MonitoredObjectType ejbType, String ejbName, String moduleName, String j2eeAppName, MonitoringLevelListener listener) Registers the timer stats for an ejb
void	registerWebModuleStats(WebModuleStats stats, String j2eeAppName, String webModuleName, String ctxRoot, String vsId, MonitoringLevelListener listener) Registers the given WebModuleStats for the web module with the given webModuleName deployed on the virtual server with the given vsId.
void	registerWSAggregateStatsForEjb(Stats stats, String endpointName, String moduleName, String j2eeAppName, MonitoringLevelListener listener) Registers the Aggregate stats for an web service endpoint
void	registerWSAggregateStatsForWeb(Stats stats, String endpointName, String moduleName, String ctxRoot, String j2eeAppName, String vs, MonitoringLevelListener listener) Registers the Aggregate stats for an web service endpoint
void	unregisterConnectionFactoryStats(String factoryName) Unregisters the ConnectionFactoryStats for the jms-service
void	unregisterConnectorConnectionPoolStats(String connectorConnectionPoolName) Unregisters the Stats implementation for ConnectorConnectionPoolStats
void	unregisterConnectorConnectionPoolStats(String poolName, String j2eeAppName, String moduleName) Unregisters the Stats implementation for ConnectorConnectionPoolStats
void	unregisterConnectorWorkMgmtStats(String j2eeAppName, String moduleName) Unregisters the work management stats for the connector
void	unregisterConnectorWorkMgmtStats(String j2eeAppName, String moduleName, boolean isJms) Unregisters the work management stats for the connector
void	unregisterEJBCacheStats(MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName) Unregisters the Stats implementation for EJBCacheStats
void	unregisterEJBMethodStats(String ejbMethodName, MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName) Unregisters the Stats implementation for EJBMethodStats
void	unregisterEJBPoolStats(MonitoredObjectType ejbType, String ejbName, String moduleName, String applicationName) Unregisters the Stats implementation for EJBPoolStats
void	unregisterEntityBeanStats(String entityBeanName, String moduleName, String applicationName) Unregisters the Stats implementation for EntityBeanStats
void	unregisterHttpListenerStats(String listenerName, String vsId) Unregisters the stats for Http Listener for given listenerName and virtual-server-id.
void	unregisterJDBCConnectionPoolStats(String jdbcConnectionPoolName) Unregisters the Stats implementation for JDBCConnectionPoolStats
void	unregisterJTAStats() Unregisters the Stats implementation for the resource JTAStats
void	unregisterJVMStats()
void	unregisterMessageDrivenBeanStats(String messageDrivenBeanName, String moduleName, String applicationName) Unregisters the Stats implementation for MessageDrivenBeanStats
void	unregisterMonitoringLevelListener(MonitoringLevelListener listener) Unregisters the given MonitoringLevelListener so that it is removed from internal list.
void	unregisterOrbConnectionManagerStats(String orbName) Unregisters the Stats implementation for OrbConnectionManagerStats
void	unregisterPWCConnectionQueueStats() Unregisters the stats for the ConnectionQueue
void	unregisterPWCDnsStats() Unregisters the stats for the DNS
void	unregisterPWCFileCacheStats() Unregisters the stats for the FileCache
void	unregisterPWCHttpServiceStats() Unregisters the stats for the HttpService
void	unregisterPWCKeepAliveStats() Unregisters the stats for the KeepAlive system
void	unregisterPWCRequestStats(String vsId) Unregisters the stats for the PWCrequest
void	unregisterPWCThreadPoolStats() Unregisters the stats for the PWCThreadPool
void	unregisterPWCVirtualServerStats(String vsId) Unregisters the stats for the VirtualServer
void	unregisterServletStats(String j2eeAppName, String webModuleName, String ctxRoot, String vsId, String servletName) unregisters a servlet/JSP, from the monitoring infrastructure The servlet/Jsp could be part of a J2EE Application or a stand-alone web module.
void	unregisterStatefulSessionBeanStats(String statefulSessionBeanName, String moduleName, String applicationName) Unregisters the Stats implementation for StatefulSessionBeanStats
void	unregisterStatefulSessionStoreStats(MonitoredObjectType ejbType, String ejbName, String moduleName, String j2eeAppName) Unregisters the Sessionstore stats for the ejb
void	unregisterStatelessSessionBeanStats(String statelessSessionBeanName, String moduleName, String applicationName) Unregisters the Stats implementation for StatelessSessionBeanStats
void	unregisterThreadPoolStats(String poolId) Unregisters the Stats implementation for ThreadPoolStats.
void	unregisterTimerStats(MonitoredObjectType ejbType, String ejbName, String moduleName, String j2eeAppName) Unregisters the timer stats for an ejb
void	unregisterWebModuleStats(String j2eeAppName, String webModuleName, String ctxRoot, String vsId) Unregisters any WebModuleStats from the web module with the given webModuleName deployed on the virtual server with the given vsId.
void	unregisterWSAggregateStatsForEjb(String endpointName, String moduleName, String j2eeAppName) Unregisters the web service stats in a module
void	unregisterWSAggregateStatsForWeb(String endpointName, String moduleName, String ctxRoot, String j2eeAppName, String vs) Unregisters the web service stats in a module

Method Detail

registerEntityBeanStats

void registerEntityBeanStats(EntityBeanStats entityBeanStats,
                           String entityBeanName,
                           String moduleName,
                           String applicationName,
                           MonitoringLevelListener listener)
                             throws MonitoringRegistrationException

Registers the Stats implementation for EntityBeanStats

Parameters:

entityBeanStats - implementation of org.glassfish.j2ee.statistics.EntityBeanStats

entityBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EntityBean deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterEntityBeanStats

void unregisterEntityBeanStats(String entityBeanName,
                             String moduleName,
                             String applicationName)
                               throws MonitoringRegistrationException

Unregisters the Stats implementation for EntityBeanStats

Parameters:

entityBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EntityBean deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerStatelessSessionBeanStats

void registerStatelessSessionBeanStats(StatelessSessionBeanStats statelessSessionBeanStats,
                                     String statelessSessionBeanName,
                                     String moduleName,
                                     String applicationName,
                                     MonitoringLevelListener listener)
                                       throws MonitoringRegistrationException

Registers the Stats implementation for StatelessSessionBeanStats

Parameters:

statelessSessionBeanStats - implementation of org.glassfish.j2ee.statistics.StatelessSessionBeanStats

statelessSessionBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a StatelessSessionBean deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterStatelessSessionBeanStats

void unregisterStatelessSessionBeanStats(String statelessSessionBeanName,
                                       String moduleName,
                                       String applicationName)
                                         throws MonitoringRegistrationException

Unregisters the Stats implementation for StatelessSessionBeanStats

Parameters:

statelessSessionBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a StatelessSessionBean deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerStatefulSessionBeanStats

void registerStatefulSessionBeanStats(StatefulSessionBeanStats statefulSessionBeanStats,
                                    String statefulSessionBeanName,
                                    String moduleName,
                                    String applicationName,
                                    MonitoringLevelListener listener)
                                      throws MonitoringRegistrationException

Registers the Stats implementation for StatefulSessionBeanStats

Parameters:

statefulSessionBeanStats - implementation of from org.glassfish.j2ee.statistics.StatefulSessionBeanStats

statefulSessionBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a StatefulSessionBean deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterStatefulSessionBeanStats

void unregisterStatefulSessionBeanStats(String statefulSessionBeanName,
                                      String moduleName,
                                      String applicationName)
                                        throws MonitoringRegistrationException

Unregisters the Stats implementation for StatefulSessionBeanStats

Parameters:

statefulSessionBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a StatefulSessionBean deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerMessageDrivenBeanStats

void registerMessageDrivenBeanStats(MessageDrivenBeanStats messageDrivenBeanStats,
                                  String messageDrivenBeanName,
                                  String moduleName,
                                  String applicationName,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the Stats implementation for MessageDrivenBeanStats

Parameters:

messageDrivenBeanStats - implementation of org.glassfish.j2ee.statistics.MessageDrivenBeanStats

messageDrivenBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a MessageDrivenBean deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterMessageDrivenBeanStats

void unregisterMessageDrivenBeanStats(String messageDrivenBeanName,
                                    String moduleName,
                                    String applicationName)
                                      throws MonitoringRegistrationException

Unregisters the Stats implementation for MessageDrivenBeanStats

Parameters:

messageDrivenBeanName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for a MessageDrivenBean deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerEJBCacheStats

void registerEJBCacheStats(EJBCacheStats ejbCacheStats,
                         MonitoredObjectType ejbType,
                         String ejbName,
                         String moduleName,
                         String applicationName,
                         MonitoringLevelListener listener)
                           throws MonitoringRegistrationException

Registers the Stats implementation for EJBCacheStats

Parameters:

ejbCacheStats - implemetation of com.sun.enterprise.admin.monitor.stats.EJBCacheStats

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterEJBCacheStats

void unregisterEJBCacheStats(MonitoredObjectType ejbType,
                           String ejbName,
                           String moduleName,
                           String applicationName)
                             throws MonitoringRegistrationException

Unregisters the Stats implementation for EJBCacheStats

Parameters:

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerEJBPoolStats

void registerEJBPoolStats(EJBPoolStats ejbPoolStats,
                        MonitoredObjectType ejbType,
                        String ejbName,
                        String moduleName,
                        String applicationName,
                        MonitoringLevelListener listener)
                          throws MonitoringRegistrationException

Registers the Stats implementation for EJBPoolStats

Parameters:

ejbPoolStats - implementation of com.sun.enterprise.admin.monitor.stats.EJBPoolStats

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterEJBPoolStats

void unregisterEJBPoolStats(MonitoredObjectType ejbType,
                          String ejbName,
                          String moduleName,
                          String applicationName)
                            throws MonitoringRegistrationException

Unregisters the Stats implementation for EJBPoolStats

Parameters:

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerEJBMethodStats

void registerEJBMethodStats(EJBMethodStats ejbMethodStats,
                          String ejbMethodName,
                          MonitoredObjectType ejbType,
                          String ejbName,
                          String moduleName,
                          String applicationName,
                          MonitoringLevelListener listener)
                            throws MonitoringRegistrationException

Registers the Stats implementation for EJBMethodStats

Parameters:

ejbMethodStats - implementation of com.sun.enterprise.admin.monitor.stats.EJBMethodStats

ejbMethodName -

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterEJBMethodStats

void unregisterEJBMethodStats(String ejbMethodName,
                            MonitoredObjectType ejbType,
                            String ejbName,
                            String moduleName,
                            String applicationName)
                              throws MonitoringRegistrationException

Unregisters the Stats implementation for EJBMethodStats

Parameters:

ejbMethodName -

ejbName -

moduleName -

applicationName - passing a null here would indicate that this is a registration for an EJB deployed under a standalone module.

Throws:

MonitoringRegistrationException

registerOrbConnectionManagerStats

void registerOrbConnectionManagerStats(OrbConnectionManagerStats orbConnectionManagerStats,
                                     String connectionMgrName,
                                     MonitoringLevelListener listener)
                                       throws MonitoringRegistrationException

Registers the Stats implementation for OrbConnectionManagerStats

Parameters:

orbConnectionManagerStats - implementation of com.sun.enterprise.admin.monitor.stats.OrbConnectionManagerStats

connectionMgrName - id of the connection-manager

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterOrbConnectionManagerStats

void unregisterOrbConnectionManagerStats(String orbName)
                                         throws MonitoringRegistrationException

Unregisters the Stats implementation for OrbConnectionManagerStats

Parameters:

orbName -

Throws:

MonitoringRegistrationException

registerThreadPoolStats

void registerThreadPoolStats(ThreadPoolStats ThreadPoolStats,
                           String threadPoolId,
                           MonitoringLevelListener listener)
                             throws MonitoringRegistrationException

Registers the Stats implementation for ThreadPoolStats. This is meant to be used for any ThreadPool in the server runtime.

Parameters:

ThreadPoolStats - implementation of com.sun.enterprise.admin.monitor.stats.ThreadPoolStats

poolId - String that represents the thread pool id -- needs to be unique

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterThreadPoolStats

void unregisterThreadPoolStats(String poolId)
                               throws MonitoringRegistrationException

Unregisters the Stats implementation for ThreadPoolStats.

Parameters:

poolId - String representing the (unique) name of the pool

Throws:

MonitoringRegistrationException

registerConnectorConnectionPoolStats

void registerConnectorConnectionPoolStats(ConnectorConnectionPoolStats connectorConnectionPoolStats,
                                        String connectorConnectionPoolName,
                                        MonitoringLevelListener listener)
                                          throws MonitoringRegistrationException

Registers the Stats implementation for ConnectorConnectionPoolStats

Parameters:

connectorConnectionPoolStats - implementation of com.sun.enterprise.admin.monitor.stats.ConnectorConnectionPoolStats

connectorConnectionPoolName -

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterConnectorConnectionPoolStats

void unregisterConnectorConnectionPoolStats(String connectorConnectionPoolName)
                                            throws MonitoringRegistrationException

Unregisters the Stats implementation for ConnectorConnectionPoolStats

Parameters:

connectorConnectionPoolName -

Throws:

MonitoringRegistrationException

registerJDBCConnectionPoolStats

void registerJDBCConnectionPoolStats(JDBCConnectionPoolStats jdbcConnectionPoolStats,
                                   String jdbcConnectionPoolName,
                                   MonitoringLevelListener listener)
                                     throws MonitoringRegistrationException

Registers the Stats implementation for JDBCConnectionPoolStats

Parameters:

jdbcConnectionPoolStats - implementation of com.sun.enterprise.admin.monitor.stats.JDBCConnectionPoolStats

jdbcConnectionPoolName -

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterJDBCConnectionPoolStats

void unregisterJDBCConnectionPoolStats(String jdbcConnectionPoolName)
                                       throws MonitoringRegistrationException

Unregisters the Stats implementation for JDBCConnectionPoolStats

Parameters:

jdbcConnectionPoolName -

Throws:

MonitoringRegistrationException

registerJTAStats

void registerJTAStats(GFJTAStats jtaStats,
                    MonitoringLevelListener listener)
                      throws MonitoringRegistrationException

Registers the Stats implementation for the resource JTAStats

Parameters:

jtaStats - implementation of com.sun.enterprise.admin.monitor.stats.JTAStats

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterJTAStats

void unregisterJTAStats()
                        throws MonitoringRegistrationException

Unregisters the Stats implementation for the resource JTAStats

Throws:

MonitoringRegistrationException

registerJVMStats

void registerJVMStats(JVMStats stats,
                    MonitoringLevelListener listener)
                      throws MonitoringRegistrationException

Throws:

MonitoringRegistrationException

unregisterJVMStats

void unregisterJVMStats()
                        throws MonitoringRegistrationException

Throws:

MonitoringRegistrationException

registerHttpListenerStats

void registerHttpListenerStats(HTTPListenerStats stats,
                             String listenerName,
                             String vsId,
                             MonitoringLevelListener listener)
                               throws MonitoringRegistrationException

Registeres the Stats for Http Listener for the web-server/web-container layer. Can't be called for the same listener more than once. This method should generally be called when a particular listener is being started.

Parameters:

listenerName - String representing the name of the listener (may not be null)

vsId - String representing the id of pertinent virtual server (may not be null)

Throws:

MonitoringRegistrationException - in case there is a registration failure

unregisterHttpListenerStats

void unregisterHttpListenerStats(String listenerName,
                               String vsId)
                                 throws MonitoringRegistrationException

Unregisters the stats for Http Listener for given listenerName and virtual-server-id. This method should generally be called when particular listener is deleted/stopped.

Parameters:

listenerName - String representing the listener's name (may not be null)

vsId - String represeting the virtual server id (may not be null)

Throws:

MonitoringRegistrationException - in case of a failure

registerMonitoringLevelListener

void registerMonitoringLevelListener(MonitoringLevelListener listener,
                                   MonitoredObjectType objType)

Registers the given listener for the given type of monitorable entity. It is required that all the implementing classes issue the callback synchonously to the provided MonitoringLevelListener before returning to the caller. The idea is that core components should know if the registration of specific Stats is required before doing the actual registration. It is upto the components to decide what do when the callback is issued. The given listener will be added to the internal list of listeners and will be notified when the level changes. Note that this method breaks the relationship between a Stats object and a MonitoringLevelListener object. Thus all the listeners that register through this method will receive null as the Stats parameter value in MonitoringLevelListener#changeLevel method.

Parameters:

{@link - MonitoringLevelListener} that is interested in a specific type (may not be null)

{@link - MonitoredObjectType} that indicates a specific monitored object

Throws:

RuntimeException - if the registration fails

unregisterMonitoringLevelListener

void unregisterMonitoringLevelListener(MonitoringLevelListener listener)

Unregisters the given MonitoringLevelListener so that it is removed from internal list. The registration of same listener has to be done prior to this method call. This will usually happen when the registered listener has to exit from the VM.

Parameters:

MonitoringLevelListener - that is registered earlier

Throws:

RuntimeException - if the Listener is not registered before

registerServletStats

void registerServletStats(ServletStats stats,
                        String j2eeAppName,
                        String webModuleName,
                        String ctxRoot,
                        String vsId,
                        String servletName,
                        MonitoringLevelListener listener)
                          throws MonitoringRegistrationException

registers a servlet/JSP, with the monitoring infrastructure The servlet/Jsp could be part of a J2EE Application or a stand-alone web module.

Parameters:

stats - An instance of the ServletStats

j2eeAppName - A string representing the J2EE Application to which the webmodule belongs. If the j2eeAppName is null, then the webmodule is a stand-alone webmodule

webModuleName - The name of the web module to which the servlet belongs

ctxRoot - The context root at which the web module has been deployed

vsId - The virtual-server, with which the webmodule is associated

servletName - The name of the servlet/jsp being monitored

listener -

Throws:

MonitoringRegistrationException - in case of a failure

unregisterServletStats

void unregisterServletStats(String j2eeAppName,
                          String webModuleName,
                          String ctxRoot,
                          String vsId,
                          String servletName)
                            throws MonitoringRegistrationException

unregisters a servlet/JSP, from the monitoring infrastructure The servlet/Jsp could be part of a J2EE Application or a stand-alone web module.

Parameters:

j2eeAppName - A string representing the J2EE Application to which the webmodule belongs. If the j2eeAppName is null, then the webmodule is a stand-alone webmodule

webModuleName - The name of the web module to which the servlet belongs

ctxRoot - The context root at which the web module has been deployed

vsId - The virtual-server, with which the webmodule is associated

servletName - The name of the servlet/jsp being monitored

Throws:

MonitoringRegistrationException - in case of a failure

registerWebModuleStats

void registerWebModuleStats(WebModuleStats stats,
                          String j2eeAppName,
                          String webModuleName,
                          String ctxRoot,
                          String vsId,
                          MonitoringLevelListener listener)
                            throws MonitoringRegistrationException

Registers the given WebModuleStats for the web module with the given webModuleName deployed on the virtual server with the given vsId.

Parameters:

stats - The stats to register

j2eeAppName - String representing the J2EE Application to which the web module belongs, or null if the web module is stand-alone

webModuleName - The name of the web module for which to register the stats

ctxRoot - The context root at which the web module has been deployed

vsId - The id of the virtual-server on which the web module has been deployed

listener - The listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterWebModuleStats

void unregisterWebModuleStats(String j2eeAppName,
                            String webModuleName,
                            String ctxRoot,
                            String vsId)
                              throws MonitoringRegistrationException

Unregisters any WebModuleStats from the web module with the given webModuleName deployed on the virtual server with the given vsId.

Parameters:

j2eeAppName - String representing the J2EE Application to which the web module belongs, or null if the web module is stand-alone

webModuleName - The name of the web module from which to unregister the stats

ctxRoot - The context root at which the web module has been deployed

vsId - The id of the virtual-server on which the web module has been deployed

Throws:

MonitoringRegistrationException

getWebModuleStats

WebModuleStats getWebModuleStats(String j2eeAppName,
                               String webModuleName,
                               String ctxRoot,
                               String vsId)

Gets the WebModuleStats associated with the web module named webModuleName that is part of the application named j2eeAppName and has been deployed on the virtual server vsId.

Parameters:

j2eeAppName - String representing the J2EE Application to which the web module belongs, or null if the web module is stand-alone

webModuleName - The name of the web module whose stats are to be returned

ctxRoot - The context root at which the web module has been deployed

vsId - The id of the virtual-server on which the web module has been deployed

Returns:

The desired WebModuleStats

registerPWCHttpServiceStats

void registerPWCHttpServiceStats(PWCHttpServiceStats stats,
                               MonitoringLevelListener listener)
                                 throws MonitoringRegistrationException

Registers the HttpServiceStats for PWC.

Parameters:

stats - an instance of PWCHttpServiceStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCHttpServiceStats

void unregisterPWCHttpServiceStats()
                                   throws MonitoringRegistrationException

Unregisters the stats for the HttpService

Throws:

MonitoringRegistrationException

registerPWCConnectionQueueStats

void registerPWCConnectionQueueStats(PWCConnectionQueueStats stats,
                                   MonitoringLevelListener listener)
                                     throws MonitoringRegistrationException

Registers the ConnectionQueueStats for PWC.

Parameters:

stats - an instance of PWCConnectionQueueStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCConnectionQueueStats

void unregisterPWCConnectionQueueStats()
                                       throws MonitoringRegistrationException

Unregisters the stats for the ConnectionQueue

Throws:

MonitoringRegistrationException

registerPWCDnsStats

void registerPWCDnsStats(PWCDnsStats stats,
                       MonitoringLevelListener listener)
                         throws MonitoringRegistrationException

Registers the DNSStats for PWC.

Parameters:

stats - an instance of PWCDnsStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCDnsStats

void unregisterPWCDnsStats()
                           throws MonitoringRegistrationException

Unregisters the stats for the DNS

Throws:

MonitoringRegistrationException

registerPWCKeepAliveStats

void registerPWCKeepAliveStats(PWCKeepAliveStats stats,
                             MonitoringLevelListener listener)
                               throws MonitoringRegistrationException

Registers the KeepAliveStats for PWC.

Parameters:

stats - an instance of PWCKeepAliveStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCKeepAliveStats

void unregisterPWCKeepAliveStats()
                                 throws MonitoringRegistrationException

Unregisters the stats for the KeepAlive system

Throws:

MonitoringRegistrationException

registerPWCThreadPoolStats

void registerPWCThreadPoolStats(PWCThreadPoolStats stats,
                              MonitoringLevelListener listener)
                                throws MonitoringRegistrationException

Registers the ThreadPoolStats for PWC.

Parameters:

stats - an instance of PWCThreadPoolStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCThreadPoolStats

void unregisterPWCThreadPoolStats()
                                  throws MonitoringRegistrationException

Unregisters the stats for the PWCThreadPool

Throws:

MonitoringRegistrationException

registerPWCFileCacheStats

void registerPWCFileCacheStats(PWCFileCacheStats stats,
                             MonitoringLevelListener listener)
                               throws MonitoringRegistrationException

Registers the FileCacheStats for PWC.

Parameters:

stats - an instance of PWCFileCacheStats

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCFileCacheStats

void unregisterPWCFileCacheStats()
                                 throws MonitoringRegistrationException

Unregisters the stats for the FileCache

Throws:

MonitoringRegistrationException

registerPWCVirtualServerStats

void registerPWCVirtualServerStats(PWCVirtualServerStats stats,
                                 String vsId,
                                 MonitoringLevelListener listener)
                                   throws MonitoringRegistrationException

Registers the VirtualServerStats for PWC.

Parameters:

stats - an instance of PWCVirtualServerStats

vsId - the Id of the virtual-server for which the Stats are being registered

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCVirtualServerStats

void unregisterPWCVirtualServerStats(String vsId)
                                     throws MonitoringRegistrationException

Unregisters the stats for the VirtualServer

Parameters:

vsId - the Id of the virtual-server, whose stats need to be deregistered

Throws:

MonitoringRegistrationException

registerPWCRequestStats

void registerPWCRequestStats(PWCRequestStats stats,
                           String vsId,
                           MonitoringLevelListener listener)
                             throws MonitoringRegistrationException

Registers the RequestStats for PWC.

Parameters:

stats - an instance of PWCRequestStats

vsId - the Id of the virtual-server for which the Stats are being registered

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterPWCRequestStats

void unregisterPWCRequestStats(String vsId)
                               throws MonitoringRegistrationException

Unregisters the stats for the PWCrequest

Parameters:

vsId - the Id of the virutal-server

Throws:

MonitoringRegistrationException

registerConnectorWorkMgmtStats

void registerConnectorWorkMgmtStats(ConnectorWorkMgmtStats stats,
                                  String j2eeAppName,
                                  String moduleName,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the work management stats for the connector

Parameters:

stats - an instance of com.sun.enterprise.admin.monitor.stats.ConnectorWorkMgmtStats

j2eeAppName - the name of the j2eeApp,in which the connector is embedded if null, indicates that a standalone connector is being monitored

moduleName - the name of the connector module

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

registerConnectorWorkMgmtStats

void registerConnectorWorkMgmtStats(ConnectorWorkMgmtStats stats,
                                  String j2eeAppName,
                                  String moduleName,
                                  boolean isJms,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the work management stats for the connector

Parameters:

stats - an instance of com.sun.enterprise.admin.monitor.stats.ConnectorWorkMgmtStats

j2eeAppName - the name of the j2eeApp,in which the connector is embedded if null, indicates that a standalone connector is being monitored

moduleName - the name of the connector module

isJms - if true, indicates that the workmanagement stats are being registered for jms-service

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterConnectorWorkMgmtStats

void unregisterConnectorWorkMgmtStats(String j2eeAppName,
                                    String moduleName)
                                      throws MonitoringRegistrationException

Unregisters the work management stats for the connector

Parameters:

j2eeAppName - the name of the j2eeApp,in which the connector is embedded if null, indicates that a standalone connector is being monitored

moduleName - the name of the connector module

Throws:

MonitoringRegistrationException

unregisterConnectorWorkMgmtStats

void unregisterConnectorWorkMgmtStats(String j2eeAppName,
                                    String moduleName,
                                    boolean isJms)
                                      throws MonitoringRegistrationException

Unregisters the work management stats for the connector

Parameters:

j2eeAppName - the name of the j2eeApp,in which the connector is embedded if null, indicates that a standalone connector is being monitored

moduleName - the name of the connector module

isJms - if true, indicates that the workmanagement stats are being unregistered from jms-service

Throws:

MonitoringRegistrationException

registerConnectionFactoryStats

void registerConnectionFactoryStats(ConnectionFactoryStats stats,
                                  String factoryName,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the ConnectionFactoryStats for the jms-service

Parameters:

stats - an instance of com.sun.enterprise.admin.monitor.stats.ConnectionFactoryStats

factoryName - the name of the connection factory

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterConnectionFactoryStats

void unregisterConnectionFactoryStats(String factoryName)
                                      throws MonitoringRegistrationException

Unregisters the ConnectionFactoryStats for the jms-service

Parameters:

factoryName - the name of the connection factory

Throws:

MonitoringRegistrationException

registerConnectorConnectionPoolStats

void registerConnectorConnectionPoolStats(ConnectorConnectionPoolStats stats,
                                        String poolName,
                                        String j2eeAppName,
                                        String moduleName,
                                        MonitoringLevelListener listener)
                                          throws MonitoringRegistrationException

Registers the Stats implementation for ConnectorConnectionPoolStats

Parameters:

connectorConnectionPoolStats - implementation of com.sun.enterprise.admin.monitor.stats.ConnectorConnectionPoolStats

poolName -

j2eeAppName - the name of the j2eeApp

moduleName - the name the connector module

listener - This an optional field and when not required, a null value should be passed. If a MonitoringLevelListener is defined, the listener's setLevel() method will be called in response to a change in monitoring level.

Throws:

MonitoringRegistrationException

unregisterConnectorConnectionPoolStats

void unregisterConnectorConnectionPoolStats(String poolName,
                                          String j2eeAppName,
                                          String moduleName)
                                            throws MonitoringRegistrationException

Unregisters the Stats implementation for ConnectorConnectionPoolStats

Parameters:

poolName -

j2eeAppName -

moduleName -

Throws:

MonitoringRegistrationException

registerStatefulSessionStoreStats

void registerStatefulSessionStoreStats(StatefulSessionStoreStats stats,
                                     MonitoredObjectType ejbType,
                                     String ejbName,
                                     String moduleName,
                                     String j2eeAppName,
                                     MonitoringLevelListener listener)
                                       throws MonitoringRegistrationException

Registers the Sessionstore stats for an ejb

Parameters:

stats - an instance of com.sun.enterprise.admin.monitor.stats.StatefulSessionStoreStats

ejbName - the name of the ejb for which the stats are being registered

moduleName - the name of the jar to which the ejb belongs

j2eeAppName - the name of the j2eeApp, that contains the ejb jar if null, indicates that the ejb jar is standalone

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterStatefulSessionStoreStats

void unregisterStatefulSessionStoreStats(MonitoredObjectType ejbType,
                                       String ejbName,
                                       String moduleName,
                                       String j2eeAppName)
                                         throws MonitoringRegistrationException

Unregisters the Sessionstore stats for the ejb

Parameters:

ejbName - the name of the ejb for which the stats are being unregistered

moduleName - the name of the jar, to which the ejb belongs

j2eeAppName - the name of the j2eeApp, that contains the ejb jar

Throws:

MonitoringRegistrationException

registerTimerStats

void registerTimerStats(TimerServiceStats stats,
                      MonitoredObjectType ejbType,
                      String ejbName,
                      String moduleName,
                      String j2eeAppName,
                      MonitoringLevelListener listener)
                        throws MonitoringRegistrationException

Registers the timer stats for an ejb

Parameters:

stats - an instance of com.sun.enterprise.admin.monitor.stats.TimerServiceStats

ejbName - the name of the ejb for which the stats are being registered

moduleName - the name of the jar containing the ejb

j2eeAppName - the name of the j2eeApp, that contains the ejb jar if null, indicated that the ejb jar is standalone

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterTimerStats

void unregisterTimerStats(MonitoredObjectType ejbType,
                        String ejbName,
                        String moduleName,
                        String j2eeAppName)
                          throws MonitoringRegistrationException

Unregisters the timer stats for an ejb

Parameters:

ejbName - the name of the ejb for which the stats are being unregistered

moduleName - the name of the jar, to which the ejb belongs

j2eeAppName - the name of the j2eeApp, that contains the ejb jar

Throws:

MonitoringRegistrationException

registerWSAggregateStatsForWeb

void registerWSAggregateStatsForWeb(Stats stats,
                                  String endpointName,
                                  String moduleName,
                                  String ctxRoot,
                                  String j2eeAppName,
                                  String vs,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the Aggregate stats for an web service endpoint

Parameters:

stats - an instance of com.sun.appserv.management.monitor.statistics.WebServiceAggregateStats

endpointName - the name of the endpoint for which the stats are being registered

moduleName - the name of the jar to which the ejb belongs

ctxRoot - The context root at which the web module has been deployed

j2eeAppName - the name of the j2eeApp, that contains the ejb jar if null, indicates that the ejb jar is standalone

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterWSAggregateStatsForWeb

void unregisterWSAggregateStatsForWeb(String endpointName,
                                    String moduleName,
                                    String ctxRoot,
                                    String j2eeAppName,
                                    String vs)
                                      throws MonitoringRegistrationException

Unregisters the web service stats in a module

Parameters:

endpointName - the name of the endpoint for which the stats are being unregistered

moduleName - the name of the jar, to which the endpoint belongs

ctxRoot - The context root at which the web module has been deployed

j2eeAppName - the name of the j2eeApp, that contains the ejb jar

Throws:

MonitoringRegistrationException

registerWSAggregateStatsForEjb

void registerWSAggregateStatsForEjb(Stats stats,
                                  String endpointName,
                                  String moduleName,
                                  String j2eeAppName,
                                  MonitoringLevelListener listener)
                                    throws MonitoringRegistrationException

Registers the Aggregate stats for an web service endpoint

Parameters:

stats - an instance of com.sun.appserv.management.monitor.statistics.WebServiceAggregateStats

endpointName - the name of the endpoint for which the stats are being registered

moduleName - the name of the jar to which the ejb belongs

j2eeAppName - the name of the j2eeApp, that contains the ejb jar if null, indicates that the ejb jar is standalone

listener - the listener for monitoring level changes

Throws:

MonitoringRegistrationException

unregisterWSAggregateStatsForEjb

void unregisterWSAggregateStatsForEjb(String endpointName,
                                    String moduleName,
                                    String j2eeAppName)
                                      throws MonitoringRegistrationException

Unregisters the web service stats in a module

Parameters:

endpointName - the name of the endpoint for which the stats are being unregistered

moduleName - the name of the jar, to which the endpoint belongs

j2eeAppName - the name of the j2eeApp, that contains the ejb jar

Throws:

MonitoringRegistrationException