Date Created: Sun 03-Feb-2008

Related Document Categories:

Get my WebSphere Application Server course here >> http://www.themiddlewareshop.com/products/


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.


--------------------------------------------------------------------------------
Attributes Summary

clusterName: (java.lang.String) The name of this cluster.
preferLocal : (java.lang.Boolean) 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 (java.lang.String) The currently registered workload controller (WLC) id for this cluster. If no WLC has registered yet this value will be null.
state (java.lang.String) The current state of the cluster.


Operations Summary

getClusterMembers Retrieve the array of members contained by the cluster.
getClusterMember Retrieve the cluster member data for the specified member.
getWeightTable Retrieve the current in memory weight table.
getWeightTableEntry Retrieve the in memory weight table entry for the specified cluster member.
setWeightTable 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.
setWeightTableEntry 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.
register 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.
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 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.


Notifications Summary

Cluster Weight Table Change websphere.cluster.weight.table.change
Cluster Weight Table Entry Change websphere.cluster.weight.table.entry.change
websphere.cluster.starting websphere.cluster.starting
websphere.cluster.partial.start websphere.cluster.partial.start
websphere.cluster.running websphere.cluster.running
websphere.cluster.stopping websphere.cluster.stopping
websphere.cluster.partial.stop websphere.cluster.partial.stop
websphere.cluster.stopped websphere.cluster.stopped



Attribute Details

clusterName - The name of this cluster.
data type: java.lang.String


--------------------------------------------------------------------------------

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.
data type: java.lang.Boolean


--------------------------------------------------------------------------------

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


--------------------------------------------------------------------------------

state - The current state of the cluster.
data type: java.lang.String


--------------------------------------------------------------------------------



Operation Details

getClusterMembers - Retrieve the array of members contained by the cluster.
return type: [Lcom.ibm.websphere.management.wlm.ClusterMemberData;
parameters:


--------------------------------------------------------------------------------

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


--------------------------------------------------------------------------------

getWeightTable - Retrieve the current in memory weight table.
return type: [Lcom.ibm.websphere.management.wlm.ClusterWeightTableEntry;
parameters:


--------------------------------------------------------------------------------

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


--------------------------------------------------------------------------------

setWeightTable - 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.
return type:
parameters:
key (java.lang.Long) The key obtained from the register() method.
weightTable ([Lcom.ibm.websphere.management.wlm.ClusterWeightTableEntry;) Desired weight table for this cluster.


--------------------------------------------------------------------------------

setWeightTableEntry - 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.
return type:
parameters:
key (java.lang.Long) The key obtained from the register() method.
weightTableEntry (com.ibm.websphere.management.wlm.ClusterWeightTableEntry) Desired weight table entry for particular member of the cluster.


--------------------------------------------------------------------------------

register - 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.
return type: java.lang.Long
parameters:
wlcName (java.lang.String) The Workload Controller ID or name.


--------------------------------------------------------------------------------

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.
return type: com.ibm.websphere.management.wlm.ClusterData
parameters:


--------------------------------------------------------------------------------

start - Start the cluster of servers.
return type:
parameters:


--------------------------------------------------------------------------------

stop - Stop the cluster of servers.
return type:
parameters:


--------------------------------------------------------------------------------

stopImmediate - Stop the cluster of servers.
return type:
parameters:


--------------------------------------------------------------------------------

rippleStart - Stop and re-start the servers in the cluster.
return type:
parameters:


--------------------------------------------------------------------------------



Notification Details

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
notification type: websphere.cluster.weight.table.change



--------------------------------------------------------------------------------

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
notification type: websphere.cluster.weight.table.entry.change



--------------------------------------------------------------------------------

websphere.cluster.starting - This cluster is being started. The object name of the cluster being started is passed in the user data.
severity: 6
notification type: websphere.cluster.starting



--------------------------------------------------------------------------------

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
notification type: websphere.cluster.partial.start



--------------------------------------------------------------------------------

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
notification type: websphere.cluster.running



--------------------------------------------------------------------------------

websphere.cluster.stopping - This cluster is being stopped. The object name of the cluster being stopped is passed in the user data.
severity: 6
notification type: websphere.cluster.stopping



--------------------------------------------------------------------------------

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
notification type: websphere.cluster.partial.stop



--------------------------------------------------------------------------------

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
notification type: websphere.cluster.stopped


--------------------------------------------------------------------------------

References:

http://publib.boulder.ibm.com/infocenter/wsphelp/index.jsp?topic=/com.ibm.websphere.nd.doc/info/ae/javadoc/mbean/Cluster.html

--------------------------------------------------------------------------------

Copyright IBM Corp. 1996-2002

Get my WebSphere Application Server course here >> http://www.themiddlewareshop.com/products/


Steve Robinson - IBM Champion 2013

About Me

Steve Robinson has been working in IT for over 20 years and has provided solutions for many large-enterprise corporate companies across the world. Steve specialises in Java and Middleware.

In January 2013, I was awarded the prestigous 'IBM Champion' accolade.


  • Linked In
  • Twitter
  • About Me
  • My Blog
  • Contact Me

Read my books?

IBM WebSphere Application Server 8.0 Administration Guide

IBM WebSphere Application Server 8.0 Administration Guide

WebSphere Application Server 7.0 Administration Guide

WebSphere Application Server 7.0 Administration Guide

WebSphere Categories

Other Categories