public interface

IDSSXMLClusterAdmin

com.microstrategy.webapi.IDSSXMLClusterAdmin

Class Overview

This interface provides the functionality for an application to manage a cluster of Intelligence Servers. It provides methods to get a cluster, join a server to a cluster, remove a server from a cluster, manage projects on individual servers, and manage projects on all servers in a cluster.

Summary

Public Methods
abstract String GetClusterMembership(String sessionID, int clusterMembershipFlags)
Contact IServer and return XML string in response to GetClusterMembership XML API call.
abstract void JoinCluster(String sessionID, String clusterMemberID)
Join the server specified by clusterMemberID to the cluster associated with sessionID
abstract void LeaveCluster(String sessionID, String clusterMemberID)
Remove a server specified by clusterMemberID from the cluster associated with sessionID
abstract void ManageClusterProject(String sessionID, String ProjDSSID, int status, int action)
Perform an action and/or modify the status of a project for all servers in cluster
abstract void ManageServerProject(String sessionID, int project, String clusterMemberID, int status, int action)
Perform an action and/or modify the status of a project on a single server
abstract void ManageServerProject(String sessionID, int project, String clusterMemberID, int status, int action, int maxWaitSeconds)
Perform an action and/or modify the status of a project on a single server

Public Methods

public abstract String GetClusterMembership (String sessionID, int clusterMembershipFlags)

Contact IServer and return XML string in response to GetClusterMembership XML API call. This XML contains all information to create and populate a WebClusterMembership object.

Parameters
sessionID A valid Session ID
clusterMembershipFlags Flags to control the information returned. Value must be from EnumDSSXMLGetClusterMembershipFlags.
Returns
  • XML representation of members in cluster
Throws
MSTRWebAPIException

public abstract void JoinCluster (String sessionID, String clusterMemberID)

Join the server specified by clusterMemberID to the cluster associated with sessionID

Parameters
sessionID A valid Session ID
clusterMemberID The server ID to add to the cluster
Throws
MSTRWebAPIException

public abstract void LeaveCluster (String sessionID, String clusterMemberID)

Remove a server specified by clusterMemberID from the cluster associated with sessionID

Parameters
sessionID A valid Session ID
clusterMemberID The server ID to remove from the cluster
Throws
MSTRWebAPIException

public abstract void ManageClusterProject (String sessionID, String ProjDSSID, int status, int action)

Perform an action and/or modify the status of a project for all servers in cluster

Parameters
sessionID A valid Session ID
ProjDSSID A valid Project ID
status Status of the project. Value must be from EnumDSSXMLProjectStatus.
action Action to be performed on the project. Value must be from EnumDSSXMLProjectActions.
Throws
MSTRWebAPIException
WebFailedServerException

public abstract void ManageServerProject (String sessionID, int project, String clusterMemberID, int status, int action)

Perform an action and/or modify the status of a project on a single server

Parameters
sessionID A valid Session ID
project A valid Project ID
status Status of the project. Value must be from EnumDSSXMLProjectStatus.
action Action to be performed on the project. Value must be from EnumDSSXMLProjectActions.
Throws
MSTRWebAPIException

public abstract void ManageServerProject (String sessionID, int project, String clusterMemberID, int status, int action, int maxWaitSeconds)

Perform an action and/or modify the status of a project on a single server

Parameters
sessionID A valid Session ID
project A valid Project ID
status Status of the project. Value must be from EnumDSSXMLProjectStatus.
action Action to be performed on the project. Value must be from EnumDSSXMLProjectActions.
maxWaitSeconds timeout in seconds that i-server should poll for status change until the call returns (only supported for 'load' action)
Throws
MSTRWebAPIException