WebSphere:*,type=Cluster
The resource being modified for the MBean is of type Cluster
The instance is identified by the value of key name in the MBean's Object Name
>
MBean Cluster
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.String | clusterName The name of this cluster. |
java.lang.Boolean | preferLocal Enable or disable Host scoped routing optimization. |
java.lang.String | wlcID The currently registered workload controller (WLC) id for this cluster. |
java.lang.String | state The current state of the cluster. |
java.lang.String | backupName The name of the cluster to use as a backup to the cluster represented by this MBean. |
java.lang.String | backupBootstrapHost The BOOTSTRAP host name of the deployment manager for the backup cluster. |
java.lang.Integer | backupBootstrapPort The BOOTSTRAP port of the deployment manager for the backup cluster. |
Operation Summary | |
---|---|
ClusterMemberData[] | getClusterMembers() Retrieve the array of members contained by the cluster. |
ClusterMemberData | getClusterMember( Retrieve the cluster member data for the specified member. |
ClusterWeightTableEntry[] | getWeightTable() Retrieve the current in memory weight table. |
ClusterWeightTableEntry | getWeightTableEntry( Retrieve the in memory weight table entry for the specified cluster member. |
void | setWeightTable( Replace the weight table in memory with the one provided. |
void | setWeightTableEntry( Replace the weight table entry in memory with the one provided. |
java.lang.Long | register( Register as the workload controller for this cluster. |
ClusterData | refresh() Refresh cluster and member information. |
void | start() Start the cluster of servers. |
void | stop() Stop the cluster of servers. |
void | stopImmediate() Stop the cluster of servers. |
void | rippleStart() Stop and re-start the servers in the cluster. |
java.lang.String | exportRouteTable() Exports the routing information to the cluster configuration directory for use by the cluster members at bootstrap when the dmgr is not available. |
java.lang.boolean | removeRouteTable() Removes the static route table that is created by the exportRouteTable method. |
java.lang.String | dumpClusterInfo() Returns a formatted string with available Cluster, ClusterMember and WeightTable data. |
java.lang.Boolean | getAvailable( Get availability of a cluster member. |
void | setBackup( Sets the backup reference to the cluster specified with the parameters. |
| setAvailable( Marks a member of the cluster as available to take requests. |
| setUnavailable( Marks a member of the cluster as unavailable to requests. |
Notification Summary | |
---|---|
websphere.cluster.weight.table.change Notify listeners that the Cluster weight table was changed. | |
websphere.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. | |
cluster.member.unusable Notify listeners that a member of the cluster was marked as unavailable to take requests. | |
cluster.member.usable Notify listeners that a member of the cluster was marked as available to take requests. | |
websphere.cluster.backup.set Emitted when the backup cluster has been set. | |
websphere.cluster.controller.registered Emitted when a controller has been registered to control the cluster. | |
websphere.cluster.controller.identified Deprecated.Use the websphere.cluster.controller.registered notification |
Attribute Detail |
---|
public java.lang.String clusterName
The name of this cluster.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.Boolean preferLocal
Enable or disable Host scoped routing optimization. If true, WLM will always route an EJB request to the host on which the client resides if it is possible to do so.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Setter:
administrator
operator
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.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String state
The current state of the cluster.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String backupName
The name of the cluster to use as a backup to the cluster represented by this MBean.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String backupBootstrapHost
The BOOTSTRAP host name of the deployment manager for the backup cluster.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.Integer backupBootstrapPort
The BOOTSTRAP port of the deployment manager for the backup cluster.
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
Operation Detail |
---|
public ClusterMemberData[] getClusterMembers()
Retrieve the array of members contained by the cluster.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public ClusterMemberData getClusterMember(
java.lang.String memberName,
java.lang.String nodeName
)
Retrieve the cluster member data for the specified member.
memberName
-
Cluster member name. nodeName
-
The name of the node where the cluster member is configured.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public ClusterWeightTableEntry[] getWeightTable()
Retrieve the current in memory weight table.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public ClusterWeightTableEntry getWeightTableEntry(
java.lang.String memberName,
java.lang.String nodeName
)
Retrieve the in memory weight table entry for the specified cluster member.
memberName
-
Cluster member name. nodeName
-
The name of the node where the cluster member is configured.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void setWeightTable(
java.lang.Long key,
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.
key
-
The key obtained from the register() method. weightTable
-
Desired weight table for this cluster.
administrator
operator
public void setWeightTableEntry(
java.lang.Long key,
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.
key
-
The key obtained from the register() method. weightTableEntry
-
Desired weight table entry for particular member of the cluster.
administrator
operator
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.
wlcName
-
The Workload Controller ID or name.
administrator
operator
public 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.
administrator
operator
public void start()
Start the cluster of servers.
administrator
operator
public void stop()
Stop the cluster of servers.
administrator
operator
public void stopImmediate()
Stop the cluster of servers.
administrator
operator
public void rippleStart()
Stop and re-start the servers in the cluster.
administrator
operator
public java.lang.String exportRouteTable()
Exports the routing information to the cluster configuration directory for use by the cluster members at bootstrap when the dmgr is not available. The export is a snapshot in time. Static ports should be used with this functionality.
administrator
operator
public java.lang.boolean removeRouteTable()
Removes the static route table that is created by the exportRouteTable method.
administrator
operator
public java.lang.String dumpClusterInfo()
Returns a formatted string with available Cluster, ClusterMember and WeightTable data.
administrator
operator
public java.lang.Boolean getAvailable(
java.lang.String memberName,
java.lang.String nodeName
)
Get availability of a cluster member.
memberName
-
nodeName
-
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void setBackup(
java.lang.String clusterName,
java.lang.String host,
java.lang.Integer port
)
Sets the backup reference to the cluster specified with the parameters.
clusterName
-
The name of the cluster that should be associated as a backup to the cluster represented by this MBean. A null value effectively removes the backup. host
-
The BOOTSTRAP host of the machine where the deployment manager resides that manages the backup cluster. port
-
The BOOTSTRAP port used by the deployment manager where the backup cluster resides.
administrator
operator
public setAvailable(
java.lang.String memberName,
java.lang.String nodeName
)
Marks a member of the cluster as available to take requests. Calling this method will indicate to the router that this member should be considered for work when possible.
memberName
-
nodeName
-
administrator
operator
public setUnavailable(
java.lang.String memberName,
java.lang.String nodeName
)
Marks a member of the cluster as unavailable to requests. Calling this method will indicate to the router that this member should be avoided when possible.
memberName
-
nodeName
-
administrator
operator
Notification Detail |
---|
Notify listeners that the Cluster weight table was changed. The notification includes a copy of the updated Cluster weight table.
5
(Warning)
Notify listeners that a Cluster weight table entry was changed. The notification includes a copy of the updated Cluster weight table entry.
5
(Warning)
This cluster is being started. The object name of the cluster being started is passed in the user data.
5
(Warning)
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.
5
(Warning)
All members in the cluster are now running. The object name of the cluster is passed in the user data. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
5
(Warning)
This cluster is being stopped. The object name of the cluster being stopped is passed in the user data.
5
(Warning)
All servers in this cluster have been requested to stop. The object name of the cluster being stopped is passed in the user data.
5
(Warning)
All servers in the cluster are now stopped. The object name of the cluster is passed in the user data.
5
(Warning)
Notify listeners that a member of the cluster was marked as unavailable to take requests. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
1
(Non recoverable)
Notify listeners that a member of the cluster was marked as available to take requests. Due to the asynchronous nature of the cluster MBean and its corresponding notifications, a notification may be received before the actual operation that caused the notification is complete.
1
(Non recoverable)
Emitted when the backup cluster has been set.
5
(Warning)
Emitted when a controller has been registered to control the cluster.
5
(Warning)
Deprecated.
Use the websphere.cluster.controller.registered notification
Emitted when a controller has been identified for the cluster.
5
(Warning)