core/store/dist/src/main/java/org/onosproject/store/cluster/messaging/impl/InternalMessage.java

/*
 * Copyright 2017-present Open Networking Laboratory
 *
 * 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 org.onosproject.core.HybridLogicalTime;

/**
 * Base class for internal messages.
 */
public abstract class InternalMessage {

    /**
     * Internal message type.
     */
    public enum Type {
        REQUEST(1),
        REPLY(2);

        private final int id;

        Type(int id) {
            this.id = id;
        }

        /**
         * Returns the unique message type ID.
         *
         * @return the unique message type ID.
         */
        public int id() {
            return id;
        }

        /**
         * Returns the message type enum associated with the given ID.
         *
         * @param id the type ID.
         * @return the type enum for the given ID.
         */
        public static Type forId(int id) {
            switch (id) {
                case 1:
                    return REQUEST;
                case 2:
                    return REPLY;
                default:
                    throw new IllegalArgumentException("Unknown status ID " + id);
            }
        }
    }

    private final int preamble;
    private final HybridLogicalTime time;
    private final long id;
    private final byte[] payload;

    protected InternalMessage(int preamble,
            HybridLogicalTime time,
            long id,
            byte[] payload) {
        this.preamble = preamble;
        this.time = time;
        this.id = id;
        this.payload = payload;
    }

    public abstract Type type();

    public boolean isRequest() {
        return type() == Type.REQUEST;
    }

    public boolean isReply() {
        return type() == Type.REPLY;
    }

    public HybridLogicalTime time() {
        return time;
    }

    public int preamble() {
        return preamble;
    }

    public long id() {
        return id;
    }

    public byte[] payload() {
        return payload;
    }
}