public interface

WebPerformanceMonitor

implements WebMonitor
com.microstrategy.web.objects.WebPerformanceMonitor

Class Overview

WebPerformanceMonitor corresponds to a performance monitor in the metadata. It is a subclass of WebMonitor. It exposes methods to access the Servers and Counters configured in the monitor. Counters can also be added and removed through it.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void addCounter(String categoryName, String instanceName, String counterName)
Adds the counter passed to this monitor.
abstract void addCounter(String serverName, String categoryName, String instanceName, String counterName)
Adds the counter passed to this monitor.
abstract void addCounter(Counter counter)
Adds the counter passed to this monitor.
abstract void addCounter(String serverName, Counter counter)
Adds the counter passed to this monitor.
abstract Categories getCategories()
Returns the counters configured in this monitor for non-named Intelligence Servers.
abstract Categories getCategories(String serverName)
Returns the counters configured in this monitor for the server passed.
abstract WebMonitorField getCounterProperties(String _categoryName, String _instanceName, String _counterName)
Returns the properties configured for the counter passed.
abstract WebMonitorField getCounterProperties(String serverName, String categoryName, String instanceName, String counterName)
Returns the properties configured for the counter passed.
abstract WebMonitorField getCounterProperties(Counter _counter)
Returns the properties configured for the counter passed.
abstract WebMonitorField getCounterProperties(String serverName, Counter counter)
Returns the properties configured for the counter passed.
abstract String getServerName(Counter counter)
Returns the server name for the counter passed.
abstract SimpleList getServers()
Returns the unique list of servers configured in this monitor.
abstract void removeCounter(String serverName, String categoryName, String instanceName, String counterName)
Removes the counter passed from this monitor.
abstract void removeCounter(String categoryName, String instanceName, String counterName)
Removes the counter passed from this monitor.
abstract void removeCounter(String serverName, Counter counter)
Removes the counter passed from this monitor.
abstract void removeCounter(Counter counter)
Removes the counter passed from this monitor.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebMonitor
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract void addCounter (String categoryName, String instanceName, String counterName)

Adds the counter passed to this monitor. This method will add a server-independent counter, which will apply to whatever server the session is active on.

Parameters
categoryName The name of the Category
instanceName The name of the instance
counterName The name of the counter
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null).
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void addCounter (String serverName, String categoryName, String instanceName, String counterName)

Adds the counter passed to this monitor.

Parameters
serverName The name of the IServer
categoryName The name of the Category
instanceName The name of the instance
counterName The name of the counter
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null).
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void addCounter (Counter counter)

Adds the counter passed to this monitor. This counter will not be attached to any particular server - instead, it will be such that the counter will apply to the server that the session is created on.

Parameters
counter The Counter to be added.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null).
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void addCounter (String serverName, Counter counter)

Adds the counter passed to this monitor.

Parameters
serverName The name of the IServer
counter The Counter to be added.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null).
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract Categories getCategories ()

Returns the counters configured in this monitor for non-named Intelligence Servers. The counters are returned as part of a Category-Instance-Counter hierarchy.

Returns
  • Categories in this monitor corresponding to the serverName passed.
Throws
the monitor XML is malformed.
WebObjectsRuntimeException

public abstract Categories getCategories (String serverName)

Returns the counters configured in this monitor for the server passed. The counters are returned as part of a Category-Instance-Counter hierarchy.

Parameters
serverName The name of the server for which categories are queried.
Returns
  • Categories in this monitor corresponding to the serverName passed.
Throws
the monitor XML is malformed.
WebObjectsRuntimeException

public abstract WebMonitorField getCounterProperties (String _categoryName, String _instanceName, String _counterName)

Returns the properties configured for the counter passed. The properties are returned as a WebMonitorField object which is a collection of WebMonitorProperty objects. Note that this method works for counters with no server associated with them.

Parameters
_categoryName The name of the category.
_instanceName The name of the instance
_counterName The name of the counter
Returns
  • WebMonitorField The properties for the counter passed as a monitor field.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract WebMonitorField getCounterProperties (String serverName, String categoryName, String instanceName, String counterName)

Returns the properties configured for the counter passed. The properties are returned as a WebMonitorField object which is a collection of WebMonitorProperty objects.

Parameters
serverName The name of the IServer.
categoryName The name of the category.
instanceName The name of the instance
counterName The name of the counter
Returns
  • WebMonitorField The properties for the counter passed as a monitor field.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract WebMonitorField getCounterProperties (Counter _counter)

Returns the properties configured for the counter passed. The properties are returned as a WebMonitorField object which is a collection of WebMonitorProperty objects. This method works for counters which are not associated with any server.

Parameters
_counter The counter object whose properties are queried.
Returns
  • WebMonitorField The properties for the counter passed as a monitor field.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract WebMonitorField getCounterProperties (String serverName, Counter counter)

Returns the properties configured for the counter passed. The properties are returned as a WebMonitorField object which is a collection of WebMonitorProperty objects.

Parameters
serverName The name of the IServer.
counter The counter object whose properties are queried.
Returns
  • WebMonitorField The properties for the counter passed as a monitor field.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract String getServerName (Counter counter)

Returns the server name for the counter passed. This will only be returned if the serverName came from this WebPerformanceMonitor object.

Parameters
counter The counter to look up.
Returns
  • The name of the server, or null if it is a serverless counter.
Throws
IllegalArgumentException Thrown if the counter did not come from this performance monitor object.

public abstract SimpleList getServers ()

Returns the unique list of servers configured in this monitor.

Returns
Throws
the monitor XML is malformed.
WebObjectsRuntimeException

public abstract void removeCounter (String serverName, String categoryName, String instanceName, String counterName)

Removes the counter passed from this monitor.

Parameters
serverName The name of the IServer
categoryName The name of the Category
instanceName The name of the instance
counterName The name of the counter
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void removeCounter (String categoryName, String instanceName, String counterName)

Removes the counter passed from this monitor. This method removes a counter which is not tied to a particular server name.

Parameters
categoryName The name of the Category
instanceName The name of the instance
counterName The name of the counter
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void removeCounter (String serverName, Counter counter)

Removes the counter passed from this monitor.

Parameters
serverName The name of the IServer
counter The Counter to be removed.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.

public abstract void removeCounter (Counter counter)

Removes the counter passed from this monitor. This method removes a counter not tied to a particular server name.

Parameters
counter The Counter to be removed.
Throws
IllegalArgumentException if one or more of the arguments passed are incorrect (null). Also, thrown if the counter passed does not exist.
WebObjectsRuntimeException if the monitor XML is malformed.