public interface

IDSSXMLPerfCounterServer

com.microstrategy.webapi.IDSSXMLPerfCounterServer

Class Overview

This interface allows the user to access the performance counter functionality of the Intelligence Server.

Summary

Public Methods
abstract String GetCounterTypes(String requestXML)
Returns a list of counter types which are supported by the Intelligence Server.
abstract String GetCounterValues(String requestXML)
Returns a specified set of counter values from the Intelligence Server.
abstract String GetLocalizedCounters(Locale locale)
Returns a list of counter with the names and help messages of the category, instance and counter be localized to the specific locale.
abstract boolean GetPerfMonitoringEnabled(String sessionID)
Returns whether performance monitoring is active on the server which the given session is created upon.
abstract String LogCounters(String sessionID, String requestXML, int frequency)
Changes the performance counter logging settings on the Intelligence Server.
abstract String LogCounters(String sessionID, String requestXML, int frequency, int flag)
Changes the performance counter logging settings on the Intelligence Server.
abstract void SetPerfMonitoringEnabled(String sessionID, boolean isEnabled)
Sets whether performance monitoring should be active on the server which the given session is created upon.

Public Methods

public abstract String GetCounterTypes (String requestXML)

Returns a list of counter types which are supported by the Intelligence Server. This method will make a request to the server passed to the getPerfCounterServer method on the IDSSXMLServerSession interface.

Parameters
requestXML Reserved for future use.
Returns
  • An XML describing the different counter types supported by the Intelligence Server, along with their logging statuses.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract String GetCounterValues (String requestXML)

Returns a specified set of counter values from the Intelligence Server. The returned XML will reflect the value from the most recent update of the counters. This method will make a request to the server passed to the getPerfCounterServer method on the IDSSXMLServerSession interface.

Parameters
requestXML An XML describing the counter values which are to be retrieved.
Returns
  • An XML containing the requested values.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract String GetLocalizedCounters (Locale locale)

Returns a list of counter with the names and help messages of the category, instance and counter be localized to the specific locale.

Parameters
locale Locale The locale to localized to.
Returns
  • String An XML containing the results.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract boolean GetPerfMonitoringEnabled (String sessionID)

Returns whether performance monitoring is active on the server which the given session is created upon.

Parameters
sessionID A session ID on the server being checked.
Returns
  • True if performance monitoring is active, false otherwise.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract String LogCounters (String sessionID, String requestXML, int frequency)

Changes the performance counter logging settings on the Intelligence Server. Note that this call will override any previous log settings.

Parameters
sessionID A valid Intelligence Server session ID.
requestXML An XML containing the counter values for which logging should be enabled.
frequency The frequency to update the log file, in seconds.
Returns
  • There is currently no return value.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract String LogCounters (String sessionID, String requestXML, int frequency, int flag)

Changes the performance counter logging settings on the Intelligence Server. Note that this call will override any previous log settings.

Parameters
sessionID A valid Intelligence Server session ID.
requestXML An XML containing the counter values for which logging should be enabled.
frequency The frequency to update the log file, in seconds.
flag The flag to indicate log to statistics.
Returns
  • There is currently no return value.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract void SetPerfMonitoringEnabled (String sessionID, boolean isEnabled)

Sets whether performance monitoring should be active on the server which the given session is created upon.

Parameters
sessionID A session ID on the server being used.
isEnabled Whether the performance monitoring setting should be active or inactive.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.