Cluster MBean

The Cluster MBean provides a management interface for a cluster in a cell. It supports typical operations like starting and stopping of the cluster along with the abilty to dynamically modify attributes such as the table of server weights in the cluster.


Attribute Summary
java.lang.StringclusterName
           The name of this cluster.
java.lang.BooleanpreferLocal
           Enable or disable Node scoped routing optimization.
java.lang.StringwlcID
           The currently registered workload controller (WLC) id for this cluster.
java.lang.Stringstate
           The current state of the cluster.

Operation Summary
com.ibm.websphere.management.wlm.ClusterMemberData[]getClusterMembers()
           Retrieve the array of members contained by the cluster.
com.ibm.websphere.management.wlm.ClusterMemberDatagetClusterMember(java.lang.String memberName, java.lang.String nodeName)
           Retrieve the cluster member data for the specified member.
com.ibm.websphere.management.wlm.ClusterWeightTableEntry[]getWeightTable()
           Retrieve the current in memory weight table.
com.ibm.websphere.management.wlm.ClusterWeightTableEntrygetWeightTableEntry(java.lang.String memberName, java.lang.String nodeName)
           Retrieve the in memory weight table entry for the specified cluster member.
setWeightTable(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] weightTable)
           Replace the weight table in memory with the one provided.
setWeightTableEntry(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry weightTableEntry)
           Replace the weight table entry in memory with the one provided.
java.lang.Longregister(java.lang.String wlcName)
           Register as the workload controller for this cluster.
com.ibm.websphere.management.wlm.ClusterDatarefresh()
           Refresh cluster and member information.
start()
           Start the cluster of servers.
stop()
           Stop the cluster of servers.
stopImmediate()
           Stop the cluster of servers.
rippleStart()
           Stop and re-start the servers in the cluster.

Notification Summary
Cluster Weight Table Change
           Notify listeners that the Cluster weight table was changed.
Cluster Weight Table Entry Change
           Notify listeners that a Cluster weight table entry was changed.
websphere.cluster.starting
           This cluster is being started.
websphere.cluster.partial.start
           All members of the cluster have been requested to start, but all servers are not yet running.
websphere.cluster.running
           All members in the cluster are now running.
websphere.cluster.stopping
           This cluster is being stopped.
websphere.cluster.partial.stop
           All servers in this cluster have been requested to stop.
websphere.cluster.stopped
           All servers in the cluster are now stopped.

Attribute Detail

clusterName

public java.lang.String clusterName
The name of this cluster.

preferLocal

public java.lang.Boolean preferLocal
Enable or disable Node scoped routing optimization. If true, WLM will always route an EJB request to the node on which the client resides if it is possible to do so.

wlcID

public java.lang.String wlcID
The currently registered workload controller (WLC) id for this cluster. If no WLC has registered yet this value will be null.

state

public java.lang.String state
The current state of the cluster.

Operation Detail

getClusterMembers

public com.ibm.websphere.management.wlm.ClusterMemberData[] getClusterMembers()
Retrieve the array of members contained by the cluster.

getClusterMember

public com.ibm.websphere.management.wlm.ClusterMemberData getClusterMember(java.lang.String memberName, java.lang.String nodeName)
Retrieve the cluster member data for the specified member.
Parameters:
memberName - Cluster member name.
nodeName - The name of the node where the cluster member is configured.

getWeightTable

public com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] getWeightTable()
Retrieve the current in memory weight table.

getWeightTableEntry

public com.ibm.websphere.management.wlm.ClusterWeightTableEntry getWeightTableEntry(java.lang.String memberName, java.lang.String nodeName)
Retrieve the in memory weight table entry for the specified cluster member.
Parameters:
memberName - Cluster member name.
nodeName - The name of the node where the cluster member is configured.

setWeightTable

public  setWeightTable(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry[] weightTable)
Replace the weight table in memory with the one provided. If no key is provided, or another WLC has registered to control this cluster than an exception will be thrown.
Parameters:
key - The key obtained from the register() method.
weightTable - Desired weight table for this cluster.

setWeightTableEntry

public  setWeightTableEntry(java.lang.Long key, com.ibm.websphere.management.wlm.ClusterWeightTableEntry weightTableEntry)
Replace the weight table entry in memory with the one provided. If no key is provided, or another WLC has registered to control this cluster than an exception will be thrown.
Parameters:
key - The key obtained from the register() method.
weightTableEntry - Desired weight table entry for particular member of the cluster.

register

public java.lang.Long register(java.lang.String wlcName)
Register as the workload controller for this cluster. The caller should provide an ID string and will be returned a key that can be used to modify server weight values for this cluster.
Parameters:
wlcName - The Workload Controller ID or name.

refresh

public com.ibm.websphere.management.wlm.ClusterData refresh()
Refresh cluster and member information. If a change was made to the static configuration data, this method can be called to refresh (or resync) the in-memory data held by this cluster with the static configuration data.

start

public  start()
Start the cluster of servers.

stop

public  stop()
Stop the cluster of servers.

stopImmediate

public  stopImmediate()
Stop the cluster of servers.

rippleStart

public  rippleStart()
Stop and re-start the servers in the cluster.

Notification Detail

Cluster Weight Table Change

Notify listeners that the Cluster weight table was changed. The notification includes a copy of the updated Cluster weight table.
Severity:
5  (Warning)

Cluster Weight Table Entry Change

Notify listeners that a Cluster weight table entry was changed. The notification includes a copy of the updated Cluster weight table entry.
Severity:
5  (Warning)

websphere.cluster.starting

This cluster is being started. The object name of the cluster being started is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

websphere.cluster.partial.start

All members of the cluster have been requested to start, but all servers are not yet running. The object name of the cluster being started is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

websphere.cluster.running

All members in the cluster are now running. The object name of the cluster is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

websphere.cluster.stopping

This cluster is being stopped. The object name of the cluster being stopped is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

websphere.cluster.partial.stop

All servers in this cluster have been requested to stop. The object name of the cluster being stopped is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

websphere.cluster.stopped

All servers in the cluster are now stopped. The object name of the cluster is passed in the user data.
Severity:
6  (Normal, Cleared, or Informative)

Copyright IBM Corp. 1996-2003