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

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.services.exception.DoNotImplementException;

import java.util.List;

/**
 * Interface to modify {@link UserProperties} received from any MQTT packet.
 *
 * @author Christoph Schäbel
 * @author Florian Limpöck
 * @since 4.0.0, CE 2019.1
 */
@DoNotImplement
public interface ModifiableUserProperties extends UserProperties {

    /**
     * Add a new {@link UserProperty}.
     *
     * @param userProperty The user property to add.
     * @throws NullPointerException     If userProperty is null.
     * @throws NullPointerException     If the user property's name or value is null.
     * @throws IllegalArgumentException If the user property's name or value is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the user property's name or value exceeds the UTF-8 string length limit.
     * @throws DoNotImplementException  If the {@link UserProperty} is implemented by the extension.
     * @since 4.0.0, CE 2019.1
     */
    void addUserProperty(@NotNull UserProperty userProperty);

    /**
     * Add a new {@link UserProperty}.
     *
     * @param name  The name of the user property to add.
     * @param value The name of the user property to add.
     * @throws NullPointerException     If the name or value is null.
     * @throws IllegalArgumentException If the name or value is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the name or value exceeds the UTF-8 string length limit.
     * @since 4.0.0, CE 2019.1
     */
    void addUserProperty(@NotNull String name, @NotNull String value);

    /**
     * Remove a {@link UserProperty}.
     *
     * @param name  The name of the user property to remove.
     * @param value The value of the user property to remove.
     * @throws NullPointerException     If the name or value is null.
     * @throws IllegalArgumentException If the name or value is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the name or value exceeds the UTF-8 string length limit.
     * @since 4.0.0, CE 2019.1
     */
    void removeUserProperty(@NotNull String name, @NotNull String value);

    /**
     * Remove every {@link UserProperty} with the specified name.
     *
     * @param name The name of the user properties to remove.
     * @return A list of the removed user properties.
     * @throws NullPointerException     If the name is null.
     * @throws IllegalArgumentException If the name is not a valid UTF-8 string.
     * @throws IllegalArgumentException If the name exceeds the UTF-8 string length limit.
     * @since 4.0.0, CE 2019.1
     */
    @NotNull List<@NotNull UserProperty> removeName(@NotNull String name);

    /**
     * Removes all user properties.
     *
     * @since 4.0.0, CE 2019.1
     */
    void clear();
}