com.hivemq.extension.sdk.api.packets.puback.ModifiablePubackPacket 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.puback;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.annotations.Nullable;
import com.hivemq.extension.sdk.api.interceptor.puback.PubackInboundInterceptor;
import com.hivemq.extension.sdk.api.interceptor.puback.PubackOutboundInterceptor;
import com.hivemq.extension.sdk.api.packets.general.ModifiableUserProperties;
import com.hivemq.extension.sdk.api.packets.general.UserProperties;
import com.hivemq.extension.sdk.api.packets.publish.AckReasonCode;

/**
 * A {@link PubackPacket} that can be modified before it is sent to the client (for {@link PubackOutboundInterceptor})
 * or to the server (for {@link PubackInboundInterceptor}).
 *
 * @author Yannick Weber
 * @since 4.3.0, CE 2020.1
 */
@DoNotImplement
public interface ModifiablePubackPacket extends PubackPacket {

    /**
     * Set a {@link AckReasonCode} to the PUBACK packet.
     * 
     * Switching from successful to unsuccessful and vice versa is not supported, in that case an
     * {@link IllegalStateException} is thrown.
     *
     * @param reasonCode The reason code to set.
     * @throws NullPointerException  If reason code is null.
     * @throws IllegalStateException If switching from successful reason code to unsuccessful reason code or vice
     *                               versa.
     * @see AckReasonCode How reason codes are translated from MQTT 5 to MQTT 3.
     * @since 4.3.0, CE 2020.1
     */
    void setReasonCode(@NotNull AckReasonCode reasonCode);

    /**
     * Set the reason string.
     * 

     * A reason must not be set for a successful publish.
     * 

     * For an {@link PubackOutboundInterceptor} this setting is only respected for MQTT 5 clients and ignored for MQTT
     * 3.x clients when the PUBACK is sent to the client (as MQTT 3.x clients don't know this property).
     * 

     * For an {@link PubackInboundInterceptor} this setting is respected for MQTT 5 and MQTT 3.x clients when the PUBACK
     * is sent to HiveMQ, this allows to enrich MQTT 3.x PUBACKs with this MQTT 5 property.
     *
     * @param reasonString The reason string to set.
     * @throws IllegalArgumentException If the reason string is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the reason string exceeds the UTF-8 string length limit.
     * @since 4.3.0, CE 2020.1
     */
    void setReasonString(@Nullable String reasonString);

    /**
     * Get the modifiable {@link UserProperties} of the PUBACK packet.
     * 

     * For an {@link PubackOutboundInterceptor} this setting is only respected for MQTT 5 clients and ignored for MQTT
     * 3.x clients when the PUBACK is sent to the client (as MQTT 3.x clients don't know this property).
     * 
     * For an {@link PubackInboundInterceptor} this setting is respected for MQTT 5 and MQTT 3.x clients when the PUBACK
     * is sent to HiveMQ, this allows to enrich MQTT 3.x PUBACKs with this MQTT 5 property.
     *
     * @return Modifiable user properties.
     * @since 4.3.0, CE 2020.1
     */
    @Override
    @NotNull ModifiableUserProperties getUserProperties();
}