Package com.microstrategy.webapi
Interface IDSSXMLServerAdmin
-
public interface IDSSXMLServerAdmin
Interface for server administration related operation.- Since:
- MicroStrategy Web 8.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
DisconnectDBConnections(java.lang.String sessionID, java.lang.String dbConnectionListXML)
Disconnects a list of database connections.java.lang.String
DisconnectDBConnections(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String dbConnectionListXML)
Disconnects a list of database connections.java.lang.String
DisconnectDBConnections(java.lang.String sessionID, java.lang.String nodeName, java.lang.String dbConnectionListXML)
Deprecated.java.lang.String
DisconnectUserConnections(java.lang.String sessionID, java.lang.String userListXML)
Disconnects a list of user connections.java.lang.String
DisconnectUserConnections(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String userListXML)
Disconnects a list of user connections.java.lang.String
DisconnectUserConnections(java.lang.String sessionID, java.lang.String nodeName, java.lang.String userListXML)
Deprecated.java.lang.String
GetCacheInfo(int cacheType, java.lang.String sessionID, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of caches.java.lang.String
GetCacheInfo(int cacheType, java.lang.String sessionID, java.lang.String nodeName, int port, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML, boolean serverLevel, java.lang.String pollStateId)
Retrieves the information of caches from a specific Intelligence Server.java.lang.String
GetCacheInfo(java.lang.String sessionID, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of caches.java.lang.String
GetDBConnectionInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of database connections.java.lang.String
GetDBConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of database connections.java.lang.String
GetDBConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Deprecated.java.lang.String
GetJobInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of jobs currently running in the Intelligence Server.java.lang.String
GetJobInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of jobs currently running in the Intelligence Server.java.lang.String
GetServerBusyStatus(java.lang.String sessionID)
Get the Server Busy indicatorjava.lang.String
GetUserConnectionInfo(java.lang.String sessionID, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the informatio of user connections from a startIndex to (startIndex + maxCount)java.lang.String
GetUserConnectionInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Retrieves the information of user connections.java.lang.String
GetUserConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
java.lang.String
GetUserConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML)
Deprecated.java.lang.String
KillJobs(java.lang.String sessionID, java.lang.String jobListXML)
Kills a list of jobs which are currently running in the Intelligence Server.java.lang.String
KillJobs(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String jobListXML)
Kills a list of jobs which are currently running in the Intelligence Server.java.lang.String
ManipulateCaches(int cacheType, java.lang.String sessionID, java.lang.String manipulationXML)
Manipulate caches, such as load, unload, invalidate, and delete cache.java.lang.String
ManipulateCaches(int cacheType, java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String manipulationXML, boolean asynchronous, StringWrapper pollStateId)
Manipulate caches, such as load, unload, invalidate, and delete cache on a specific Intelligence Server.java.lang.String
ManipulateCaches(java.lang.String sessionID, java.lang.String manipulationXML)
Manipulate caches, such as load, unload, invalidate, and delete cache.void
PerformProjectLoadBalancing(java.lang.String sessionID)
Cause the Intelligence Servers in cluster to load/unload projects according to the latest asymmetric clustering map.void
PurgeCaches(java.lang.String sessionID, java.lang.String projectDSSID, int purgeFlag)
Purge caches of the specified project.void
PurgeServerStats(java.lang.String sessionID, java.util.Date fromDate, java.util.Date toDate, int timeout)
Cause the Intelligence Server to purge the server statistics during a period.void
PurgeServerStats(java.lang.String sessionID, java.util.Date fromDate, java.util.Date toDate, int timeout, java.lang.String projectName)
Cause the Intelligence Server to purge the server statistics during a period.
-
-
-
Method Detail
-
PurgeServerStats
void PurgeServerStats(java.lang.String sessionID, java.util.Date fromDate, java.util.Date toDate, int timeout) throws MSTRWebAPIException
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.
-
PurgeServerStats
void PurgeServerStats(java.lang.String sessionID, java.util.Date fromDate, java.util.Date toDate, int timeout, java.lang.String projectName) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 9.0.0
-
PerformProjectLoadBalancing
void PerformProjectLoadBalancing(java.lang.String sessionID) throws MSTRWebAPIException
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
-
GetJobInfo
java.lang.String GetJobInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
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. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 9.0.0
-
GetJobInfo
java.lang.String GetJobInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Retrieves the information of jobs currently running in the Intelligence Server.- Parameters:
sessionID
- an Intelligence Server session id.nodeName
- node name of the IServer you want to get job info from.maxCount
- the max number of job records to return.levelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 11.3.2
-
GetServerBusyStatus
java.lang.String GetServerBusyStatus(java.lang.String sessionID) throws MSTRWebAPIException
Get the Server Busy indicator- Parameters:
sessionID
- an Intelligence Server session id.- Returns:
- an XML string representing the server busy indicator.
- Throws:
MSTRWebAPIException
- thrown if there is any error occurred.- Since:
- MicroStrategy Web 11.2.1
-
KillJobs
java.lang.String KillJobs(java.lang.String sessionID, java.lang.String jobListXML) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 9.0.0
-
KillJobs
java.lang.String KillJobs(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String jobListXML) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 11.3.2
-
GetUserConnectionInfo
@Deprecated java.lang.String GetUserConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Deprecated.- Throws:
MSTRWebAPIException
-
GetUserConnectionInfo
java.lang.String GetUserConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
- Parameters:
sessionID
- - expected a master session ID in Library workflownodeName
- - expected a nodeName that the user connection info to retrieve fromport
- - expected a port to IServer that the user connection info to retrieve frommaxCount
-levelFlag
-fieldFilterXML
-countXML
-sortingXML
-- Returns:
- Throws:
MSTRWebAPIException
-
GetUserConnectionInfo
java.lang.String GetUserConnectionInfo(java.lang.String sessionID, int startIndex, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Retrieves the informatio of user connections from a startIndex to (startIndex + maxCount)- Parameters:
sessionID
- expected a master session ID in Library workflow.startIndex
- expected a nodeName that the user connection info to retrieve from.maxCount
- the max number of user connection records to return.levelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
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.
-
GetUserConnectionInfo
java.lang.String GetUserConnectionInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
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. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 9.0.0
-
DisconnectUserConnections
@Deprecated java.lang.String DisconnectUserConnections(java.lang.String sessionID, java.lang.String nodeName, java.lang.String userListXML) throws MSTRWebAPIException
Deprecated.- Throws:
MSTRWebAPIException
-
DisconnectUserConnections
java.lang.String DisconnectUserConnections(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String userListXML) throws MSTRWebAPIException
Disconnects a list of user connections.- Parameters:
sessionID
- an Intelligence Server session id.nodeName
- the Intelligence Server to get the information.port
- the Intelligence Server port to get the information.userListXML
- an XML string representing 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.- Since:
- MicroStrategy Web 9.0.0
-
DisconnectUserConnections
java.lang.String DisconnectUserConnections(java.lang.String sessionID, java.lang.String userListXML) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 9.0.0
-
GetDBConnectionInfo
@Deprecated java.lang.String GetDBConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Deprecated.- Throws:
MSTRWebAPIException
-
GetDBConnectionInfo
java.lang.String GetDBConnectionInfo(java.lang.String sessionID, java.lang.String nodeName, int port, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Retrieves the information of database connections.- Parameters:
sessionID
- an Intelligence Server session id.nodeName
- node name of the IServer you want to get DB connection info from.port
- port of the IServer you want to get DB connection info from.maxCount
- the max number of database connection records to return.levelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
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:
- DB connection information.
- Throws:
MSTRWebAPIException
-
GetDBConnectionInfo
java.lang.String GetDBConnectionInfo(java.lang.String sessionID, int maxCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
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. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 9.0.0
-
DisconnectDBConnections
@Deprecated java.lang.String DisconnectDBConnections(java.lang.String sessionID, java.lang.String nodeName, java.lang.String dbConnectionListXML) throws MSTRWebAPIException
Deprecated.- Throws:
MSTRWebAPIException
-
DisconnectDBConnections
java.lang.String DisconnectDBConnections(java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String dbConnectionListXML) throws MSTRWebAPIException
Disconnects a list of database connections.- Parameters:
sessionID
- Master session id of Intelligence Server cluster.nodeName
- node name of the IServer you want to disconnect a list of database connections.port
- port of the IServer you want to disconnect a list of database connections.dbConnectionListXML
- an XML string representing 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.
-
DisconnectDBConnections
java.lang.String DisconnectDBConnections(java.lang.String sessionID, java.lang.String dbConnectionListXML) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 9.0.0
-
GetCacheInfo
java.lang.String GetCacheInfo(java.lang.String sessionID, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Retrieves the information of caches.- Parameters:
sessionID
- an Intelligence Server session id.blockBegin
- the starting index of items in incremental fetchblockCount
- the block size of items in incremental fetchlevelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 9.0.0
-
GetCacheInfo
java.lang.String GetCacheInfo(int cacheType, java.lang.String sessionID, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML) throws MSTRWebAPIException
Retrieves the information of caches.- Parameters:
cacheType
- cache type. see seeEnumDSSXMLCacheType
sessionID
- an Intelligence Server session id.blockBegin
- the starting index of items in incremental fetchblockCount
- the block size of items in incremental fetchlevelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
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.- Since:
- MicroStrategy Web 9.0.0
-
GetCacheInfo
java.lang.String GetCacheInfo(int cacheType, java.lang.String sessionID, java.lang.String nodeName, int port, int blockBegin, int blockCount, int levelFlag, java.lang.String fieldFilterXML, java.lang.String countXML, java.lang.String sortingXML, boolean serverLevel, java.lang.String pollStateId) throws MSTRWebAPIException
Retrieves the information of caches from a specific Intelligence Server.- Parameters:
cacheType
- cache type. see seeEnumDSSXMLCacheType
sessionID
- expected a master session ID in Library workflow.nodeName
- the specific intelligence Server to retrieve the informationport
- the specific port on the Intelligence Server to connect toblockBegin
- the starting index of items in incremental fetchblockCount
- the block size of items in incremental fetchlevelFlag
- indicates at what level of information to retrieve. seeEnumDSSXMLLevelFlags
fieldFilterXML
- the filtering XML to retrieve cache information.countXML
- the counting XML to retrieve cache information.sortingXML
- the sorting XML to retrieve cache information.serverLevel
- the boolean to specify if the information is on server level. True is on server level, false is on project level.pollStateId
- the cube manipulation ID to poll the state of the asynchronous cube manipulation. * * It is only be used in asynchronous cube manipulation workflow. * * For workflow not to poll the cube manipulation state, pollStateId is GUID_NULL.- Returns:
- an XML string representing the cache information.
- Throws:
MSTRWebAPIException
- thrown if there is any error occurred.- Since:
- MicroStrategy Web 11.3.0
-
ManipulateCaches
java.lang.String ManipulateCaches(java.lang.String sessionID, java.lang.String manipulationXML) throws MSTRWebAPIException
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.- Since:
- MicroStrategy Web 9.0.0
-
ManipulateCaches
java.lang.String ManipulateCaches(int cacheType, java.lang.String sessionID, java.lang.String manipulationXML) throws MSTRWebAPIException
Manipulate caches, such as load, unload, invalidate, and delete cache.- Parameters:
cacheType
- cache type. see seeEnumDSSXMLCacheType
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.- Since:
- MicroStrategy Web 9.0.0
-
ManipulateCaches
java.lang.String ManipulateCaches(int cacheType, java.lang.String sessionID, java.lang.String nodeName, int port, java.lang.String manipulationXML, boolean asynchronous, StringWrapper pollStateId) throws MSTRWebAPIException
Manipulate caches, such as load, unload, invalidate, and delete cache on a specific Intelligence Server.- Parameters:
cacheType
- cache type. see seeEnumDSSXMLCacheType
nodeName
- manipulate the cache on the specific intelligence Server.port
- the specific port on the Intelligence Server to connect tosessionID
- expected a master session ID in Library workflow.manipulationXML
- the cache manipulation XML.asynchronous
- the boolean to specify if the manipulation asynchronous. Intelligence Server only supports cube cache asynchronous at the moment.pollStateId
- is an output. It is the unique GUID returned from Intelligence Server associated * * with the manipulation request. It is to be used for polling the state of the manipulation.- 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.- Since:
- MicroStrategy Web 11.3.0
-
PurgeCaches
void PurgeCaches(java.lang.String sessionID, java.lang.String projectDSSID, int purgeFlag) throws MSTRWebAPIException
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 fromEnumDSSXMLPurgeFlag
- Throws:
MSTRWebAPIException
- thrown if there is any error occurred.- Since:
- MicroStrategy Web 9.0.0
-
-