Package com.microstrategy.web.objects

Interface WebClusterMember

public interface WebClusterMember

The WebClusterMember interface provides a standard representation for nodes within a cluster. A reference to an instance of this interface can be acquired from WebClusterMembership

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
int	getLoad()	Returns the load of the cluster member
WebProjectManipulator	getManipulator()	Get WebProjectManipulator object used to perform manipulations on projects in cluster.
java.lang.String	getName()	Returns the name of the cluster member.
int	getPort()	Returns the port of the cluster member
WebClusterProjectInfoCollection	getProjectInfoCollection()	Returns a collection of WebClusterProjectInfo objects.
int	getProtocol()	Returns the network protocol of the server
int	getStatus()	Returns the status of the cluster member

Method Detail

getStatus

int getStatus()

Returns the status of the cluster member

Returns:

integer enumeration from EnumDSSXMLClusterMemberStatus describing status of cluster member

getName

java.lang.String getName()

Returns the name of the cluster member. This will be the server's name

Returns:

String containing the name of the cluster member

getPort

int getPort()

Returns the port of the cluster member

Returns:

integer port number

getProtocol

int getProtocol()

Returns the network protocol of the server

Returns:

integer enumeration from EnumDSSXMLNetProtocol describing the network protocol of cluster member

getLoad

int getLoad()

Returns the load of the cluster member

Returns:

integer load on cluster member

getProjectInfoCollection

WebClusterProjectInfoCollection getProjectInfoCollection()

Returns a collection of WebClusterProjectInfo objects. Each object contains information about the projects on this server and a link to a WebProjectInstance

Returns:

WebClusterProjectInfoCollection representing a set of WebClusterProjectInfo objects

getManipulator

WebProjectManipulator getManipulator()
                              throws WebObjectsException

Get WebProjectManipulator object used to perform manipulations on projects in cluster. Any manipulations performed with a manipulator obtained from this method will affect the project only for this Cluster Member. Other members within the cluster will maintain previous project states.

Returns:

WebProjectManipulator to manipulate a project across cluster

Throws:

WebObjectsException