ClusterControllMessage (FORMCYCLE: BOM 7.3.0 API)

java.lang.Object
- de.xima.fc.cluster.model.msg.ClusterControllMessage

All Implemented Interfaces:

IClusterMessage, Serializable
```
public class ClusterControllMessage
extends Object
implements IClusterMessage
```
A message is sent to control other nodes, such as when a node should change its state and start or stop performing work.

Since:

3.1.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ClusterControllMessage(NodeModel targetNode, EClusterControllMessage msg)`	Creates a new cluster control message targeted at the given node.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EClusterControllMessage`	`getControllMsg()`
`Serializable`	`getMessageData()`
`NodeModel`	`getSourceNode()`
`NodeModel`	`getTargetNode()`
`void`	`setSourceNode(NodeModel sourceNode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClusterControllMessage
```
public ClusterControllMessage(NodeModel targetNode,
                              EClusterControllMessage msg)
```
    Creates a new cluster control message targeted at the given node.
    
    Parameters:
    
    targetNode - Node to which a control message should be sent.
    
    msg - Command to be sent to the node.
- Method Detail
  - getControllMsg
```
public EClusterControllMessage getControllMsg()
```
    Returns:
    
    Control command for the target node.
  - getSourceNode
```
public NodeModel getSourceNode()
```
    Specified by:
    
    getSourceNode in interface IClusterMessage
    
    Returns:
    
    The source node from which the message originates.
  - setSourceNode
```
public void setSourceNode(NodeModel sourceNode)
```
    Specified by:
    
    setSourceNode in interface IClusterMessage
    
    Parameters:
    
    sourceNode - The source node from which the message originates.
  - getTargetNode
```
public NodeModel getTargetNode()
```
    Specified by:
    
    getTargetNode in interface IClusterMessage
    
    Returns:
    
    The node to which the message should be sent.
  - getMessageData
```
public Serializable getMessageData()
```
    Specified by:
    
    getMessageData in interface IClusterMessage
    
    Returns:
    
    The payload with the message details.