tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 1 | package org.onlab.onos.store.cluster.messaging; |
| 2 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 3 | import org.onlab.onos.cluster.NodeId; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 4 | |
| 5 | /** |
| 6 | * Base message for cluster-wide communications. |
| 7 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 8 | public class ClusterMessage { |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 9 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 10 | private final NodeId sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 11 | private final MessageSubject subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 12 | private final Object payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 13 | |
| 14 | /** |
| 15 | * Creates a cluster message. |
| 16 | * |
| 17 | * @param subject message subject |
| 18 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 19 | public ClusterMessage(NodeId sender, MessageSubject subject, Object payload) { |
| 20 | this.sender = sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 21 | this.subject = subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 22 | this.payload = payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 23 | } |
| 24 | |
| 25 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 26 | * Returns the id of the controller sending this message. |
| 27 | * |
| 28 | * @return message sender id. |
| 29 | */ |
| 30 | public NodeId sender() { |
| 31 | return sender; |
| 32 | } |
| 33 | |
| 34 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 35 | * Returns the message subject indicator. |
| 36 | * |
| 37 | * @return message subject |
| 38 | */ |
| 39 | public MessageSubject subject() { |
| 40 | return subject; |
| 41 | } |
| 42 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 43 | /** |
| 44 | * Returns the message payload. |
| 45 | * |
| 46 | * @return message payload. |
| 47 | */ |
| 48 | public Object payload() { |
| 49 | return payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 50 | } |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 51 | } |