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 { |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 34 | |
| 35 | // NOTE: For backwards compatibility enum constant IDs should not be changed. |
| 36 | |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 37 | /** |
| 38 | * All ok. |
| 39 | */ |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 40 | OK(0), |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Response status signifying no registered handler. |
| 44 | */ |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 45 | ERROR_NO_HANDLER(1), |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Response status signifying an exception handling the message. |
| 49 | */ |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 50 | ERROR_HANDLER_EXCEPTION(2), |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 51 | |
| 52 | /** |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 53 | * Response status signifying invalid message structure. |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 54 | */ |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 55 | PROTOCOL_EXCEPTION(3); |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 56 | |
Jordan Halterman | 742bd09 | 2017-02-28 01:01:49 -0800 | [diff] [blame] | 57 | private final int id; |
| 58 | |
| 59 | Status(int id) { |
| 60 | this.id = id; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Returns the unique status ID. |
| 65 | * |
| 66 | * @return the unique status ID. |
| 67 | */ |
| 68 | public int id() { |
| 69 | return id; |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Returns the status enum associated with the given ID. |
| 74 | * |
| 75 | * @param id the status ID. |
| 76 | * @return the status enum for the given ID. |
| 77 | */ |
| 78 | public static Status forId(int id) { |
| 79 | switch (id) { |
| 80 | case 0: |
| 81 | return OK; |
| 82 | case 1: |
| 83 | return ERROR_NO_HANDLER; |
| 84 | case 2: |
| 85 | return ERROR_HANDLER_EXCEPTION; |
| 86 | case 3: |
| 87 | return PROTOCOL_EXCEPTION; |
| 88 | default: |
| 89 | throw new IllegalArgumentException("Unknown status ID " + id); |
| 90 | } |
| 91 | } |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 92 | } |
| 93 | |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 94 | private final int preamble; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 95 | private final HybridLogicalTime time; |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 96 | private final long id; |
| 97 | private final Endpoint sender; |
| 98 | private final String type; |
| 99 | private final byte[] payload; |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 100 | private final Status status; |
Yuta HIGUCHI | c65f512 | 2014-10-07 10:05:59 -0700 | [diff] [blame] | 101 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 102 | public InternalMessage(int preamble, |
| 103 | HybridLogicalTime time, |
| 104 | long id, |
| 105 | Endpoint sender, |
| 106 | String type, |
| 107 | byte[] payload) { |
| 108 | this(preamble, time, id, sender, type, payload, Status.OK); |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 109 | } |
| 110 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 111 | public InternalMessage(int preamble, |
| 112 | HybridLogicalTime time, |
| 113 | long id, |
| 114 | Endpoint sender, |
| 115 | String type, |
| 116 | byte[] payload, |
| 117 | Status status) { |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 118 | this.preamble = preamble; |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 119 | this.time = time; |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 120 | this.id = id; |
| 121 | this.sender = sender; |
| 122 | this.type = type; |
| 123 | this.payload = payload; |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 124 | this.status = status; |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 125 | } |
| 126 | |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 127 | public HybridLogicalTime time() { |
| 128 | return time; |
| 129 | } |
| 130 | |
Madan Jampani | b825aeb | 2016-04-01 15:18:25 -0700 | [diff] [blame] | 131 | public int preamble() { |
| 132 | return preamble; |
| 133 | } |
| 134 | |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 135 | public long id() { |
| 136 | return id; |
| 137 | } |
| 138 | |
Madan Jampani | 49115e9 | 2015-03-14 10:43:33 -0700 | [diff] [blame] | 139 | public String type() { |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 140 | return type; |
| 141 | } |
| 142 | |
| 143 | public Endpoint sender() { |
| 144 | return sender; |
| 145 | } |
| 146 | |
Madan Jampani | 53e44e6 | 2014-10-07 12:39:51 -0700 | [diff] [blame] | 147 | public byte[] payload() { |
Madan Jampani | ab6d311 | 2014-10-02 16:30:14 -0700 | [diff] [blame] | 148 | return payload; |
| 149 | } |
| 150 | |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 151 | public Status status() { |
| 152 | return status; |
| 153 | } |
| 154 | |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 155 | @Override |
| 156 | public String toString() { |
| 157 | return MoreObjects.toStringHelper(this) |
Madan Jampani | 0583387 | 2016-07-12 23:01:39 -0700 | [diff] [blame] | 158 | .add("time", time) |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 159 | .add("id", id) |
| 160 | .add("type", type) |
| 161 | .add("sender", sender) |
Madan Jampani | a9e70a6 | 2016-03-02 16:28:18 -0800 | [diff] [blame] | 162 | .add("status", status) |
Yuta HIGUCHI | 0a0b9e4 | 2015-02-11 16:57:12 -0800 | [diff] [blame] | 163 | .add("payload", ByteArraySizeHashPrinter.of(payload)) |
| 164 | .toString(); |
| 165 | } |
Yuta HIGUCHI | 92626c0 | 2014-10-06 15:46:18 -0700 | [diff] [blame] | 166 | } |