Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 16 | package org.onlab.onos.store.cluster.messaging; |
| 17 | |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 18 | import java.io.IOException; |
| 19 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 20 | import org.onlab.onos.cluster.NodeId; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 21 | |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 22 | // TODO: Should payload type be ByteBuffer? |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 23 | /** |
| 24 | * Base message for cluster-wide communications. |
| 25 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 26 | public class ClusterMessage { |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 27 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 28 | private final NodeId sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 29 | private final MessageSubject subject; |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 30 | private final byte[] payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Creates a cluster message. |
| 34 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame^] | 35 | * @param sender message sender |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 36 | * @param subject message subject |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame^] | 37 | * @param payload message payload |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 38 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 39 | public ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 40 | this.sender = sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 41 | this.subject = subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 42 | this.payload = payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 43 | } |
| 44 | |
| 45 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 46 | * Returns the id of the controller sending this message. |
| 47 | * |
| 48 | * @return message sender id. |
| 49 | */ |
| 50 | public NodeId sender() { |
| 51 | return sender; |
| 52 | } |
| 53 | |
| 54 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 55 | * Returns the message subject indicator. |
| 56 | * |
| 57 | * @return message subject |
| 58 | */ |
| 59 | public MessageSubject subject() { |
| 60 | return subject; |
| 61 | } |
| 62 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 63 | /** |
| 64 | * Returns the message payload. |
| 65 | * |
| 66 | * @return message payload. |
| 67 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 68 | public byte[] payload() { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 69 | return payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 70 | } |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * Sends a response to the sender. |
| 74 | * |
| 75 | * @param data payload response. |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame^] | 76 | * @throws IOException when I/O exception of some sort has occurred |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 77 | */ |
| 78 | public void respond(byte[] data) throws IOException { |
| 79 | throw new IllegalStateException("One can only repond to message recived from others."); |
| 80 | } |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 81 | } |