| /* |
| * Copyright 2017-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.store.cluster.messaging.impl; |
| |
| import com.google.common.base.MoreObjects; |
| import org.onlab.util.ByteArraySizeHashPrinter; |
| import org.onosproject.core.HybridLogicalTime; |
| |
| /** |
| * Internal reply message. |
| */ |
| public final class InternalReply extends InternalMessage { |
| |
| /** |
| * Message status. |
| */ |
| public enum Status { |
| |
| // NOTE: For backwards compatibility enum constant IDs should not be changed. |
| |
| /** |
| * All ok. |
| */ |
| OK(0), |
| |
| /** |
| * Response status signifying no registered handler. |
| */ |
| ERROR_NO_HANDLER(1), |
| |
| /** |
| * Response status signifying an exception handling the message. |
| */ |
| ERROR_HANDLER_EXCEPTION(2), |
| |
| /** |
| * Response status signifying invalid message structure. |
| */ |
| PROTOCOL_EXCEPTION(3); |
| |
| private final int id; |
| |
| Status(int id) { |
| this.id = id; |
| } |
| |
| /** |
| * Returns the unique status ID. |
| * |
| * @return the unique status ID. |
| */ |
| public int id() { |
| return id; |
| } |
| |
| /** |
| * Returns the status enum associated with the given ID. |
| * |
| * @param id the status ID. |
| * @return the status enum for the given ID. |
| */ |
| public static Status forId(int id) { |
| switch (id) { |
| case 0: |
| return OK; |
| case 1: |
| return ERROR_NO_HANDLER; |
| case 2: |
| return ERROR_HANDLER_EXCEPTION; |
| case 3: |
| return PROTOCOL_EXCEPTION; |
| default: |
| throw new IllegalArgumentException("Unknown status ID " + id); |
| } |
| } |
| } |
| |
| private final Status status; |
| |
| public InternalReply(int preamble, |
| HybridLogicalTime time, |
| long id, |
| Status status) { |
| this(preamble, time, id, new byte[0], status); |
| } |
| |
| public InternalReply(int preamble, |
| HybridLogicalTime time, |
| long id, |
| byte[] payload, |
| Status status) { |
| super(preamble, time, id, payload); |
| this.status = status; |
| } |
| |
| @Override |
| public Type type() { |
| return Type.REPLY; |
| } |
| |
| public Status status() { |
| return status; |
| } |
| |
| @Override |
| public String toString() { |
| return MoreObjects.toStringHelper(this) |
| .add("time", time()) |
| .add("id", id()) |
| .add("status", status()) |
| .add("payload", ByteArraySizeHashPrinter.of(payload())) |
| .toString(); |
| } |
| } |