Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 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 | */ |
| 16 | package org.onosproject.store.primitives.resources.impl; |
| 17 | |
| 18 | import java.util.Map; |
| 19 | import java.util.Set; |
| 20 | |
| 21 | import org.onosproject.cluster.Leadership; |
| 22 | import org.onosproject.cluster.NodeId; |
| 23 | |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 24 | |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 25 | import com.google.common.base.MoreObjects; |
| 26 | import com.google.common.base.Strings; |
| 27 | |
| 28 | import io.atomix.catalyst.buffer.BufferInput; |
| 29 | import io.atomix.catalyst.buffer.BufferOutput; |
| 30 | import io.atomix.catalyst.serializer.CatalystSerializable; |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 31 | import io.atomix.catalyst.serializer.SerializableTypeResolver; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 32 | import io.atomix.catalyst.serializer.Serializer; |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 33 | import io.atomix.catalyst.serializer.SerializerRegistry; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 34 | import io.atomix.catalyst.util.Assert; |
Madan Jampani | 3a9911c | 2016-02-21 11:25:45 -0800 | [diff] [blame] | 35 | import io.atomix.copycat.Command; |
| 36 | import io.atomix.copycat.Query; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 37 | |
| 38 | /** |
| 39 | * {@link AtomixLeaderElector} resource state machine operations. |
| 40 | */ |
| 41 | public final class AtomixLeaderElectorCommands { |
| 42 | |
| 43 | private AtomixLeaderElectorCommands() { |
| 44 | } |
| 45 | |
| 46 | /** |
| 47 | * Abstract election query. |
| 48 | */ |
| 49 | @SuppressWarnings("serial") |
| 50 | public abstract static class ElectionQuery<V> implements Query<V>, CatalystSerializable { |
| 51 | |
| 52 | @Override |
| 53 | public ConsistencyLevel consistency() { |
| 54 | return ConsistencyLevel.BOUNDED_LINEARIZABLE; |
| 55 | } |
| 56 | |
| 57 | @Override |
| 58 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 59 | } |
| 60 | |
| 61 | @Override |
| 62 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 63 | } |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Abstract election topic query. |
| 68 | */ |
| 69 | @SuppressWarnings("serial") |
| 70 | public abstract static class TopicQuery<V> extends ElectionQuery<V> implements CatalystSerializable { |
| 71 | String topic; |
| 72 | |
| 73 | public TopicQuery() { |
| 74 | } |
| 75 | |
| 76 | public TopicQuery(String topic) { |
| 77 | this.topic = Assert.notNull(topic, "topic"); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Returns the topic. |
| 82 | * @return topic |
| 83 | */ |
| 84 | public String topic() { |
| 85 | return topic; |
| 86 | } |
| 87 | |
| 88 | @Override |
| 89 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 90 | serializer.writeObject(topic, buffer); |
| 91 | } |
| 92 | |
| 93 | @Override |
| 94 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 95 | topic = serializer.readObject(buffer); |
| 96 | } |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Abstract election command. |
| 101 | */ |
| 102 | @SuppressWarnings("serial") |
| 103 | public abstract static class ElectionCommand<V> implements Command<V>, CatalystSerializable { |
| 104 | |
| 105 | @Override |
| 106 | public ConsistencyLevel consistency() { |
| 107 | return ConsistencyLevel.LINEARIZABLE; |
| 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 112 | } |
| 113 | |
| 114 | @Override |
| 115 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 116 | } |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Listen command. |
| 121 | */ |
| 122 | @SuppressWarnings("serial") |
| 123 | public static class Listen extends ElectionCommand<Void> { |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Unlisten command. |
| 128 | */ |
| 129 | @SuppressWarnings("serial") |
| 130 | public static class Unlisten extends ElectionCommand<Void> { |
| 131 | |
| 132 | @Override |
| 133 | public CompactionMode compaction() { |
| 134 | return CompactionMode.QUORUM; |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * GetLeader query. |
| 140 | */ |
| 141 | @SuppressWarnings("serial") |
| 142 | public static class GetLeadership extends TopicQuery<Leadership> { |
| 143 | |
| 144 | public GetLeadership() { |
| 145 | } |
| 146 | |
| 147 | public GetLeadership(String topic) { |
| 148 | super(topic); |
| 149 | } |
| 150 | |
| 151 | @Override |
| 152 | public String toString() { |
| 153 | return MoreObjects.toStringHelper(getClass()) |
| 154 | .add("topic", topic) |
| 155 | .toString(); |
| 156 | } |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * GetAllLeaders query. |
| 161 | */ |
| 162 | @SuppressWarnings("serial") |
| 163 | public static class GetAllLeaderships extends ElectionQuery<Map<String, Leadership>> { |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * GetElectedTopics query. |
| 168 | */ |
| 169 | @SuppressWarnings("serial") |
| 170 | public static class GetElectedTopics extends ElectionQuery<Set<String>> { |
| 171 | private NodeId nodeId; |
| 172 | |
| 173 | public GetElectedTopics() { |
| 174 | } |
| 175 | |
| 176 | public GetElectedTopics(NodeId nodeId) { |
| 177 | this.nodeId = Assert.argNot(nodeId, nodeId == null, "nodeId cannot be null"); |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Returns the nodeId to check. |
| 182 | * |
| 183 | * @return The nodeId to check. |
| 184 | */ |
| 185 | public NodeId nodeId() { |
| 186 | return nodeId; |
| 187 | } |
| 188 | |
| 189 | @Override |
| 190 | public String toString() { |
| 191 | return MoreObjects.toStringHelper(getClass()) |
| 192 | .add("nodeId", nodeId) |
| 193 | .toString(); |
| 194 | } |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * Enter and run for leadership. |
| 199 | */ |
| 200 | @SuppressWarnings("serial") |
| 201 | public static class Run extends ElectionCommand<Leadership> { |
| 202 | private String topic; |
| 203 | private NodeId nodeId; |
| 204 | |
| 205 | public Run() { |
| 206 | } |
| 207 | |
| 208 | public Run(String topic, NodeId nodeId) { |
| 209 | this.topic = Assert.argNot(topic, Strings.isNullOrEmpty(topic), "topic cannot be null or empty"); |
| 210 | this.nodeId = Assert.argNot(nodeId, nodeId == null, "nodeId cannot be null"); |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Returns the topic. |
| 215 | * |
| 216 | * @return topic |
| 217 | */ |
| 218 | public String topic() { |
| 219 | return topic; |
| 220 | } |
| 221 | |
| 222 | /** |
| 223 | * Returns the nodeId. |
| 224 | * |
| 225 | * @return the nodeId |
| 226 | */ |
| 227 | public NodeId nodeId() { |
| 228 | return nodeId; |
| 229 | } |
| 230 | |
| 231 | @Override |
| 232 | public String toString() { |
| 233 | return MoreObjects.toStringHelper(getClass()) |
| 234 | .add("topic", topic) |
| 235 | .add("nodeId", nodeId) |
| 236 | .toString(); |
| 237 | } |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 238 | |
| 239 | @Override |
| 240 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 241 | buffer.writeString(topic); |
| 242 | buffer.writeString(nodeId.toString()); |
| 243 | } |
| 244 | |
| 245 | @Override |
| 246 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 247 | topic = buffer.readString(); |
| 248 | nodeId = new NodeId(buffer.readString()); |
| 249 | } |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 250 | } |
| 251 | |
| 252 | /** |
| 253 | * Withdraw from a leadership contest. |
| 254 | */ |
| 255 | @SuppressWarnings("serial") |
| 256 | public static class Withdraw extends ElectionCommand<Void> { |
| 257 | private String topic; |
| 258 | |
| 259 | public Withdraw() { |
| 260 | } |
| 261 | |
| 262 | public Withdraw(String topic) { |
| 263 | this.topic = Assert.argNot(topic, Strings.isNullOrEmpty(topic), "topic cannot be null or empty"); |
| 264 | } |
| 265 | |
| 266 | /** |
| 267 | * Returns the topic. |
| 268 | * |
| 269 | * @return The topic |
| 270 | */ |
| 271 | public String topic() { |
| 272 | return topic; |
| 273 | } |
| 274 | |
| 275 | @Override |
| 276 | public String toString() { |
| 277 | return MoreObjects.toStringHelper(getClass()) |
| 278 | .add("topic", topic) |
| 279 | .toString(); |
| 280 | } |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 281 | |
| 282 | @Override |
| 283 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 284 | buffer.writeString(topic); |
| 285 | } |
| 286 | |
| 287 | @Override |
| 288 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 289 | topic = buffer.readString(); |
| 290 | } |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 291 | } |
| 292 | |
| 293 | /** |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 294 | * Command for administratively changing the leadership state for a node. |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 295 | */ |
| 296 | @SuppressWarnings("serial") |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 297 | public abstract static class ElectionChangeCommand<V> extends ElectionCommand<V> { |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 298 | private String topic; |
| 299 | private NodeId nodeId; |
| 300 | |
Madan Jampani | c94b485 | 2016-02-23 18:18:37 -0800 | [diff] [blame] | 301 | ElectionChangeCommand() { |
| 302 | topic = null; |
| 303 | nodeId = null; |
| 304 | } |
| 305 | |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 306 | public ElectionChangeCommand(String topic, NodeId nodeId) { |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 307 | this.topic = topic; |
| 308 | this.nodeId = nodeId; |
| 309 | } |
| 310 | |
| 311 | /** |
| 312 | * Returns the topic. |
| 313 | * |
| 314 | * @return The topic |
| 315 | */ |
| 316 | public String topic() { |
| 317 | return topic; |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * Returns the nodeId to make leader. |
| 322 | * |
| 323 | * @return The nodeId |
| 324 | */ |
| 325 | public NodeId nodeId() { |
| 326 | return nodeId; |
| 327 | } |
| 328 | |
| 329 | @Override |
| 330 | public String toString() { |
| 331 | return MoreObjects.toStringHelper(getClass()) |
| 332 | .add("topic", topic) |
| 333 | .add("nodeId", nodeId) |
| 334 | .toString(); |
| 335 | } |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 336 | |
| 337 | @Override |
| 338 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 339 | buffer.writeString(topic); |
| 340 | buffer.writeString(nodeId.toString()); |
| 341 | } |
| 342 | |
| 343 | @Override |
| 344 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 345 | topic = buffer.readString(); |
| 346 | nodeId = new NodeId(buffer.readString()); |
| 347 | } |
| 348 | } |
| 349 | |
| 350 | /** |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 351 | * Command for administratively anoint a node as leader. |
| 352 | */ |
| 353 | @SuppressWarnings("serial") |
| 354 | public static class Anoint extends ElectionChangeCommand<Boolean> { |
Madan Jampani | c94b485 | 2016-02-23 18:18:37 -0800 | [diff] [blame] | 355 | |
| 356 | private Anoint() { |
| 357 | } |
| 358 | |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 359 | public Anoint(String topic, NodeId nodeId) { |
| 360 | super(topic, nodeId); |
| 361 | } |
| 362 | } |
| 363 | |
| 364 | /** |
Madan Jampani | 0c0cdc6 | 2016-02-22 16:54:06 -0800 | [diff] [blame] | 365 | * Command for administratively promote a node as top candidate. |
| 366 | */ |
| 367 | @SuppressWarnings("serial") |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 368 | public static class Promote extends ElectionChangeCommand<Boolean> { |
Madan Jampani | c94b485 | 2016-02-23 18:18:37 -0800 | [diff] [blame] | 369 | |
| 370 | private Promote() { |
| 371 | } |
| 372 | |
Madan Jampani | 0c0cdc6 | 2016-02-22 16:54:06 -0800 | [diff] [blame] | 373 | public Promote(String topic, NodeId nodeId) { |
Madan Jampani | db2afd3 | 2016-02-23 16:26:45 -0800 | [diff] [blame] | 374 | super(topic, nodeId); |
Madan Jampani | 0c0cdc6 | 2016-02-22 16:54:06 -0800 | [diff] [blame] | 375 | } |
| 376 | } |
| 377 | |
| 378 | /** |
| 379 | * Command for administratively evicting a node from all leadership topics. |
| 380 | */ |
| 381 | @SuppressWarnings("serial") |
| 382 | public static class Evict extends ElectionCommand<Void> { |
| 383 | private NodeId nodeId; |
| 384 | |
| 385 | public Evict() { |
| 386 | } |
| 387 | |
| 388 | public Evict(NodeId nodeId) { |
| 389 | this.nodeId = nodeId; |
| 390 | } |
| 391 | |
| 392 | /** |
| 393 | * Returns the node identifier. |
| 394 | * |
| 395 | * @return The nodeId |
| 396 | */ |
| 397 | public NodeId nodeId() { |
| 398 | return nodeId; |
| 399 | } |
| 400 | |
| 401 | @Override |
| 402 | public String toString() { |
| 403 | return MoreObjects.toStringHelper(getClass()) |
| 404 | .add("nodeId", nodeId) |
| 405 | .toString(); |
| 406 | } |
| 407 | |
| 408 | @Override |
| 409 | public void writeObject(BufferOutput<?> buffer, Serializer serializer) { |
| 410 | buffer.writeString(nodeId.toString()); |
| 411 | } |
| 412 | |
| 413 | @Override |
| 414 | public void readObject(BufferInput<?> buffer, Serializer serializer) { |
| 415 | nodeId = new NodeId(buffer.readString()); |
| 416 | } |
| 417 | } |
| 418 | |
| 419 | /** |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 420 | * Map command type resolver. |
| 421 | */ |
| 422 | public static class TypeResolver implements SerializableTypeResolver { |
| 423 | @Override |
| 424 | public void resolve(SerializerRegistry registry) { |
| 425 | registry.register(Run.class, -861); |
| 426 | registry.register(Withdraw.class, -862); |
| 427 | registry.register(Anoint.class, -863); |
| 428 | registry.register(GetAllLeaderships.class, -864); |
| 429 | registry.register(GetElectedTopics.class, -865); |
| 430 | registry.register(GetLeadership.class, -866); |
| 431 | registry.register(Listen.class, -867); |
| 432 | registry.register(Unlisten.class, -868); |
Madan Jampani | 0c0cdc6 | 2016-02-22 16:54:06 -0800 | [diff] [blame] | 433 | registry.register(Promote.class, -869); |
| 434 | registry.register(Evict.class, -870); |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 435 | } |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 436 | } |
| 437 | } |