public interface

IDSSXMLConfigServer

com.microstrategy.webapi.IDSSXMLConfigServer

Class Overview

This interface contains methods relating to configuration-related operations on the Intelligence Server.

Summary

Public Methods
abstract void AddDBRoleToProject(String sessionID, String[] dbrIDs, String projectID, boolean isPrimary)
Add one or more DBRoles to a project
abstract void CheckKey(String sessionID)
abstract String CheckLicenseCompliance(String sessionID, int licenseComplianceCategory, int flags, IntWrapper iwStatus)
Checks the overall license compliance status of the Intelligence Server.
abstract String CreateServerDef(String sessionID, String name)
Creates a new ServerDef object on the Intelligence Server.
abstract String ExecMDUpdateCmd(String sessionID, String commandXML, String logPath)
This component is used to update existing MicroStrategy 7.x metadata so they can work optimally with the newest release of the product.
abstract String GetAllFences(String sessionID, String serverDefID, String fenceDeltaXML)
abstract String GetCPULicenseCompliance(String sessionID, int flags)
Returns the CPU license usage and compliance for the current I-Server.
abstract String GetComplianceLevel(String sessionID, int flags, int licenseComplianceCategory)
Returns the overall license compliance status of the Intelligence Server.
abstract String GetFenceServerLists(String sessionID, String projectID)
abstract String GetFullUserPrivileges(String sessionID, String userID, String deltaXML)
Submits a full user privileges delta XML.
abstract String GetNamedUserLicenseCompliance(String sessionID, int flags)
Returns the named user license usage and compliance for the current I-Server.
abstract String GetRepositoryProjects(String sessionID)
Gets a list of projects available in the repository on this Intelligence Server.
abstract String GetUserLicenses(String sessionID, int auditScheme, String groupID, int auditHandle, int blockBegin, int blockCount, String extParam, IntWrapper newHandle)
Performs a batch audit on the given user group and returns a batch audit handle and an XML string containing the user license information.
abstract String GetUserLicenses(String sessionID, int auditScheme, String groupID, int auditHandle, int blockBegin, int blockCount, int auditorType, String extParam, IntWrapper newHandle)
Performs a batch audit on the given user group and returns a batch audit handle and an XML string containing the user license information.
abstract String GetUsersByLicenseType(String sessionID, int auditScheme, String groupID)
Performs an audit on the given user groups.
abstract String GetUsersPrivileges(String sessionID, int auditScheme, int flags)
Returns a list of privileges and the license types that they belong to.
abstract String ModifyServerDef(String sessionID, String serverDefID, String deltaXML)
Modifies the given server def object with the given delta XML.
abstract void PerformComplianceCheck(String sessionID, int flags)
Causes the Intelligence Server to refresh the licensing status internally.
abstract void RefreshDiagnosticsLoggingSettings(String sessionID)
Causes the Intelligence Server to re-read its diagnostics logging settings from the registry.
abstract void RefreshPerformanceLoggingSettings(String sessionID)
Causes the Intelligence Server to re-read its performance monitor logging settings from the registry.
abstract void Rekey(String sessionID, String masterKeyPath, String keyStorePath, String logPath)
abstract void Rekey(String sessionID, String masterKeyPath, String keyStorePath, String logPath, boolean needUpdateMD, boolean needUpdateCube, boolean needUpdateCache, boolean needUpdateHL, boolean needUpdateWS)
abstract void RemoveDBRoleFromProject(String sessionID, String[] dbrIDs, String projectID)
Remove one or more DBRoles from a project
abstract void SetProjectStatus(String sessionID, String statusXML)
Sets a project's status to one of the values in EnumDSSXMLProjectStatus.
abstract String SubmitUserDelta(String sessionID, String deltaXML)
Submits a user account services delta XML.
abstract String UpdateMD(String sessionID, int command, String logPath, boolean allProjs, String targetVersion)
This method is deprecated. use ExecMDUpdateCmd(String, String, String) instead

Public Methods

public abstract void AddDBRoleToProject (String sessionID, String[] dbrIDs, String projectID, boolean isPrimary)

Add one or more DBRoles to a project

Parameters
sessionID String containing the current session ID
dbrIDs array of String; each containing the ID of a DBRole to be added to the project
projectID String containing the ID of the project the DBRoles will be added to
isPrimary boolean true if the to-be-added DB role is primary DB role

