com.hivemq.mqtt.message.reason.Mqtt5PubCompReasonCode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation

HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5

The newest version!

/*
 * Copyright 2019-present HiveMQ GmbH
 *
 * 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 com.hivemq.mqtt.message.reason;

import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.packets.pubcomp.PubcompReasonCode;

/**
 * MQTT Reason Codes that can be used in PUBCOMP packets according to the MQTT 5 specification.
 *
 * @author Silvio Giebl
 */
public enum Mqtt5PubCompReasonCode implements Mqtt5ReasonCode {

    SUCCESS(MqttCommonReasonCode.SUCCESS),
    PACKET_IDENTIFIER_NOT_FOUND(MqttCommonReasonCode.PACKET_IDENTIFIER_NOT_FOUND);

    private final int code;
    private final @NotNull PubcompReasonCode pubcompReasonCode;

    Mqtt5PubCompReasonCode(final int code) {
        this.code = code;
        pubcompReasonCode = PubcompReasonCode.valueOf(name());
    }

    Mqtt5PubCompReasonCode(final @NotNull MqttCommonReasonCode reasonCode) {
        this(reasonCode.getCode());
    }

    @Override
    public int getCode() {
        return code;
    }

    public @NotNull PubcompReasonCode toPubcompReasonCode() {
        return pubcompReasonCode;
    }

    private static final @NotNull Mqtt5PubCompReasonCode @NotNull [] PUBCOMP_LOOKUP =
            new Mqtt5PubCompReasonCode[PubcompReasonCode.values().length];

    static {
        for (final Mqtt5PubCompReasonCode reasonCode : values()) {
            PUBCOMP_LOOKUP[reasonCode.pubcompReasonCode.ordinal()] = reasonCode;
        }
    }

    /**
     * Returns the PUBCOMP Reason Code belonging to the given byte code.
     *
     * @param code the byte code.
     * @return the PUBCOMP Reason Code belonging to the given byte code or null if the byte code is not a
     *         valid PUBCOMP Reason Code.
     */
    public static @Nullable Mqtt5PubCompReasonCode fromCode(final int code) {
        if (code == SUCCESS.code) {
            return SUCCESS;
        } else if (code == PACKET_IDENTIFIER_NOT_FOUND.code) {
            return PACKET_IDENTIFIER_NOT_FOUND;
        }
        return null;
    }

    public static @NotNull Mqtt5PubCompReasonCode from(final @NotNull PubcompReasonCode reasonCode) {
        return PUBCOMP_LOOKUP[reasonCode.ordinal()];
    }

    @Override
    public boolean canBeSentByClient() {
        return true;
    }
}