Package com.hivemq.client.mqtt.mqtt5.message.auth

Interface Mqtt5AuthBuilder

All Superinterfaces:

Mqtt5EnhancedAuthBuilder

@DoNotImplement
public interface Mqtt5AuthBuilder
extends Mqtt5EnhancedAuthBuilder

Builder for a Mqtt5Auth.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5AuthBuilder	data(byte @Nullable [] data)	Sets the optional auth data.
@NotNull Mqtt5AuthBuilder	data(@Nullable ByteBuffer data)	Sets the optional auth data.
@NotNull Mqtt5AuthBuilder	reasonString(@Nullable MqttUtf8String reasonString)	Sets the optional Reason String.
@NotNull Mqtt5AuthBuilder	reasonString(@Nullable String reasonString)	Sets the optional Reason String.
@NotNull Mqtt5UserPropertiesBuilder.Nested<? extends Mqtt5AuthBuilder>	userProperties()	Fluent counterpart of userProperties(Mqtt5UserProperties).
@NotNull Mqtt5AuthBuilder	userProperties(@NotNull Mqtt5UserProperties userProperties)	Sets the User Properties.

Method Details

data

@NotNull
@NotNull Mqtt5AuthBuilder data(byte @Nullable [] data)

Description copied from interface: Mqtt5EnhancedAuthBuilder

Sets the optional auth data.

Specified by:

data in interface Mqtt5EnhancedAuthBuilder

Parameters:

data - the auth data as byte array or null to remove any previously set auth data.

Returns:

the builder.

data

@NotNull
@NotNull Mqtt5AuthBuilder data(@Nullable
 @Nullable ByteBuffer data)

Description copied from interface: Mqtt5EnhancedAuthBuilder

Sets the optional auth data.

Specified by:

data in interface Mqtt5EnhancedAuthBuilder

Parameters:

data - the auth data as ByteBuffer or null to remove any previously set auth data.

Returns:

the builder.

reasonString

@NotNull
@NotNull Mqtt5AuthBuilder reasonString(@Nullable
 @Nullable String reasonString)

Sets the optional Reason String.

Parameters:

reasonString - the reason string or null to remove any previously set Reason String.

Returns:

the builder.

reasonString

@NotNull
@NotNull Mqtt5AuthBuilder reasonString(@Nullable
 @Nullable MqttUtf8String reasonString)

Sets the optional Reason String.

Parameters:

reasonString - the reason string or null to remove any previously set Reason String.

Returns:

the builder.

userProperties

@NotNull
@NotNull Mqtt5AuthBuilder userProperties(@NotNull
 @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
@NotNull Mqtt5UserPropertiesBuilder.Nested<? extends Mqtt5AuthBuilder> userProperties()

Fluent counterpart of userProperties(Mqtt5UserProperties).

Calling Mqtt5UserPropertiesBuilder.Nested.applyUserProperties() on the returned builder has the effect of extending the current User Properties.

Returns:

the fluent builder for the User Properties.

See Also:

• userProperties(Mqtt5UserProperties)