public abstract void CheckKey (String sessionID)

public abstract String CheckLicenseCompliance (String sessionID, int licenseComplianceCategory, int flags, IntWrapper iwStatus)

Checks the overall license compliance status of the Intelligence Server. If there is a problem, then the status will reflect that, and a string will be returned with a description of the problem.

Parameters
sessionID A valid session ID.
licenseComplianceCategory The category of license compliance to check, from EnumDSSXMLLicenseComplianceCategory.
flags Reserved for future use.
iwStatus An IntWrapper, which will be populated with the licensing status.
Returns
  • A string describing the compliance problem, if applicable.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String CreateServerDef (String sessionID, String name)

Creates a new ServerDef object on the Intelligence Server.

Parameters
sessionID A valid session ID.
name The name of the newly created ServerDef.
Returns
  • The DSSID of the newly created object.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String ExecMDUpdateCmd (String sessionID, String commandXML, String logPath)

This component is used to update existing MicroStrategy 7.x metadata so they can work optimally with the newest release of the product. This method is designed to be a more flexible version of UpdateMD(String, int, String, boolean, String)

Parameters
sessionID a valid Intelligence Server session ID.
commandXML String containing node XML for
logPath String containing name and path to record actions taken during the update

public abstract String GetAllFences (String sessionID, String serverDefID, String fenceDeltaXML)

public abstract String GetCPULicenseCompliance (String sessionID, int flags)

Returns the CPU license usage and compliance for the current I-Server.

Parameters
sessionID A valid session ID.
flags Reserved for future use.
Returns
  • An xml string containing information about the CPU compliance.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetComplianceLevel (String sessionID, int flags, int licenseComplianceCategory)

Returns the overall license compliance status of the Intelligence Server. If there is a problem, a string will be returned with detail information.

Parameters
sessionID A valid session ID.
flags Reserved for future use.
licenseComplianceCategory The category of license compliance to check, from EnumDSSXMLLicenseComplianceCategory.
Returns
  • A string compliance problem detail, if applicable.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetFenceServerLists (String sessionID, String projectID)

public abstract String GetFullUserPrivileges (String sessionID, String userID, String deltaXML)

Submits a full user privileges delta XML. This XML will direct the server to fetch a full privilege list, including the source of each privilege, for the user.

Parameters
sessionID A valid session ID.
userID The user to retrieve the full privileges for.
deltaXML An XML string describing the information requested.
Returns
  • An XML String describing the asked-for information.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetNamedUserLicenseCompliance (String sessionID, int flags)

Returns the named user license usage and compliance for the current I-Server.

Parameters
sessionID A valid session ID.
flags Reserved for future use.
Returns
  • An xml string containing information about the named user compliance.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetRepositoryProjects (String sessionID)

Gets a list of projects available in the repository on this Intelligence Server. This is a list of projects in the metadata regardless of whether the projects are registered or not.

Parameters
sessionID A valid session ID.
Returns
  • An XML string describing the list of projects available in the metadata.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetUserLicenses (String sessionID, int auditScheme, String groupID, int auditHandle, int blockBegin, int blockCount, String extParam, IntWrapper newHandle)

Performs a batch audit on the given user group and returns a batch audit handle and an XML string containing the user license information. This method supports incremental auditing by specifying the starting point and the block count.

The first time to perform a batch audit, the audit handle should be 0 and a new handle will be returned after the call. Later on, the user can use the returned handle to perform any batch audit at his will.

Parameters
sessionID a valid Intelligence Server session ID.
auditScheme the audit scheme constant from EnumDSSXMLLicenseScheme.
groupID the DSSID of a user group to be audited.
auditHandle the audit handle to perform batch auditing.
blockBegin the start point of incremental auditing.
blockCount the block count of an incremental auditing.
extParam the extendable parameters reserved for future use.
newHandle the new audit handle created in the first batch auditing call.
Returns
  • an XML string containing the user license information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetUserLicenses (String sessionID, int auditScheme, String groupID, int auditHandle, int blockBegin, int blockCount, int auditorType, String extParam, IntWrapper newHandle)

Performs a batch audit on the given user group and returns a batch audit handle and an XML string containing the user license information. This method supports incremental auditing by specifying the starting point and the block count.

