Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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 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 void	addCounter(String categoryName, String instanceName, String counterName) 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 serverName, String categoryName, String instanceName, String counterName) Returns the properties configured for the counter passed.
abstract WebMonitorField	getCounterProperties(String serverName, Counter counter) Returns the properties configured for the counter passed.
abstract WebMonitorField	getCounterProperties(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 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 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.
abstract void	removeCounter(String serverName, String categoryName, String instanceName, String counterName) 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

abstract void	addDetails(boolean details) This method will add or remove details from the display unit.
abstract void	applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
abstract boolean	canHighlight()
abstract WebDisplayUnits	getChildUnits() Returns the collection of child display units, or null if the object is not a collection.
abstract String	getDisplayName() Returns the display name associated with this object.
abstract int	getDisplayUnitType() Returns the type of display unit that this object represents.
abstract String	getID() Returns the DSS ID of the display unit.
abstract boolean	hasDetails() Returns whether this display unit currently has details enabled.
abstract void	highlightUnit() Sets this display unit to be highlighted.
abstract void	highlightUnit(boolean details) Sets this display unit to be highlighted.
abstract boolean	isHighlighted() Returns whether this unit is highlighted.
abstract boolean	isObjectInfo() Returns true if underlying Web Object can be cast to `WebObjectInfo`.
abstract boolean	isSelected() Returns whether this display unit is selected.
abstract void	setDisplayName(String displayName) This method will set the value of the display name.
abstract void	setSelected(boolean selected) Sets the current unit's selection status.

From interface com.microstrategy.web.objects.WebFeatures

From interface com.microstrategy.web.objects.WebMonitor

From interface com.microstrategy.web.objects.WebObjectInfo

abstract void	buildShortObjectAttributes(WebXMLBuilder builder)
abstract void	buildShortXML(WebXMLBuilder builder)
abstract String	getAbbreviation() Returns the abbreviation of this object.
abstract int	getAccessGranted() Returns the current access granted on this object, if available.
abstract SimpleList	getAncestors() Returns a `SimpleList` containing the ancestors of this object, if they exist in the object XML.
abstract WebCertifiedInfo	getCertifiedInfo()
abstract String[]	getComments() Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
abstract String	getContainerDid()
abstract String	getContainerType()
abstract String	getCreationTime() Returns the creation time of this object, if that information is available.
abstract long	getCreationTimeStamp() Get the object creation timestamp in millisecond.
abstract String	getDataSources()
abstract String	getDescription() Returns the description of the object.
abstract int	getExtendedType() The current extended type
abstract WebObjectsFactory	getFactory() Returns WebObjectsFactory
abstract int	getFlags() Returns the flags which determine what data to populate upon calling populate.
abstract String	getID() Returns the DSS ID of the object, if one exists.
abstract String	getIconPath() Return the icon path for the object
abstract String	getModificationTime() Returns the last modification time of the object, if that information is available.
abstract long	getModificationTimeStamp() Get the object modification timestamp in millisecond.
abstract String	getName() Returns the name of this object.
abstract boolean	getNonSchedulable() Get flag of whether the object is not schedulable
abstract int	getOtherNameTransCount() Returns the count of name translations for locales other than the current effective locale.
abstract WebObjectInfo	getOwner() Returns a WebObjectInfo object which corresponds to the owner of this object.
abstract WebFolder	getParent() Returns the parent folder of the current object, if it exists.
abstract int	getPreSaveAsFlags() Returns the flags which determine the previous save as prompt flag.
abstract String	getProjectId()
abstract String	getProjectName()
abstract int	getPropertyFlags() Retrieve the current property flags
abstract SimpleList	getPropertySetFilter() Returns an editable `SimpleList` where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
abstract WebPropertyGroup	getPropertySets() Returns the property sets associated with this object.
abstract WebRecommendationInfo	getRecommendationInfo() This contains all the information related to a recommendation search
abstract WebObjectSecurity	getSecurity() Returns the `WebObjectSecurity` object associated with this WebObjectInfo object.
abstract int	getState() Returns the state of the object.
abstract int	getSubType() Returns the subtype of the object.
abstract int	getType() Returns the type of this object.
abstract String	getVersionID() Returns the Version ID of the object, if one exists.
abstract WebViewMediaSettings	getViewMediaSettings()
abstract int	getVisualizationViewMode()
abstract String	getXML(boolean encode) Returns the XML representation of this object.
abstract String	getXML() Returns the XML representation of this object.
abstract boolean	hasOwner()
abstract boolean	isAncestorNamedFolder(int folderName) Returns whether the named folder is this object's ancestor.
abstract boolean	isDirty() Returns whether this object has been modified to be different from the object in metadata.
abstract boolean	isEmbedded()
abstract boolean	isHidden() Returns whether the object is a hidden object.
abstract boolean	isNew() Returns whether this object is newly created at client side, which is not in the metadata.
abstract boolean	isPopulated() Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
abstract void	populate(String xml) Populates the fields on this object by loading the given object definition XML.
abstract void	populate() Populates the fields on this object by asking the Intelligence Server for the object definition.
abstract void	setAbbreviation(String abbreviation)
abstract void	setComments(String[] comments) Set the long description of the object as an array of strings.
abstract void	setDataSources(String dataSourcesXML)
abstract void	setDescription(String description) Sets the description of the object.
abstract void	setExtendedType(int extendedType) Set the current extended type
abstract void	setFlags(int flags) Sets the flags which determine what data to populate upon calling populate.
abstract void	setHidden(boolean hidden) Sets whether the object is a hidden object.
abstract void	setIconPath(String iconPath) Set the icon path for the object
abstract void	setName(String _name)
abstract void	setNonSchedulable(boolean nonSchedulable) Set flag of whether the object is not schedulable
abstract void	setPreSaveAsFlags(int flags) Sets the flags which determine the previous save as prompt flag.
abstract void	setPropertyFlags(int flags) Set the current property flags

From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

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 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 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 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 (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 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 (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 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

list of servers configured as a SimpleList

Throws

	the monitor XML is malformed.
WebObjectsRuntimeException

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.

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.

Interfaces

Classes

Enums

Exceptions

WebPerformanceMonitor

Class Overview

Summary

Public Methods

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

Parameters

Throws

public abstract void addCounter (Counter counter)

Parameters

Throws

public abstract void addCounter (String serverName, Counter counter)

Parameters

Throws

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

Parameters

Throws

public abstract Categories getCategories ()

Returns

Throws

public abstract Categories getCategories (String serverName)

Parameters

Returns

Throws

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

Parameters

Returns

Throws

public abstract WebMonitorField getCounterProperties (String serverName, Counter counter)

Parameters

Returns

Throws

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

Parameters

Returns

Throws

public abstract WebMonitorField getCounterProperties (Counter _counter)

Parameters

Returns

Throws

public abstract String getServerName (Counter counter)

Parameters

Returns

Throws

public abstract SimpleList getServers ()

Returns

Throws

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

Parameters

Throws

public abstract void removeCounter (String serverName, Counter counter)

Parameters

Throws

public abstract void removeCounter (Counter counter)

Parameters

Throws

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

Parameters

Throws