Package com.microstrategy.webapi

Interface IDSSXMLPerfCounterServer

public interface IDSSXMLPerfCounterServer

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

Since:

MicroStrategy Web 7.5.0

Method Summary

Modifier and Type	Method	Description
java.lang.String	GetCounterTypes(java.lang.String requestXML)	Returns a list of counter types which are supported by the Intelligence Server.
java.lang.String	GetCounterValues(java.lang.String requestXML)	Returns a specified set of counter values from the Intelligence Server.
java.lang.String	GetLocalizedCounters(java.util.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.
boolean	GetPerfMonitoringEnabled(java.lang.String sessionID)	Returns whether performance monitoring is active on the server which the given session is created upon.
java.lang.String	LogCounters(java.lang.String sessionID, java.lang.String requestXML, int frequency)	Changes the performance counter logging settings on the Intelligence Server.
java.lang.String	LogCounters(java.lang.String sessionID, java.lang.String requestXML, int frequency, int flag)	Changes the performance counter logging settings on the Intelligence Server.
void	SetPerfMonitoringEnabled(java.lang.String sessionID, boolean isEnabled)	Sets whether performance monitoring should be active on the server which the given session is created upon.

Method Detail

GetCounterTypes

java.lang.String GetCounterTypes(java.lang.String requestXML)
                          throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 7.5.2

GetLocalizedCounters

java.lang.String GetLocalizedCounters(java.util.Locale locale)
                               throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 8.0.0

GetCounterValues

java.lang.String GetCounterValues(java.lang.String requestXML)
                           throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 7.5.2

LogCounters

java.lang.String LogCounters(java.lang.String sessionID,
                             java.lang.String requestXML,
                             int frequency)
                      throws MSTRWebAPIException

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.

LogCounters

java.lang.String LogCounters(java.lang.String sessionID,
                             java.lang.String requestXML,
                             int frequency,
                             int flag)
                      throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 9.0.0

GetPerfMonitoringEnabled

boolean GetPerfMonitoringEnabled(java.lang.String sessionID)
                          throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 7.5.2

SetPerfMonitoringEnabled

void SetPerfMonitoringEnabled(java.lang.String sessionID,
                              boolean isEnabled)
                       throws MSTRWebAPIException

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.

Since:

MicroStrategy Web 7.5.2