Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 24c849c | 2014-10-27 09:53:05 -0700 | [diff] [blame] | 15 | */ |
Aaron Kruglikov | 1b72738 | 2016-02-09 16:17:47 -0800 | [diff] [blame] | 16 | package org.onosproject.store.cluster.messaging.impl; |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 17 | |
| 18 | import com.google.common.base.MoreObjects; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 19 | |
Aaron Kruglikov | 1b72738 | 2016-02-09 16:17:47 -0800 | [diff] [blame] | 20 | import org.onlab.util.ByteArraySizeHashPrinter; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 21 | import org.onosproject.core.HybridLogicalTime; |
Aaron Kruglikov | 1b72738 | 2016-02-09 16:17:47 -0800 | [diff] [blame] | 22 | import org.onosproject.store.cluster.messaging.Endpoint; |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 23 | |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 24 | /** |
| 25 | * Internal message representation with additional attributes |
| 26 | * for supporting, synchronous request/reply behavior. |
| 27 | */ |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 28 | public final class InternalMessage { |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 29 | |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 30 | /** |
| 31 | * Message status. |
| 32 | */ |
| 33 | public enum Status { |
| 34 | /** |
| 35 | * All ok. |
| 36 | */ |
| 37 | OK, |
| 38 | |
| 39 | /** |
| 40 | * Response status signifying no registered handler. |
| 41 | */ |
| 42 | ERROR_NO_HANDLER, |
| 43 | |
| 44 | /** |
| 45 | * Response status signifying an exception handling the message. |
| 46 | */ |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 47 | ERROR_HANDLER_EXCEPTION, |
| 48 | |
| 49 | /** |
| 50 | * Reponse status signifying invalid message structure. |
| 51 | */ |
| 52 | PROTOCOL_EXCEPTION |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 53 | |
| 54 | // NOTE: For backwards compatibility it important that new enum constants |
| 55 | // be appended. |
| 56 | // FIXME: We should remove this restriction in the future. |
| 57 | } |
| 58 | |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 59 | private final int preamble; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 60 | private final HybridLogicalTime time; |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 61 | private final long id; |
| 62 | private final Endpoint sender; |
| 63 | private final String type; |
| 64 | private final byte[] payload; |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 65 | private final Status status; |
Yuta HIGUCHI | c65f512 | 2014-10-07 10:05:59 -0700 | [diff] [blame] | 66 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 67 | public InternalMessage(int preamble, |
| 68 | HybridLogicalTime time, |
| 69 | long id, |
| 70 | Endpoint sender, |
| 71 | String type, |
| 72 | byte[] payload) { |
| 73 | this(preamble, time, id, sender, type, payload, Status.OK); |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 74 | } |
| 75 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 76 | public InternalMessage(int preamble, |
| 77 | HybridLogicalTime time, |
| 78 | long id, |
| 79 | Endpoint sender, |
| 80 | String type, |
| 81 | byte[] payload, |
| 82 | Status status) { |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 83 | this.preamble = preamble; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 84 | this.time = time; |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 85 | this.id = id; |
| 86 | this.sender = sender; |
| 87 | this.type = type; |
| 88 | this.payload = payload; |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 89 | this.status = status; |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 90 | } |
| 91 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 92 | public HybridLogicalTime time() { |
| 93 | return time; |
| 94 | } |
| 95 | |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 96 | public int preamble() { |
| 97 | return preamble; |
| 98 | } |
| 99 | |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 100 | public long id() { |
| 101 | return id; |
| 102 | } |
| 103 | |
Madan Jampani | 49115e9 | 2015-03-14 10:43:33 -0700 | [diff] [blame] | 104 | public String type() { |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 105 | return type; |
| 106 | } |
| 107 | |
| 108 | public Endpoint sender() { |
| 109 | return sender; |
| 110 | } |
| 111 | |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 112 | public byte[] payload() { |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 113 | return payload; |
| 114 | } |
| 115 | |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 116 | public Status status() { |
| 117 | return status; |
| 118 | } |
| 119 | |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 120 | @Override |
| 121 | public String toString() { |
| 122 | return MoreObjects.toStringHelper(this) |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame^] | 123 | .add("time", time) |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 124 | .add("id", id) |
| 125 | .add("type", type) |
| 126 | .add("sender", sender) |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 127 | .add("status", status) |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 128 | .add("payload", ByteArraySizeHashPrinter.of(payload)) |
| 129 | .toString(); |
| 130 | } |
Yuta HIGUCHI | 92626c0 | 2014-10-06 15:46:18 -0700 | [diff] [blame] | 131 | } |