The first time to perform a batch audit, the audit handle should be 0 and a new handle will be returned after the call. Later on, the user can use the returned handle to perform any batch audit at his will.

Parameters
sessionID a valid Intelligence Server session ID.
auditScheme the audit scheme constant from EnumDSSXMLLicenseScheme.
groupID the DSSID of a user group to be audited.
auditHandle the audit handle to perform batch auditing.
blockBegin the start point of incremental auditing.
blockCount the block count of an incremental auditing.
auditorType the auditor type from EnumDSSXMLAuditorTypes}
extParam the extendable parameters reserved for future use.
newHandle the new audit handle created in the first batch auditing call.
Returns
  • an XML string containing the user license information.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String GetUsersByLicenseType (String sessionID, int auditScheme, String groupID)

Performs an audit on the given user groups. Returns an XML containing the information about which users belong to which license types.

Parameters
sessionID A valid session ID.
auditScheme The audit scheme, from EnumDSSXMLLicenseType.
groupID The DSSID of the group to audit.
Returns
  • An XML string describing the result of the operation.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetUsersPrivileges (String sessionID, int auditScheme, int flags)

Returns a list of privileges and the license types that they belong to.

Parameters
sessionID A valid session ID.
auditScheme The audit scheme, from EnumDSSXMLLicenseType.
flags Reserved for future use.
Returns
  • An XML stinr describing the result of the operation.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String ModifyServerDef (String sessionID, String serverDefID, String deltaXML)

Modifies the given server def object with the given delta XML.

Parameters
sessionID A valid session ID.
serverDefID The DSSID of the ServerDef object to modify.
deltaXML An XML string describing the changes to make to the ServerDef.
Returns
  • The return value is not important.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract void PerformComplianceCheck (String sessionID, int flags)

Causes the Intelligence Server to refresh the licensing status internally.

Parameters
sessionID A valid session ID.
flags Reserved for future use
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract void RefreshDiagnosticsLoggingSettings (String sessionID)

Causes the Intelligence Server to re-read its diagnostics logging settings from the registry. This should be called after using the Server Control API to modify logging settings to get the settings to apply without restarting the I-Server.

Parameters
sessionID A valid session ID.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract void RefreshPerformanceLoggingSettings (String sessionID)

Causes the Intelligence Server to re-read its performance monitor logging settings from the registry. This should be called after using the Server Control API to modify logging settings to get the settings to apply without restarting the I-Server.

Parameters
sessionID A valid session ID.
Throws
MSTRWebAPIException Thrown if an error occurs in the operation.

public abstract void Rekey (String sessionID, String masterKeyPath, String keyStorePath, String logPath)

public abstract void Rekey (String sessionID, String masterKeyPath, String keyStorePath, String logPath, boolean needUpdateMD, boolean needUpdateCube, boolean needUpdateCache, boolean needUpdateHL, boolean needUpdateWS)

public abstract void RemoveDBRoleFromProject (String sessionID, String[] dbrIDs, String projectID)

Remove one or more DBRoles from a project

Parameters
sessionID String containing the current session ID
dbrIDs array of String; each containing the ID of a DBRole to be removed from the project
projectID String containing the ID of the project the DBRoles will be removed from

public abstract void SetProjectStatus (String sessionID, String statusXML)

Sets a project's status to one of the values in EnumDSSXMLProjectStatus.

Parameters
sessionID a valid session ID.
statusXML the XML to set a project status.
Throws
MSTRWebAPIException thrown if there is any error occurred.

public abstract String SubmitUserDelta (String sessionID, String deltaXML)

Submits a user account services delta XML. This XML can direct the server to create, delete, and modify user objects in metadata.

Parameters
sessionID A valid session ID.
deltaXML A delta XML describing the operations to perform.
Returns
  • An XML string describing whether the operation failed.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String UpdateMD (String sessionID, int command, String logPath, boolean allProjs, String targetVersion)

This method is deprecated.
use ExecMDUpdateCmd(String, String, String) instead

This component is used to update existing MicroStrategy 7.x metadata so they can work optimally with the newest release of the product.

Parameters
sessionID a valid Intelligence Server session ID.
command int from EnumDSSXMLMDUpdateCommands
logPath String containing name and path to record actions taken during the update
allProjs boolean value used to determine whether all projects will be updated
targetVersion String containing the version the MD will updated to