public interface

IDSSXMLCluster

com.microstrategy.webapi.IDSSXMLCluster

Class Overview

A cluster is defined as a group of IDSSXMLClusterNode objects. This interface contains methods to iterate through a cluster of servers. The servers in a cluster should be identical with respect to their configurations. In addition, any CreateSession request to a server in a cluster may be redirected to any other server in the cluster if its load is smaller.

Summary

Public Methods
abstract int getCount()
Returns the number of IDSSXMLClusterNodes in this cluster.
abstract IDSSXMLClusterNode getItem(int index)
Returns the node at the specified index.
abstract Enumeration get_Enum()
Returns an enumeration of IDSSXMLClusterNode interfaces that are in the cluster.

Public Methods

public abstract int getCount ()

Returns the number of IDSSXMLClusterNodes in this cluster.

Returns
  • Number of nodes in the cluster.

public abstract IDSSXMLClusterNode getItem (int index)

Returns the node at the specified index.

Parameters
index The index of the node, where the first element has index=1.
Returns
  • An IDSSXMLClusterNode if the specified index exists in the cluster, or null if the index is larger than the size of the array.
Throws
MSTRWebAPIException Thrown when error occurs during retrieving the node information.

public abstract Enumeration get_Enum ()

Returns an enumeration of IDSSXMLClusterNode interfaces that are in the cluster.

Returns
  • An Enumeration containing all of the IDSSXMLClusterNodes in the cluster.