com.hivemq.extension.sdk.api.auth.parameter.ModifiableClientSettings 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.auth.parameter;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.NotNull;

/**
 * An instance of this interface is provided by the {@link SimpleAuthOutput} and can be used to configure client
 * specific parameters and restrictions.
 *
 * @author Lukas Brandl
 * @since 4.2.0, CE 2020.1
 */
@DoNotImplement
public interface ModifiableClientSettings {

    /**
     * Set the receive maximum of the client to the given value. The new value overwrites the receive maximum that the
     * client provided via the CONNECT message.
     *
     * @param receiveMaximum To be used for this client.
     * @throws IllegalArgumentException If the value is less than 1 or more than 65535.
     * @since 4.2.0, CE 2020.1
     */
    void setClientReceiveMaximum(int receiveMaximum);

    /**
     * Configure the way the client is affected by the overload protection.
     *
     * @param level used for handling the overload protection for this client.
     * @throws NullPointerException If the level is null.
     * @since 4.2.0, CE 2020.1
     */
    void setOverloadProtectionThrottlingLevel(@NotNull OverloadProtectionThrottlingLevel level);

    /**
     * @return The value that will be used as receive maximum for this client.
     * @since 4.2.0, CE 2020.1
     */
    int getClientReceiveMaximum();

    /**
     * @return The overload protection level that will be used for this client.
     * @since 4.2.0, CE 2020.1
     */
    @NotNull OverloadProtectionThrottlingLevel getOverloadProtectionThrottlingLevel();

    /**
     * Set the queue size maximum of the client to the given value. The new value overwrites the default maximum.
     *
     * @param queueSizeMaximum To be used for this client.
     * @throws IllegalArgumentException If the value is less than 1.
     * @since 4.4.0
     */
    void setClientQueueSizeMaximum(long queueSizeMaximum);
}