com.hivemq.spi.services.SharedSubscriptionService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation
The Service Provider Interfaces for developing HiveMQ plugins.
There is a newer version: 3.4.4
/*
 * Copyright 2015 dc-square GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.spi.services;

import com.hivemq.spi.annotations.NotNull;
import com.hivemq.spi.annotations.ReadOnly;
import com.hivemq.spi.annotations.ThreadSafe;

import java.util.List;

/**
 * A service which allows read, add and remove shared subscriptions.
 * 
 * All implementations of the SharedSubscriptionService are guaranteed to be thread safe.
 *
 * @author Dominik Obermaier
 * @since 3.0
 * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
 * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
 * See the HiveMQ documentation about shared subscriptions for more detailed information.
 */
@ThreadSafe
@Deprecated
public interface SharedSubscriptionService {

    /**
     * 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.
     *
     * @param sharedSubscriptions the shared subscriptions to add
     * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
     * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
     * See the HiveMQ documentation about shared subscriptions for more detailed information.
     */
    @Deprecated
    void addSharedSubscriptions(@NotNull final String... sharedSubscriptions);

    /**
     * Returns true if shared subscriptions are available, false otherwise
     *
     * @return true if shared subscriptions are available, false otherwise
     * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
     * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
     * See the HiveMQ documentation about shared subscriptions for more detailed information.
     */
    @Deprecated
    boolean sharedSubscriptionsAvailable();


    /**
     * 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.
     *
     * @param sharedSubscription the shared subscription to remove
     * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
     * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
     * See the HiveMQ documentation about shared subscriptions for more detailed information.
     */
    @Deprecated
    void removeSharedSubscription(@NotNull final String sharedSubscription);

    /**
     * Returns all shared subscriptions. The returned List is read-only representation
     * of all shared subscriptions
     *
     * @return a read-only List of all shared subscriptions
     * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
     * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
     * See the HiveMQ documentation about shared subscriptions for more detailed information.
     */
    @ReadOnly
    @Deprecated
    List getSharedSubscriptions();

    /**
     * Returns the number of all shared subscriptions.
     *
     * @return the number of all shared subscriptions
     * @deprecated Since 3.1 Shared subscriptions are created by using a specific marker in the topic.
     * Use {@link BlockingSubscriptionStore} or {@link AsyncSubscriptionStore} to create such subscriptions.
     * See the HiveMQ documentation about shared subscriptions for more detailed information.
     */
    @Deprecated
    long getSharedSubscriptionsSize();
}