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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.cluster.messaging; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 17 | |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 18 | import com.google.common.base.MoreObjects; |
Jonathan Hart | 584d2f3 | 2015-01-27 19:46:14 -0800 | [diff] [blame] | 19 | import org.onlab.util.ByteArraySizeHashPrinter; |
| 20 | import org.onosproject.cluster.NodeId; |
| 21 | |
| 22 | import java.io.IOException; |
| 23 | import java.util.Arrays; |
| 24 | import java.util.Objects; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 25 | |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 26 | // TODO: Should payload type be ByteBuffer? |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Base message for cluster-wide communications. |
| 29 | */ |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 30 | public class ClusterMessage { |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 31 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 32 | private final NodeId sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 33 | private final MessageSubject subject; |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 34 | private final byte[] payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Creates a cluster message. |
| 38 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 39 | * @param sender message sender |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 40 | * @param subject message subject |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 41 | * @param payload message payload |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 42 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 43 | public ClusterMessage(NodeId sender, MessageSubject subject, byte[] payload) { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 44 | this.sender = sender; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 45 | this.subject = subject; |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 46 | this.payload = payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | /** |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 50 | * Returns the id of the controller sending this message. |
| 51 | * |
| 52 | * @return message sender id. |
| 53 | */ |
| 54 | public NodeId sender() { |
| 55 | return sender; |
| 56 | } |
| 57 | |
| 58 | /** |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 59 | * Returns the message subject indicator. |
| 60 | * |
| 61 | * @return message subject |
| 62 | */ |
| 63 | public MessageSubject subject() { |
| 64 | return subject; |
| 65 | } |
| 66 | |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 67 | /** |
| 68 | * Returns the message payload. |
| 69 | * |
| 70 | * @return message payload. |
| 71 | */ |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 72 | public byte[] payload() { |
Madan Jampani | 890bc35 | 2014-10-01 22:35:29 -0700 | [diff] [blame] | 73 | return payload; |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 74 | } |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 75 | |
| 76 | /** |
| 77 | * Sends a response to the sender. |
| 78 | * |
| 79 | * @param data payload response. |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 80 | * @throws IOException when I/O exception of some sort has occurred |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 81 | */ |
| 82 | public void respond(byte[] data) throws IOException { |
Jonathan Hart | 584d2f3 | 2015-01-27 19:46:14 -0800 | [diff] [blame] | 83 | throw new IllegalStateException("One can only respond to message received from others."); |
Madan Jampani | 8a89509 | 2014-10-17 16:55:50 -0700 | [diff] [blame] | 84 | } |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 85 | |
| 86 | @Override |
| 87 | public String toString() { |
| 88 | return MoreObjects.toStringHelper(getClass()) |
| 89 | .add("sender", sender) |
| 90 | .add("subject", subject) |
| 91 | .add("payload", ByteArraySizeHashPrinter.of(payload)) |
| 92 | .toString(); |
| 93 | } |
Jonathan Hart | 584d2f3 | 2015-01-27 19:46:14 -0800 | [diff] [blame] | 94 | |
| 95 | @Override |
| 96 | public boolean equals(Object o) { |
| 97 | if (!(o instanceof ClusterMessage)) { |
| 98 | return false; |
| 99 | } |
| 100 | |
| 101 | ClusterMessage that = (ClusterMessage) o; |
| 102 | |
| 103 | return Objects.equals(this.sender, that.sender) && |
| 104 | Objects.equals(this.subject, that.subject) && |
| 105 | Arrays.equals(this.payload, that.payload); |
| 106 | } |
| 107 | |
| 108 | @Override |
| 109 | public int hashCode() { |
| 110 | return Objects.hash(sender, subject, payload); |
| 111 | } |
tom | 1d416c5 | 2014-09-29 20:55:24 -0700 | [diff] [blame] | 112 | } |