public class

PerformanceMonitorBeanManager

extends Object
java.lang.Object
   ↳ com.microstrategy.web.beans.PerformanceMonitorBeanManager

Class Overview

The PerformanceMonitorBeanManager has two purposes: (1) to act as a factory for PerformanceMonitorBean objects, and (2) to provide a persistence mechanism for them. A PerformanceMonitorBean is meant to represent one set of performance counters across Intelligence Servers in a cluster. The model being advocated is that one PerformanceMonitorBean corresponds to one graph object. Note that the PerformanceMonitorBean is thread-safe, even with multiple threads sharing the same instance, but the PerformanceMonitorBean instances it gives out are only thread-safe in the usage scenario of one instance per thread.

Summary

Public Methods
void freeMonitorBean(String identifier)
This method will release the PerformanceMonitorBean with the given identifer (if any) from the MonitorBeanManager's persistence mechanism.
static PerformanceMonitorBeanManager getInstance()
Returns an instance of the MonitorBeanManager object.
PerformanceMonitorBean getMonitorBean(String identifier)
This method will return a saved monitor bean with the given identifier.
int getMonitorBeanTimeout()
This method will return the current value of the timeout of beans saved using the saveMonitorBean method.
PerformanceMonitorBean newMonitorBean()
This method will return a new PerformanceMonitorBean object.
String saveMonitorBean(PerformanceMonitorBean bean)
This method will save the given monitor bean into the MonitorBeanManager, and return an identifier which can be used to retrieve the monitor bean at a future time.
void setMonitorBeanTimeout(int timeoutInSecs)
This method will set the timeout of beans saved using the saveMonitorBean method.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void freeMonitorBean (String identifier)

This method will release the PerformanceMonitorBean with the given identifer (if any) from the MonitorBeanManager's persistence mechanism.

Parameters
identifier The identifier of the bean to delete.

public static PerformanceMonitorBeanManager getInstance ()

Returns an instance of the MonitorBeanManager object. This object can then be used to obtain and save PerformanceMonitorBean objects.

Returns
  • An instance of the MonitorBeanManager object.

public PerformanceMonitorBean getMonitorBean (String identifier)

This method will return a saved monitor bean with the given identifier.

Parameters
identifier The String identifier of the monitor bean.
Returns
Throws
IllegalArgumentException Thrown if the given identifier does not exist in the MonitorBeanManager.

public int getMonitorBeanTimeout ()

This method will return the current value of the timeout of beans saved using the saveMonitorBean method.

Returns
  • The current monitor bean timeout, in seconds.

public PerformanceMonitorBean newMonitorBean ()

This method will return a new PerformanceMonitorBean object.

Returns

public String saveMonitorBean (PerformanceMonitorBean bean)

This method will save the given monitor bean into the MonitorBeanManager, and return an identifier which can be used to retrieve the monitor bean at a future time.

Parameters
bean The bean to save.
Returns
  • A String identifier which is used with the getMonitorBean method to retrieve the saved MonitorBean.
Throws
CacheException Thrown if an error occurs when saving the bean.
IllegalArgumentException thrown if an invalid bean(null) is passed.

public void setMonitorBeanTimeout (int timeoutInSecs)

This method will set the timeout of beans saved using the saveMonitorBean method. If a bean is not accessed within the specified time, it will be destroyed.

Parameters
timeoutInSecs The timeout of saved beans, in seconds.