com.hivemq.client.mqtt.mqtt3.message.auth.Mqtt3SimpleAuthBuilderBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-mqtt-client Show documentation

HiveMQ MQTT Client is an MQTT 5.0 and MQTT 3.1.1 compatible and feature-rich high-performance Java client library with different API flavours and backpressure support

The newest version!

/*
 * Copyright 2018-present HiveMQ and the HiveMQ Community
 *
 * 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.client.mqtt.mqtt3.message.auth;

import com.hivemq.client.annotations.CheckReturnValue;
import com.hivemq.client.annotations.DoNotImplement;
import com.hivemq.client.mqtt.datatypes.MqttUtf8String;
import org.jetbrains.annotations.NotNull;

import java.nio.ByteBuffer;

/**
 * Builder base for a {@link Mqtt3SimpleAuth}.
 *
 * @param  the type of the complete builder.
 * @author Silvio Giebl
 * @since 1.0
 */
@DoNotImplement
public interface Mqtt3SimpleAuthBuilderBase> {

    /**
     * Sets the mandatory {@link Mqtt3SimpleAuth#getUsername() username}.
     *
     * @param username the username string.
     * @return the builder that is now complete as the mandatory username is set.
     */
    @CheckReturnValue
    @NotNull C username(@NotNull String username);

    /**
     * Sets the mandatory {@link Mqtt3SimpleAuth#getUsername() username}.
     *
     * @param username the username string.
     * @return the builder that is now complete as the mandatory username is set.
     */
    @CheckReturnValue
    @NotNull C username(@NotNull MqttUtf8String username);

    /**
     * {@link Mqtt3SimpleAuthBuilderBase} that is complete which means all mandatory fields are set.
     *
     * @param  the type of the complete builder.
     */
    @DoNotImplement
    interface Complete> extends Mqtt3SimpleAuthBuilderBase {

        /**
         * Sets the optional {@link Mqtt3SimpleAuth#getPassword() password}.
         *
         * @param password the password as byte array.
         * @return the builder.
         */
        @CheckReturnValue
        @NotNull C password(byte @NotNull [] password);

        /**
         * Sets the optional {@link Mqtt3SimpleAuth#getPassword() password}.
         *
         * @param password the password as {@link ByteBuffer}.
         * @return the builder.
         */
        @CheckReturnValue
        @NotNull C password(@NotNull ByteBuffer password);
    }
}