Package com.microstrategy.webapi

Interface IDSSXMLClusterAdmin

public interface IDSSXMLClusterAdmin

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.

Since:

MicroStrategy Web 9.0.0

Method Summary

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

Method Detail

GetClusterMembership

java.lang.String GetClusterMembership(java.lang.String sessionID,
                                      int clusterMembershipFlags)
                               throws MSTRWebAPIException

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

JoinCluster

void JoinCluster(java.lang.String sessionID,
                 java.lang.String clusterMemberID)
          throws MSTRWebAPIException

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

LeaveCluster

void LeaveCluster(java.lang.String sessionID,
                  java.lang.String clusterMemberID)
           throws MSTRWebAPIException

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

ManageServerProject

void ManageServerProject(java.lang.String sessionID,
                         int project,
                         java.lang.String clusterMemberID,
                         int status,
                         int action)
                  throws MSTRWebAPIException

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

ManageServerProject

void ManageServerProject(java.lang.String sessionID,
                         int project,
                         java.lang.String clusterMemberID,
                         int status,
                         int action,
                         int maxWaitSeconds)
                  throws MSTRWebAPIException

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

clusterMemberID -

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

ManageClusterProject

void ManageClusterProject(java.lang.String sessionID,
                          java.lang.String ProjDSSID,
                          int status,
                          int action)
                   throws MSTRWebAPIException,
                          WebFailedServerException

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