public interface

IDSSXMLServerAdmin

com.microstrategy.webapi.IDSSXMLServerAdmin

Class Overview

Interface for server administration related operation.

Summary

Public Methods
abstract String DisconnectDBConnections(String sessionID, String dbConnectionListXML)
Disconnects a list of database connections.
abstract String DisconnectUserConnections(String sessionID, String userListXML)
Disconnects a list of user connections.
abstract String GetCacheInfo(int cacheType, String sessionID, int blockBegin, int blockCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)
Retrieves the information of caches.
abstract String GetCacheInfo(String sessionID, int blockBegin, int blockCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)
Retrieves the information of caches.
abstract String GetDBConnectionInfo(String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)
Retrieves the information of database connections.
abstract String GetJobInfo(String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)
Retrieves the information of jobs currently running in the Intelligence Server.
abstract String GetUserConnectionInfo(String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)
Retrieves the information of user connections.
abstract String KillJobs(String sessionID, String jobListXML)
Kills a list of jobs which are currently running in the Intelligence Server.
abstract String ManipulateCaches(String sessionID, String manipulationXML)
Manipulate caches, such as load, unload, invalidate, and delete cache.
abstract String ManipulateCaches(int cacheType, String sessionID, String manipulationXML)
Manipulate caches, such as load, unload, invalidate, and delete cache.
abstract void PerformProjectLoadBalancing(String sessionID)
Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map.
abstract void PurgeCaches(String sessionID, String projectDSSID, int purgeFlag)
Purge caches of the specified project.
abstract void PurgeServerStats(String sessionID, Date fromDate, Date toDate, int timeout, String projectName)
Cause the Intelligence Server to purge the server statistics during a period.
abstract void PurgeServerStats(String sessionID, Date fromDate, Date toDate, int timeout)
Cause the Intelligence Server to purge the server statistics during a period.

Public Methods

public abstract String DisconnectDBConnections (String sessionID, String dbConnectionListXML)

Disconnects a list of database connections.

Parameters
sessionID an Intelligence Server session id.
dbConnectionListXML an XML string reprensenting a list of DB connections to be disconnected.
Returns
  • an XML string representing failures occurred during the operation.
Throws
MSTRWebAPIException thrown if there is any error occurred, such as network error, server crash etc.

public abstract String DisconnectUserConnections (String sessionID, String userListXML)

Disconnects a list of user connections.

Parameters
sessionID an Intelligence Server session id.
userListXML an XML string reprensenting a list of user connections to be disconnected.
Returns
  • an XML string representing failures occurred during the operation.
Throws
MSTRWebAPIException thrown if there is any error occurred, such as network error, server crash etc.

public abstract String GetCacheInfo (int cacheType, String sessionID, int blockBegin, int blockCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)

Retrieves the information of caches.

Parameters
cacheType cache type. see see EnumDSSXMLCacheType
sessionID an Intelligence Server session id.
blockBegin the starting index of items in incremental fetch
blockCount the block size of items in incremental fetch
levelFlag indicates at what level of information to retrieve. see EnumDSSXMLLevelFlags
fieldFilterXML the filtering XML to retrieve cache information.
countXML the counting XML to retrieve cache information.
sortingXML the sorting XML to retrieve cache information.
Returns
  • an XML string representing the cache information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetCacheInfo (String sessionID, int blockBegin, int blockCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)

Retrieves the information of caches.

Parameters
sessionID an Intelligence Server session id.
blockBegin the starting index of items in incremental fetch
blockCount the block size of items in incremental fetch
levelFlag indicates at what level of information to retrieve. see EnumDSSXMLLevelFlags
fieldFilterXML the filtering XML to retrieve cache information.
countXML the counting XML to retrieve cache information.
sortingXML the sorting XML to retrieve cache information.
Returns
  • an XML string representing the cache information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetDBConnectionInfo (String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)

Retrieves the information of database connections.

