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

Interface TopicSubscriptionBuilder

@DoNotImplement
public interface TopicSubscriptionBuilder

This builder must be used to create a TopicSubscription.

Either from values or from a Subscription.

Every TopicSubscription 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 TopicSubscription	build()	Builds the TopicSubscription with the provided values or default values.
@NotNull TopicSubscriptionBuilder	fromSubscription(@NotNull Subscription subscription)	Create a TopicSubscription from the values of a Subscription.
@NotNull TopicSubscriptionBuilder	noLocal(boolean noLocal)	Sets the no local flag.
@NotNull TopicSubscriptionBuilder	qos(@NotNull Qos qos)	Sets the quality of service level.
@NotNull TopicSubscriptionBuilder	retainAsPublished(boolean retainAsPublished)	Sets the retain as published flag.
@NotNull TopicSubscriptionBuilder	subscriptionIdentifier(int subscriptionIdentifier)	Sets the subscription identifier.
@NotNull TopicSubscriptionBuilder	topicFilter(@NotNull String topicFilter)	Sets the topic filter.

Method Details

fromSubscription

@NotNull @NotNull TopicSubscriptionBuilder fromSubscription(@NotNull Subscription subscription)

Create a TopicSubscription from the values of a Subscription.

Parameters:

subscription - The subscription to build a TopicSubscription from.

Returns:

The TopicSubscriptionBuilder.

Throws:

NullPointerException - If the subscription is null.

DoNotImplementException - If the Subscription is implemented by the extension.

Since:

4.0.0, CE 2019.1

topicFilter

@NotNull @NotNull TopicSubscriptionBuilder topicFilter(@NotNull String topicFilter)

Sets the topic filter.

This value has no default and must be set.

Parameters:

topicFilter - The topic filter to set.

Returns:

The TopicSubscriptionBuilder.

Throws:

NullPointerException - If the topic filter is null.

IllegalArgumentException - If the topic filter is empty.

IllegalArgumentException - If the topic filter contains invalid UTF-8 characters.

IllegalArgumentException - If the topic filter is longer than the configured maximum. Default maximum length is 65535.

IllegalArgumentException - If the topic filter contains a wildcard and wildcards are disabled by HiveMQ. Default is enabled.

IllegalArgumentException - If the topic filter is a shared subscription and shared subscriptions are disabled by HiveMQ. Default is enabled.

Since:

4.0.0, CE 2019.1

qos

@NotNull @NotNull TopicSubscriptionBuilder qos(@NotNull Qos qos)

Sets the quality of service level.

DEFAULT: QoS 0.

Parameters:

qos - The Qos to set.

Returns:

The TopicSubscriptionBuilder.

Throws:

NullPointerException - If qos is null.

Since:

4.0.0, CE 2019.1

retainAsPublished

@NotNull @NotNull TopicSubscriptionBuilder retainAsPublished(boolean retainAsPublished)

Sets the retain as published flag.

DEFAULT: false.

Parameters:

retainAsPublished - The retain as published flag to set.

Returns:

The TopicSubscriptionBuilder.

Since:

4.0.0, CE 2019.1

noLocal

@NotNull @NotNull TopicSubscriptionBuilder noLocal(boolean noLocal)

Sets the no local flag. Do not set the no local flag to true if the TopicSubscription is a shared subscription.

DEFAULT: false.

Parameters:

noLocal - The no local flag to set.

Returns:

The TopicSubscriptionBuilder.

Since:

4.0.0, CE 2019.1

subscriptionIdentifier

@NotNull @NotNull TopicSubscriptionBuilder subscriptionIdentifier(int subscriptionIdentifier)

Sets the subscription identifier.

DEFAULT: null.

Parameters:

subscriptionIdentifier - The subscription identifier to set.

Returns:

The TopicSubscriptionBuilder.

Throws:

IllegalArgumentException - If the subscription identifier is zero or greater than the protocol limit (268435455).

IllegalArgumentException - If the subscription identifier are disabled by HiveMQ. Default is enabled.

Since:

4.0.0, CE 2019.1

build

@NotNull @NotNull TopicSubscription build()

Builds the TopicSubscription with the provided values or default values.

Returns:

A TopicSubscription with the set parameters.

Throws:

NullPointerException - If the topic filter is null.

IllegalArgumentException - If the noLocal flag is set for a shared subscription.

Since:

4.0.0, CE 2019.1