com.hivemq.extension.sdk.api.packets.disconnect.DisconnectPacket Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-extension-sdk Show documentation
SDK for the development of HiveMQ extensions
There is a newer version: 4.35.0
/*
 * Copyright 2018-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.extension.sdk.api.packets.disconnect;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.interceptor.disconnect.DisconnectInboundInterceptor;
import com.hivemq.extension.sdk.api.interceptor.disconnect.DisconnectOutboundInterceptor;
import com.hivemq.extension.sdk.api.packets.general.UserProperties;

import java.util.Optional;

/**
 * Represents a DISCONNECT packet.
 * 
 * Contains all values of an MQTT 5 DISCONNECT packet, but will also be used to represent MQTT 3.x DISCONNECT packets.
 *
 * @author Robin Atherton
 * @author Silvio Giebl
 * @since 4.3.0, CE 2020.1
 */
@Immutable
@DoNotImplement
public interface DisconnectPacket {

    /**
     * The reason code of the DISCONNECT packet.
     * 

     * It will be {@link DisconnectReasonCode#NORMAL_DISCONNECTION} for MQTT 3.x clients (if not modified by an
     * interceptor).
     *
     * @return An enum containing the reason for disconnecting.
     * @since 4.3.0, CE 2020.1
     */
    @NotNull DisconnectReasonCode getReasonCode();

    /**
     * The optional reason string of the DISCONNECT packet.
     * 

     * For an MQTT 3 client this {@link Optional} for the MQTT 5 property will always be empty (if not modified by a
     * previous {@link DisconnectInboundInterceptor} or {@link DisconnectOutboundInterceptor}).
     *
     * @return A string containing the disconnect reason if present.
     * @since 4.3.0, CE 2020.1
     */
    @NotNull Optional getReasonString();

    /**
     * The optional session expiry interval in seconds (duration for which the clients session is stored) of the
     * DISCONNECT packet.
     * 

     * If absent, the session expiry interval of the CONNECT/CONNACK handshake will be used.
     * 

     * For an MQTT 3 client this {@link Optional} for the MQTT 5 property will always be empty (if not modified by a
     * previous {@link DisconnectInboundInterceptor} or {@link DisconnectOutboundInterceptor}).
     *
     * @return A long representing the session expiry interval if present.
     * @since 4.3.0, CE 2020.1
     */
    @NotNull Optional getSessionExpiryInterval();

    /**
     * The optional server reference of the DISCONNECT packet.
     * 

     * It is only present for outbound DISCONNECT packets from the server to a client.
     * 

     * For an MQTT 3 client this {@link Optional} for the MQTT 5 property will always be empty (if not modified by a
     * previous {@link DisconnectInboundInterceptor} or {@link DisconnectOutboundInterceptor}).
     *
     * @return A string representing the server reference if present.
     * @since 4.3.0, CE 2020.1
     */
    @NotNull Optional getServerReference();

    /**
     * The user properties from the DISCONNECT packet.
     * 
     * For an MQTT 3 client this {@link Optional} for the MQTT 5 property will always be empty (if not modified by a
     * previous {@link DisconnectInboundInterceptor} or {@link DisconnectOutboundInterceptor}).
     *
     * @return The {@link UserProperties} of the DISCONNECT packet.
     * @since 4.3.0, CE 2020.1
     */
    @NotNull UserProperties getUserProperties();
}