Package com.hivemq.extension.sdk.api.services.builder

Interface WillPublishBuilder

@DoNotImplement
public interface WillPublishBuilder

This builder must be used to create a WillPublishPacket.

Either from values,from a PublishPacket, from a Publish or from a WillPublishPacket.

Every WillPublishPacket built by this builder is fully validated against HiveMQ configuration.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
@NotNull WillPublishPacket	build()	Builds the WillPublishPacket with the provided values or default values.
@NotNull WillPublishBuilder	contentType(@Nullable String contentType)	Sets the content type.
@NotNull WillPublishBuilder	correlationData(@Nullable ByteBuffer correlationData)	Sets the correlation data.
@NotNull WillPublishBuilder	fromPublish(@NotNull PublishPacket publishPacket)	Create a WillPublishPacket from the values of a PublishPacket.
@NotNull WillPublishBuilder	fromPublish(@NotNull Publish publish)	Create a WillPublishPacket from the values of a Publish.
@NotNull WillPublishBuilder	fromWillPublish(@NotNull WillPublishPacket willPublishPacket)	Create a WillPublishPacket from the values of another WillPublishPacket.
@NotNull WillPublishBuilder	messageExpiryInterval(long messageExpiryInterval)	Sets the message expiry interval in seconds.
@NotNull WillPublishBuilder	payload(@NotNull ByteBuffer payload)	Sets the payload.
@NotNull WillPublishBuilder	payloadFormatIndicator(@Nullable PayloadFormatIndicator payloadFormatIndicator)	Sets the payload format indicator.
@NotNull WillPublishBuilder	qos(@NotNull Qos qos)	Sets the quality of service level.
@NotNull WillPublishBuilder	responseTopic(@Nullable String responseTopic)	Sets the response topic.
@NotNull WillPublishBuilder	retain(boolean retain)	Sets the retain flag.
@NotNull WillPublishBuilder	topic(@NotNull String topic)	Sets the topic.
@NotNull WillPublishBuilder	userProperty(@NotNull String key, @NotNull String value)	Adds a user property.
@NotNull WillPublishBuilder	willDelay(long willDelay)	Sets the will delay.

Method Details

fromPublish

@NotNull @NotNull WillPublishBuilder fromPublish(@NotNull PublishPacket publishPacket)

Create a WillPublishPacket from the values of a PublishPacket.

Parameters:

publishPacket - The publish packet to build a WillPublishPacket from.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the publish packet is null.

DoNotImplementException - If the PublishPacket is implemented by the extension.

Since:

4.0.0, CE 2019.1

fromPublish

@NotNull @NotNull WillPublishBuilder fromPublish(@NotNull Publish publish)

Create a WillPublishPacket from the values of a Publish.

Parameters:

publish - The publish to build a WillPublishPacket from.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the publish is null.

DoNotImplementException - If the Publish is implemented by the extension.

Since:

4.0.0, CE 2019.1

fromWillPublish

@NotNull @NotNull WillPublishBuilder fromWillPublish(@NotNull WillPublishPacket willPublishPacket)

Create a WillPublishPacket from the values of another WillPublishPacket.

Parameters:

willPublishPacket - The will publish packet to build a WillPublishPacket from.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the will publish packet is null.

DoNotImplementException - If the WillPublishPacket is implemented by the extension.

Since:

4.0.0, CE 2019.1

qos

@NotNull @NotNull WillPublishBuilder qos(@NotNull Qos qos)

Sets the quality of service level.

DEFAULT: QoS 0.

Parameters:

qos - The Qos to set.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the qos is null.

IllegalArgumentException - If qos is higher than the maximum configured qos by HiveMQ. Default is QoS 2.

Since:

4.0.0, CE 2019.1

retain

@NotNull @NotNull WillPublishBuilder retain(boolean retain)

Sets the retain flag.

DEFAULT: false.

Parameters:

retain - The retain flag to set.

Returns:

The WillPublishBuilder.

Throws:

IllegalArgumentException - If retain is true, but retained messages are disabled by HiveMQ.

Since:

4.0.0, CE 2019.1

