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; |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 21 | import org.onlab.util.ByteArraySizeHashPrinter; |
| 22 | |
| 23 | import com.google.common.base.MoreObjects; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 24 | |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 25 | // TODO: Should payload type be ByteBuffer? |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 26 | /** |
| 27 | * Base message for cluster-wide communications. |
| 28 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 29 | public class ClusterMessage { |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 30 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 31 | private final NodeId sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 32 | private final MessageSubject subject; |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 33 | private final byte[] payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Creates a cluster message. |
| 37 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 38 | * @param sender message sender |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 39 | * @param subject message subject |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 40 | * @param payload message payload |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 41 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 42 | public ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 43 | this.sender = sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 44 | this.subject = subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 45 | this.payload = payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 49 | * Returns the id of the controller sending this message. |
| 50 | * |
| 51 | * @return message sender id. |
| 52 | */ |
| 53 | public NodeId sender() { |
| 54 | return sender; |
| 55 | } |
| 56 | |
| 57 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 58 | * Returns the message subject indicator. |
| 59 | * |
| 60 | * @return message subject |
| 61 | */ |
| 62 | public MessageSubject subject() { |
| 63 | return subject; |
| 64 | } |
| 65 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Returns the message payload. |
| 68 | * |
| 69 | * @return message payload. |
| 70 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 71 | public byte[] payload() { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 72 | return payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 73 | } |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 74 | |
| 75 | /** |
| 76 | * Sends a response to the sender. |
| 77 | * |
| 78 | * @param data payload response. |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 79 | * @throws IOException when I/O exception of some sort has occurred |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 80 | */ |
| 81 | public void respond(byte[] data) throws IOException { |
| 82 | throw new IllegalStateException("One can only repond to message recived from others."); |
| 83 | } |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 84 | |
| 85 | @Override |
| 86 | public String toString() { |
| 87 | return MoreObjects.toStringHelper(getClass()) |
| 88 | .add("sender", sender) |
| 89 | .add("subject", subject) |
| 90 | .add("payload", ByteArraySizeHashPrinter.of(payload)) |
| 91 | .toString(); |
| 92 | } |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 93 | } |