com.hivemq.spi.services

Interface SharedSubscriptionService

Deprecated.

Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

@ThreadSafe
@Deprecated
public interface SharedSubscriptionService

A service which allows read, add and remove shared subscriptions.

All implementations of the SharedSubscriptionService are guaranteed to be thread safe.

Since:

3.0

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
void	addSharedSubscriptions(String... sharedSubscriptions) Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.
List<String>	getSharedSubscriptions() Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.
long	getSharedSubscriptionsSize() Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.
void	removeSharedSubscription(String sharedSubscription) Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.
boolean	sharedSubscriptionsAvailable() Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Method Detail

addSharedSubscriptions

@Deprecated
void addSharedSubscriptions(@NotNull
                                     String... sharedSubscriptions)

Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Adds shared subscriptions to the SharedSubscriptionService.

Although the contract of this method is to disallow null values, this method is lenient. If null values are passed, these values are ignored.

Parameters:

sharedSubscriptions - the shared subscriptions to add

sharedSubscriptionsAvailable

@Deprecated
boolean sharedSubscriptionsAvailable()

Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Returns true if shared subscriptions are available, false otherwise

Returns:

true if shared subscriptions are available, false otherwise

removeSharedSubscription

@Deprecated
void removeSharedSubscription(@NotNull
                                       String sharedSubscription)

Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Removes a shared subscription from the SharedSubscriptionService.

Although the contract of this method is to disallow null values, this method is lenient. If a null value is passed, the value is ignored.

Parameters:

sharedSubscription - the shared subscription to remove

getSharedSubscriptions

@ReadOnly
@Deprecated
List<String> getSharedSubscriptions()

Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Returns all shared subscriptions. The returned List is read-only representation of all shared subscriptions

Returns:

a read-only List of all shared subscriptions

getSharedSubscriptionsSize

@Deprecated
long getSharedSubscriptionsSize()

Deprecated. Since 3.1 Shared subscriptions are created by using a specific marker in the topic. Use BlockingSubscriptionStore or AsyncSubscriptionStore to create such subscriptions. See the HiveMQ documentation about shared subscriptions for more detailed information.

Returns the number of all shared subscriptions.

Returns:

the number of all shared subscriptions