com.hivemq.mqtt.message.disconnect.DISCONNECT 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.disconnect;

import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extensions.packets.disconnect.DisconnectPacketImpl;
import com.hivemq.mqtt.message.MessageType;
import com.hivemq.mqtt.message.mqtt5.Mqtt5UserProperties;
import com.hivemq.mqtt.message.mqtt5.MqttMessageWithUserProperties;
import com.hivemq.mqtt.message.reason.Mqtt5DisconnectReasonCode;

/**
 * @author Dominik Obermaier
 * @author Florian Limpöck
 * @since 1.4
 */
@Immutable
public class DISCONNECT extends MqttMessageWithUserProperties.MqttMessageWithReasonCode
        implements Mqtt3DISCONNECT, Mqtt5DISCONNECT {

    public static final long SESSION_EXPIRY_NOT_SET = Long.MAX_VALUE;

    private final @Nullable String serverReference;
    private final long sessionExpiryInterval;

    //MQTT 3
    public DISCONNECT() {
        super(Mqtt5DisconnectReasonCode.NORMAL_DISCONNECTION, null, Mqtt5UserProperties.NO_USER_PROPERTIES);
        sessionExpiryInterval = SESSION_EXPIRY_NOT_SET;
        serverReference = null;
    }

    public DISCONNECT(
            final @NotNull Mqtt5DisconnectReasonCode reasonCode,
            final @Nullable String reasonString,
            final @NotNull Mqtt5UserProperties userProperties,
            final @Nullable String serverReference,
            final long sessionExpiryInterval) {

        super(reasonCode, reasonString, userProperties);
        this.serverReference = serverReference;
        this.sessionExpiryInterval = sessionExpiryInterval;
    }

    @Override
    public long getSessionExpiryInterval() {
        return sessionExpiryInterval;
    }

    @Override
    public @Nullable String getServerReference() {
        return serverReference;
    }

    @Override
    public @NotNull MessageType getType() {
        return MessageType.DISCONNECT;
    }

    public static @NotNull DISCONNECT from(final @NotNull DisconnectPacketImpl packet) {
        return new DISCONNECT(Mqtt5DisconnectReasonCode.from(packet.getReasonCode()),
                packet.getReasonString().orElse(null),
                Mqtt5UserProperties.of(packet.getUserProperties().asInternalList()),
                packet.getServerReference().orElse(null),
                packet.getSessionExpiryInterval().orElse(SESSION_EXPIRY_NOT_SET));
    }
}