com.hivemq.client.mqtt.mqtt5.message.connect

Interface Mqtt5ConnectBuilderBase<B extends Mqtt5ConnectBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

Mqtt5ConnectBuilder, Mqtt5ConnectBuilder.Nested<P>, Mqtt5ConnectBuilder.Send<P>

@DoNotImplement
public interface Mqtt5ConnectBuilderBase<B extends Mqtt5ConnectBuilderBase<B>>

Builder base for a Mqtt5Connect.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
B	cleanStart(boolean cleanStart) Sets whether the client starts a clean session.
B	enhancedAuth(@Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism) Sets the enhanced authentication and/or authorization mechanism.
B	keepAlive(int keepAlive) Sets the keep alive in seconds.
B	noKeepAlive() Disables the keep alive by setting it to Mqtt5Connect.NO_KEEP_ALIVE.
B	noSessionExpiry() Disables the session expiry by setting it to Mqtt5Connect.NO_SESSION_EXPIRY.
Mqtt5ConnectRestrictionsBuilder.Nested<? extends B>	restrictions() Fluent counterpart of restrictions(Mqtt5ConnectRestrictions).
B	restrictions(@NotNull Mqtt5ConnectRestrictions restrictions) Sets the restrictions from the client.
B	sessionExpiryInterval(long sessionExpiryInterval) Sets the session expiry interval in seconds.
Mqtt5SimpleAuthBuilder.Nested<? extends B>	simpleAuth() Fluent counterpart of simpleAuth(Mqtt5SimpleAuth).
B	simpleAuth(@Nullable Mqtt5SimpleAuth simpleAuth) Sets the optional simple authentication and/or authorization related data.
Mqtt5UserPropertiesBuilder.Nested<? extends B>	userProperties() Fluent counterpart of userProperties(Mqtt5UserProperties).
B	userProperties(@NotNull Mqtt5UserProperties userProperties) Sets the User Properties.
Mqtt5WillPublishBuilder.Nested<? extends B>	willPublish() Fluent counterpart of willPublish(Mqtt5Publish).
B	willPublish(@Nullable Mqtt5Publish willPublish) Sets the optional Will Publish.

Method Detail

keepAlive

@CheckReturnValue
 @NotNull
B keepAlive(int keepAlive)

Sets the keep alive in seconds.

The value must be in the range of an unsigned short: [0, 65_535].

Parameters:

keepAlive - the keep alive in seconds.

Returns:

the builder.

noKeepAlive

@CheckReturnValue
 @NotNull
B noKeepAlive()

Disables the keep alive by setting it to Mqtt5Connect.NO_KEEP_ALIVE.

Returns:

the builder.

cleanStart

@CheckReturnValue
 @NotNull
B cleanStart(boolean cleanStart)

Sets whether the client starts a clean session.

Parameters:

cleanStart - whether the client starts a clean session.

Returns:

the builder.

sessionExpiryInterval

@CheckReturnValue
 @NotNull
B sessionExpiryInterval(long sessionExpiryInterval)

Sets the session expiry interval in seconds.

The value must be in the range of an unsigned int: [0, 4_294_967_295].

Parameters:

sessionExpiryInterval - the session expiry interval in seconds.

Returns:

the builder.

noSessionExpiry

@CheckReturnValue
 @NotNull
B noSessionExpiry()

Disables the session expiry by setting it to Mqtt5Connect.NO_SESSION_EXPIRY.

Returns:

the builder.

restrictions

@CheckReturnValue
 @NotNull
B restrictions(@NotNull
                                           @NotNull Mqtt5ConnectRestrictions restrictions)

Sets the restrictions from the client.

Parameters:

restrictions - the restrictions from the client.

Returns:

the builder.

restrictions

@CheckReturnValue
Mqtt5ConnectRestrictionsBuilder.Nested<? extends B> restrictions()

Fluent counterpart of restrictions(Mqtt5ConnectRestrictions).

Calling Mqtt5ConnectRestrictionsBuilder.Nested.applyRestrictions() on the returned builder has the effect of extending the current restrictions.

Returns:

the fluent builder for the restrictions.

See Also:

restrictions(Mqtt5ConnectRestrictions)

simpleAuth

@CheckReturnValue
 @NotNull
B simpleAuth(@Nullable
                                         @Nullable Mqtt5SimpleAuth simpleAuth)

Sets the optional simple authentication and/or authorization related data.

Parameters:

simpleAuth - the simple auth related data or null to remove any previously set simple auth related data.

Returns:

the builder.

simpleAuth

@CheckReturnValue
Mqtt5SimpleAuthBuilder.Nested<? extends B> simpleAuth()

Fluent counterpart of simpleAuth(Mqtt5SimpleAuth).

Calling Mqtt5SimpleAuthBuilder.Nested.Complete#applySimpleAuth() on the returned builder has the same effect as calling simpleAuth(Mqtt5SimpleAuth) with the result of Mqtt5SimpleAuthBuilder.Complete#build().

Returns:

the fluent builder for the simple auth related data.

See Also:

simpleAuth(Mqtt5SimpleAuth)

enhancedAuth

@CheckReturnValue
 @NotNull
B enhancedAuth(@Nullable
                                           @Nullable Mqtt5EnhancedAuthMechanism enhancedAuthMechanism)

Sets the enhanced authentication and/or authorization mechanism.

Parameters:

enhancedAuthMechanism - the enhanced auth mechanism or null to remove any previously set enhanced auth mechanism.

Returns:

the builder.

willPublish

@CheckReturnValue
 @NotNull
B willPublish(@Nullable
                                          @Nullable Mqtt5Publish willPublish)

Sets the optional Will Publish.

Parameters:

willPublish - the Will Publish or null to remove any previously set Will Publish.

Returns:

the builder.

willPublish

@CheckReturnValue
Mqtt5WillPublishBuilder.Nested<? extends B> willPublish()

Fluent counterpart of willPublish(Mqtt5Publish).

Calling Mqtt5WillPublishBuilder.Nested.Complete#applyWillPublish() on the returned builder has the same effect as calling willPublish(Mqtt5Publish) with the result of Mqtt5WillPublishBuilder.Complete#build().

Returns:

the fluent builder for the Will Publish.

See Also:

willPublish(Mqtt5Publish)

userProperties

@CheckReturnValue
 @NotNull
B userProperties(@NotNull
                                             @NotNull Mqtt5UserProperties userProperties)

Sets the User Properties.

Parameters:

userProperties - the User Properties.

Returns:

the builder.

userProperties

@CheckReturnValue
Mqtt5UserPropertiesBuilder.Nested<? extends B> 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)