topic

@NotNull @NotNull WillPublishBuilder topic(@NotNull String topic)

Sets the topic.

This value has no default and must be set.

Parameters:

topic - The topic to set.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the topic is null.

IllegalArgumentException - If the topic is an empty string.

IllegalArgumentException - If the topic is invalid for publish messages (i.e containing wildcards}.

IllegalArgumentException - If the topic length exceeds the configured length for topics. Default is 65535.

Since:

4.0.0, CE 2019.1

payloadFormatIndicator

@NotNull @NotNull WillPublishBuilder payloadFormatIndicator(@Nullable PayloadFormatIndicator payloadFormatIndicator)

Sets the payload format indicator.

DEFAULT: null.

Parameters:

payloadFormatIndicator - The payload format indicator to set.

Returns:

The WillPublishBuilder.

Since:

4.0.0, CE 2019.1

messageExpiryInterval

@NotNull @NotNull WillPublishBuilder messageExpiryInterval(long messageExpiryInterval)

Sets the message expiry interval in seconds.

DEFAULT: no expiry.

The default can be changed by configuring <message-expiry> in the <mqtt> config in the config.xml.

Parameters:

messageExpiryInterval - The message expiry interval to set.

Returns:

The WillPublishBuilder.

Throws:

IllegalArgumentException - If the message expiry interval is less than zero or more than the configured maximum by HiveMQ. Default is no expiry.

Since:

4.0.0, CE 2019.1

responseTopic

@NotNull @NotNull WillPublishBuilder responseTopic(@Nullable String responseTopic)

Sets the response topic.

DEFAULT: null.

Parameters:

responseTopic - The response topic to set.

Returns:

The WillPublishBuilder.

Throws:

IllegalArgumentException - If the response topic is not a valid UTF-8 string.

IllegalArgumentException - If the response topic exceeds the UTF-8 string length limit.

Since:

4.0.0, CE 2019.1

correlationData

@NotNull @NotNull WillPublishBuilder correlationData(@Nullable ByteBuffer correlationData)

Sets the correlation data.

DEFAULT: null.

Parameters:

correlationData - The correlation data to set.

Returns:

The WillPublishBuilder.

Since:

4.0.0, CE 2019.1

contentType

@NotNull @NotNull WillPublishBuilder contentType(@Nullable String contentType)

Sets the content type.

DEFAULT: null.

Parameters:

contentType - The content type to set.

Returns:

The WillPublishBuilder.

Throws:

IllegalArgumentException - If the content type is not a valid UTF-8 string.

IllegalArgumentException - If the content type exceeds the UTF-8 string length limit.

Since:

4.0.0, CE 2019.1

payload

@NotNull @NotNull WillPublishBuilder payload(@NotNull ByteBuffer payload)

Sets the payload.

This value has no default and must be set.

Parameters:

payload - The payload to set.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the payload is null.

Since:

4.0.0, CE 2019.1

userProperty

@NotNull @NotNull WillPublishBuilder userProperty(@NotNull String key, @NotNull String value)

Adds a user property.

DEFAULT: empty list.

Parameters:

key - The key of the user property to add.

value - The value of the user property to add.

Returns:

The WillPublishBuilder.

Throws:

NullPointerException - If the key or the value is null.

IllegalArgumentException - If the key or value is not a valid UTF-8 string.

IllegalArgumentException - If the key or value exceeds the UTF-8 string length limit.

Since:

4.0.0, CE 2019.1

willDelay

@NotNull @NotNull WillPublishBuilder willDelay(long willDelay)

Sets the will delay.

DEFAULT: 0.

Parameters:

willDelay - The will dely to set.

Returns:

The WillPublishBuilder.

Throws:

IllegalArgumentException - If the will delay is less than zero.

Since:

4.0.0, CE 2019.1

build

@NotNull @NotNull WillPublishPacket build()

Builds the WillPublishPacket with the provided values or default values.

Returns:

A WillPublishPacket with the set parameters.

Throws:

NullPointerException - If the topic or the payload is null.

Since:

4.0.0, CE 2019.1