Package com.microstrategy.web.objects

Interface WebPerformanceMonitor

All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebMonitor, WebObjectInfo, WebPromptSite

public interface WebPerformanceMonitor
extends WebMonitor

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.

Since:

MicroStrategy Web 7.5.0

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
void	addCounter(Counter counter)	Adds the counter passed to this monitor.
void	addCounter(java.lang.String serverName, Counter counter)	Adds the counter passed to this monitor.
void	addCounter(java.lang.String categoryName, java.lang.String instanceName, java.lang.String counterName)	Adds the counter passed to this monitor.
void	addCounter(java.lang.String serverName, java.lang.String categoryName, java.lang.String instanceName, java.lang.String counterName)	Adds the counter passed to this monitor.
Categories	getCategories()	Returns the counters configured in this monitor for non-named Intelligence Servers.
Categories	getCategories(java.lang.String serverName)	Returns the counters configured in this monitor for the server passed.
WebMonitorField	getCounterProperties(Counter _counter)	Returns the properties configured for the counter passed.
WebMonitorField	getCounterProperties(java.lang.String serverName, Counter counter)	Returns the properties configured for the counter passed.
WebMonitorField	getCounterProperties(java.lang.String _categoryName, java.lang.String _instanceName, java.lang.String _counterName)	Returns the properties configured for the counter passed.
WebMonitorField	getCounterProperties(java.lang.String serverName, java.lang.String categoryName, java.lang.String instanceName, java.lang.String counterName)	Returns the properties configured for the counter passed.
java.lang.String	getServerName(Counter counter)	Returns the server name for the counter passed.
SimpleList	getServers()	Returns the unique list of servers configured in this monitor.
void	removeCounter(Counter counter)	Removes the counter passed from this monitor.
void	removeCounter(java.lang.String serverName, Counter counter)	Removes the counter passed from this monitor.
void	removeCounter(java.lang.String categoryName, java.lang.String instanceName, java.lang.String counterName)	Removes the counter passed from this monitor.
void	removeCounter(java.lang.String serverName, java.lang.String categoryName, java.lang.String instanceName, java.lang.String counterName)	Removes the counter passed from this monitor.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebMonitor

add, elements, get, getItemByName, getMonitorType, isEmpty, remove, remove, size

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getServers

SimpleList getServers()
               throws WebObjectsRuntimeException

Returns the unique list of servers configured in this monitor.

Returns:

list of servers configured as a SimpleList

Throws:

WebObjectsRuntimeException

getCategories

Categories getCategories(java.lang.String serverName)
                  throws WebObjectsRuntimeException

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:

WebObjectsRuntimeException

getCategories

Categories getCategories()
                  throws WebObjectsRuntimeException

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:

WebObjectsRuntimeException

Since:

MicroStrategy Web 7.5.2

addCounter

void addCounter(java.lang.String serverName,
                java.lang.String categoryName,
                java.lang.String instanceName,
                java.lang.String counterName)
         throws java.lang.IllegalArgumentException,
                WebObjectsRuntimeException

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:

java.lang.IllegalArgumentException - if one or more of the arguments passed are incorrect (null).

WebObjectsRuntimeException - if the monitor XML is malformed.

addCounter

void addCounter(java.lang.String categoryName,
                java.lang.String instanceName,
                java.lang.String counterName)
         throws java.lang.IllegalArgumentException,
                WebObjectsRuntimeException

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:

java.lang.IllegalArgumentException - if one or more of the arguments passed are incorrect (null).

WebObjectsRuntimeException - if the monitor XML is malformed.

Since:

MicroStrategy Web 7.5.2

addCounter

void addCounter(java.lang.String serverName,
                Counter counter)
         throws java.lang.IllegalArgumentException,
                WebObjectsRuntimeException

Adds the counter passed to this monitor.

Parameters:

serverName - The name of the IServer

counter - The Counter to be added.

Throws:

java.lang.IllegalArgumentException - if one or more of the arguments passed are incorrect (null).

WebObjectsRuntimeException - if the monitor XML is malformed.

addCounter

void addCounter(Counter counter)
         throws java.lang.IllegalArgumentException,
                WebObjectsRuntimeException

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:

java.lang.IllegalArgumentException - if one or more of the arguments passed are incorrect (null).

WebObjectsRuntimeException - if the monitor XML is malformed.

Since:

MicroStrategy Web 7.5.2

removeCounter

void removeCounter(java.lang.String serverName,
                   java.lang.String categoryName,
                   java.lang.String instanceName,
                   java.lang.String counterName)
            throws java.lang.IllegalArgumentException,
                   WebObjectsRuntimeException

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:

java.lang.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.

removeCounter

void removeCounter(java.lang.String categoryName,
                   java.lang.String instanceName,
                   java.lang.String counterName)
            throws java.lang.IllegalArgumentException,
                   WebObjectsRuntimeException

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:

java.lang.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.

Since:

MicroStrategy Web 7.5.2

removeCounter

void removeCounter(java.lang.String serverName,
                   Counter counter)
            throws java.lang.IllegalArgumentException,
                   WebObjectsRuntimeException

Removes the counter passed from this monitor.

Parameters:

serverName - The name of the IServer

counter - The Counter to be removed.

Throws:

java.lang.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.

removeCounter

void removeCounter(Counter counter)
            throws java.lang.IllegalArgumentException,
                   WebObjectsRuntimeException

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:

java.lang.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.

Since:

MicroStrategy Web 7.5.2

getCounterProperties

WebMonitorField getCounterProperties(java.lang.String serverName,
                                     java.lang.String categoryName,
                                     java.lang.String instanceName,
                                     java.lang.String counterName)
                              throws java.lang.IllegalArgumentException,
                                     WebObjectsRuntimeException

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:

java.lang.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.

getCounterProperties

WebMonitorField getCounterProperties(java.lang.String serverName,
                                     Counter counter)
                              throws java.lang.IllegalArgumentException,
                                     WebObjectsRuntimeException

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:

java.lang.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.

getCounterProperties

WebMonitorField getCounterProperties(Counter _counter)
                              throws java.lang.IllegalArgumentException,
                                     WebObjectsRuntimeException

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:

java.lang.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.

Since:

MicroStrategy Web 7.5.2

getCounterProperties

WebMonitorField getCounterProperties(java.lang.String _categoryName,
                                     java.lang.String _instanceName,
                                     java.lang.String _counterName)
                              throws java.lang.IllegalArgumentException,
                                     WebObjectsRuntimeException

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:

java.lang.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.

Since:

MicroStrategy Web 7.5.2

getServerName

java.lang.String getServerName(Counter counter)
                        throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - Thrown if the counter did not come from this performance monitor object.

Since:

MicroStrategy Web 7.5.2