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

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.packets.general.ModifiableUserProperties;
import com.hivemq.extension.sdk.api.packets.general.Qos;
import com.hivemq.extension.sdk.api.packets.general.UserProperties;

import java.nio.ByteBuffer;

/**
 * A {@link PublishPacket} that can be modified for onward delivery.
 *
 * @author Christoph Schäbel
 * @author Florian Limpöck
 * @since 4.0.0, CE 2019.1
 */
@DoNotImplement
public interface ModifiablePublishPacket extends PublishPacket {

    /**
     * This does not change the QoS to the publisher. Only for onward delivery.
     *
     * @param qos The QoS for the onward publish to subscribers.
     * @throws NullPointerException     If qos is null.
     * @throws IllegalArgumentException If qos is greater than the configured maximum.
     * @since 4.0.0, CE 2019.1
     */
    void setQos(@NotNull Qos qos);

    /**
     * Sets the retain flag.
     *
     * @param retain The new retain flag for the publish.
     * @throws IllegalArgumentException If set to true and retained messages are disabled by HiveMQ.
     * @since 4.0.0, CE 2019.1
     */
    void setRetain(boolean retain);

    /**
     * Sets the topic.
     *
     * @param topic The new topic for the publish.
     * @throws NullPointerException     If the topic is null.
     * @throws IllegalArgumentException If the topic is an empty string.
     * @throws IllegalArgumentException If the topic is invalid for publish messages.
     * @throws IllegalArgumentException If the topic length exceeds the configured length for topics. Default is 65535.
     * @since 4.0.0, CE 2019.1
     */
    void setTopic(@NotNull String topic);

    /**
     * Sets the payload format indicator.
     *
     * @param payloadFormatIndicator The new payload format indicator for the publish.
     * @since 4.0.0, CE 2019.1
     */
    void setPayloadFormatIndicator(@Nullable PayloadFormatIndicator payloadFormatIndicator);

    /**
     * Sets the message expiry interval.
     *
     * @param messageExpiryInterval The new message expiry interval for the publish.
     * @throws IllegalArgumentException If the message expiry interval is less than zero or more than the configured
     *                                  maximum by HiveMQ.
     * @since 4.0.0, CE 2019.1
     */
    void setMessageExpiryInterval(long messageExpiryInterval);

    /**
     * Sets the response topic.
     *
     * @param responseTopic The new response topic for the publish.
     * @throws IllegalArgumentException If the response topic is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the response topic exceeds the UTF-8 string length limit.
     * @since 4.0.0, CE 2019.1
     */
    void setResponseTopic(@Nullable String responseTopic);

    /**
     * Sets the correlation data.
     *
     * @param correlationData The new correlation data for the publish.
     * @since 4.0.0, CE 2019.1
     */
    void setCorrelationData(@Nullable ByteBuffer correlationData);

    /**
     * Sets the content type.
     *
     * @param contentType The new content type for the publish.
     * @throws IllegalArgumentException If the content type is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the content type exceeds the UTF-8 string length limit.
     * @since 4.0.0, CE 2019.1
     */
    void setContentType(@Nullable String contentType);

    /**
     * Sets the payload.
     *
     * @param payload The new payload for the publish.
     * @throws NullPointerException If payload is null.
     * @since 4.0.0, CE 2019.1
     */
    void setPayload(@NotNull ByteBuffer payload);

    /**
     * Get the modifiable {@link UserProperties} of the PUBLISH packet.
     *
     * @return Modifiable user properties.
     * @since 4.0.0, CE 2019.1
     */
    @NotNull ModifiableUserProperties getUserProperties();
}