Package com.microstrategy.web.objects

Interface WebCluster

  • All Superinterfaces:
    CacheHint
    public interface WebCluster
extends CacheHint
    This is a collection of WebClusterNode interfaces.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • elements

        java.util.Enumeration elements()
        Returns an enumeration of WebClusterNode interfaces that are in the cluster.
        Returns:
        An Enumeration containing all of the WebClusterNode in the cluster.

      • size

        int size()
        Returns the number of WebClusterNode in this cluster.
        Returns:
        Number of nodes in the cluster.

      • get

        WebClusterNode get​(int index)
            throws WebObjectsException
        Returns the node at the specified index.
        Parameters:
        index - The index of the node, where the first element has index=1.
        Returns:
        An WebClusterNode if the specified index exists in the cluster, or null if the index is larger than the size of the array.
        Throws:
        WebObjectsException

      • getWebClusterNodes

        java.util.Collection<WebClusterNode> getWebClusterNodes​(boolean includeInactive)
        Returns a Collection of WebClusterNode in this cluster.
        Parameters:
        includeInactive - when true will return alive and dead nodes, when false will return only alive nodes
        Returns:
        Collection of WebClusterNode in this cluster.

      • getProjects

        WebProjectInstances getProjects()
                         throws WebObjectsException
        Returns the list of all projects loaded on at least one server in the cluster.
        Returns:
        WebProjectInstances object which is a collection of all loaded projects in the cluster
        Throws:
        WebObjectsException - Thrown if there is an error retrieving the list.
        Since:
        MicroStrategy Web 8.0.0