Parameters
sessionID an Intelligence Server session id.
maxCount the max number of database connection records to return.
levelFlag indicates at what level of information to retrieve. see EnumDSSXMLLevelFlags
fieldFilterXML the filtering XML to retrieve database connection information.
countXML the counting XML to retrieve database connection information.
sortingXML the sorting XML to retrieve database connection information.
Returns
  • an XML string representing the database connection information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetJobInfo (String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)

Retrieves the information of jobs currently running in the Intelligence Server.

Parameters
sessionID an Intelligence Server session id.
maxCount the max number of job records to return.
levelFlag indicates at what level of information to retrieve. see EnumDSSXMLLevelFlags
fieldFilterXML the filtering XML to retrieve job information.
countXML the counting XML to retrieve job information.
sortingXML the sorting XML to retrieve job information.
Returns
  • an XML string representing the job information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetUserConnectionInfo (String sessionID, int maxCount, int levelFlag, String fieldFilterXML, String countXML, String sortingXML)

Retrieves the information of user connections.

Parameters
sessionID an Intelligence Server session id.
maxCount the max number of user connection records to return.
levelFlag indicates at what level of information to retrieve. see EnumDSSXMLLevelFlags
fieldFilterXML the filtering XML to retrieve user connection information.
countXML the counting XML to retrieve user connection information.
sortingXML the sorting XML to retrieve user connection information.
Returns
  • an XML string representing the user connection information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String KillJobs (String sessionID, String jobListXML)

Kills a list of jobs which are currently running in the Intelligence Server.

Parameters
sessionID an Intelligence Server session id.
jobListXML an XML string reprensenting a list of jobs to be killed.
Returns
  • an XML string representing failures occurred during the operation.
Throws
MSTRWebAPIException thrown if there is any error occurred, such as network error, server crash etc.

public abstract String ManipulateCaches (String sessionID, String manipulationXML)

Manipulate caches, such as load, unload, invalidate, and delete cache.

Parameters
sessionID an Intelligence Server session id.
manipulationXML the cache manipulation XML.
Returns
  • an XML string representing failures occurred during the operation.
Throws
MSTRWebAPIException thrown if there is any error occurred, such as network error, server crash etc.

public abstract String ManipulateCaches (int cacheType, String sessionID, String manipulationXML)

Manipulate caches, such as load, unload, invalidate, and delete cache.

Parameters
cacheType cache type. see see EnumDSSXMLCacheType
sessionID an Intelligence Server session id.
manipulationXML the cache manipulation XML.
Returns
  • an XML string representing failures occurred during the operation.
Throws
MSTRWebAPIException thrown if there is any error occurred, such as network error, server crash etc.

public abstract void PerformProjectLoadBalancing (String sessionID)

Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map. Even we only send request to one server, that server will notify all other servers in the cluster to load/unload projects according to the latest map.

Parameters
sessionID String A valid session ID.
Throws
MSTRWebAPIException

public abstract void PurgeCaches (String sessionID, String projectDSSID, int purgeFlag)

Purge caches of the specified project. If no project ID is specified, the caches of all the projects associated with the session are purged.

Parameters
sessionID an Intelligence Server session id.
projectDSSID a project ID whose caches to be purged.
purgeFlag a flag from EnumDSSXMLPurgeFlag
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract void PurgeServerStats (String sessionID, Date fromDate, Date toDate, int timeout, String projectName)

Cause the Intelligence Server to purge the server statistics during a period.

Parameters
sessionID String A valid session ID.
fromDate Date The start date of the period to purge.
toDate Date The end date of the period to purge.
timeout int maximum time (in second) allowed for the purging process.
projectName String The Project Name whose statistics will be purged.
Throws
MSTRWebAPIException Thrown when error occurs.

public abstract void PurgeServerStats (String sessionID, Date fromDate, Date toDate, int timeout)

Cause the Intelligence Server to purge the server statistics during a period.

Parameters
sessionID String A valid session ID.
fromDate Date The start date of the period to purge.
toDate Date The end date of the period to purge.
timeout int maximum time (in second) allowed for the purging process.
Throws
MSTRWebAPIException Thrown when error occurs.