Package com.microstrategy.web.objects
Interface WebClusterMembership
-
public interface WebClusterMembership
TheWebClusterMembership
is a collection interface ofWebClusterMember
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 theWebClusterSource
object- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebClusterMember
get(int index)
Returns theWebClusterMember
at a given index within the collectionWebClusterMember
get(java.lang.String name)
Returns theWebClusterMember
with a given name within the collectionWebProjectManipulator
getManipulator()
GetWebProjectManipulator
object to perform manipulations on projects in cluster.boolean
isMember(java.lang.String memberName)
Return whether the given member name is indeed a member of the membershipvoid
joinMember(java.lang.String nodeName)
Adds a new member to the cluster by issuing a JoinCluster XML API call throughIDSSXMLClusterAdmin
void
leaveMember(int index)
Removes aWebClusterMember
specified by an index from the internal collection and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
.void
leaveMember(WebClusterMember member)
Removes a particularWebClusterMember
from the internal collection of members and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
to do the same on the IServervoid
leaveMember(java.lang.String name)
Removes aWebClusterMember
specified by a server name and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
.int
size()
Returns the total number ofWebClusterMember
objects in the collection
-
-
-
Method Detail
-
size
int size() throws WebObjectsException
Returns the total number ofWebClusterMember
objects in the collection- Returns:
- integer representing the number of objects in collecction
- Throws:
WebObjectsException
-
get
WebClusterMember get(int index) throws WebObjectsException
Returns theWebClusterMember
at a given index within the collection- Parameters:
index
- integer value representing location in collection- Returns:
WebClusterMember
that index points to- Throws:
WebObjectsException
-
get
WebClusterMember get(java.lang.String name) throws WebObjectsException
Returns theWebClusterMember
with a given name within the collection- Parameters:
name
-String
value representing name of member- Returns:
WebClusterMember
that index points to- Throws:
WebObjectsException
-
leaveMember
void leaveMember(WebClusterMember member) throws WebObjectsException
Removes a particularWebClusterMember
from the internal collection of members and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
to do the same on the IServer- Parameters:
member
-WebClusterMember
object representation of IServer to remove from membership- Throws:
WebObjectsException
-
leaveMember
void leaveMember(int index) throws WebObjectsException
Removes aWebClusterMember
specified by an index from the internal collection and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
.- Parameters:
index
- integer value representing location in collection- Throws:
WebObjectsException
-
leaveMember
void leaveMember(java.lang.String name) throws WebObjectsException
Removes aWebClusterMember
specified by a server name and issues a LeaveCluster XML API call throughIDSSXMLClusterAdmin
.- Parameters:
name
-String
value representing name of server- Throws:
WebObjectsException
-
joinMember
void joinMember(java.lang.String nodeName) throws WebObjectsException
Adds a new member to the cluster by issuing a JoinCluster XML API call throughIDSSXMLClusterAdmin
- Parameters:
nodeName
-String
containing the name of the server to be added to the cluster- Throws:
WebObjectsException
-
getManipulator
WebProjectManipulator getManipulator() throws WebObjectsException
GetWebProjectManipulator
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:
WebProjectManipulator
to manipulate a project across cluster- Throws:
WebObjectsException
-
isMember
boolean isMember(java.lang.String memberName) throws WebObjectsException
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
-
-