public interface

WebClusterMembership

com.microstrategy.web.objects.WebClusterMembership

Class Overview

The WebClusterMembership is a collection interface of WebClusterMember objects. Apart from the typical methods of a collection, it also has some methods that can be used to remove members from the cluster or add a new member to the cluster. WebClusterMembership objects can be obtained through the WebClusterSource object

Summary

Public Methods
abstract WebClusterMember get(int index)
Returns the WebClusterMember at a given index within the collection
abstract WebClusterMember get(String name)
Returns the WebClusterMember with a given name within the collection
abstract WebProjectManipulator getManipulator()
Get WebProjectManipulator object to perform manipulations on projects in cluster.
abstract boolean isMember(String memberName)
Return whether the given member name is indeed a member of the membership
abstract void joinMember(String nodeName)
Adds a new member to the cluster by issuing a JoinCluster XML API call through IDSSXMLClusterAdmin
abstract void leaveMember(int index)
Removes a WebClusterMember specified by an index from the internal collection and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin.
abstract void leaveMember(WebClusterMember member)
Removes a particular WebClusterMember from the internal collection of members and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin to do the same on the IServer
abstract void leaveMember(String name)
Removes a WebClusterMember specified by a server name and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin.
abstract int size()
Returns the total number of WebClusterMember objects in the collection

Public Methods

public abstract WebClusterMember get (int index)

Returns the WebClusterMember at a given index within the collection

Parameters
index integer value representing location in collection
Returns
Throws
WebObjectsException

public abstract WebClusterMember get (String name)

Returns the WebClusterMember with a given name within the collection

Parameters
name String value representing name of member
Returns
Throws
WebObjectsException

public abstract WebProjectManipulator getManipulator ()

Get WebProjectManipulator object to perform manipulations on projects in cluster. Any manipulations performed with a manipulator obtained from this method will affect the project for all servers within the cluster.

Returns
Throws
WebObjectsException

public abstract boolean isMember (String memberName)

Return whether the given member name is indeed a member of the membership

Parameters
memberName String containing the name of the member to be checked
Returns
  • boolean whether the member with the name provided is a part of the membership
Throws
WebObjectsException

public abstract void joinMember (String nodeName)

Adds a new member to the cluster by issuing a JoinCluster XML API call through IDSSXMLClusterAdmin

Parameters
nodeName String containing the name of the server to be added to the cluster
Throws
WebObjectsException

public abstract void leaveMember (int index)

Removes a WebClusterMember specified by an index from the internal collection and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin.

Parameters
index integer value representing location in collection
Throws
WebObjectsException

public abstract void leaveMember (WebClusterMember member)

Removes a particular WebClusterMember from the internal collection of members and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin to do the same on the IServer

Parameters
member WebClusterMember object representation of IServer to remove from membership
Throws
WebObjectsException

public abstract void leaveMember (String name)

Removes a WebClusterMember specified by a server name and issues a LeaveCluster XML API call through IDSSXMLClusterAdmin.

Parameters
name String value representing name of server
Throws
WebObjectsException

public abstract int size ()

Returns the total number of WebClusterMember objects in the collection

Returns
  • integer representing the number of objects in collecction
Throws
WebObjectsException