com.tangosol.net.PagedTopicService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.09
/*
 * Copyright (c) 2000, 2023, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * https://oss.oracle.com/licenses/upl.
 */

package com.tangosol.net;

import com.tangosol.internal.net.topic.impl.paged.PagedTopicBackingMapManager;

import com.tangosol.internal.net.topic.impl.paged.PagedTopicDependencies;
import com.tangosol.internal.net.topic.impl.paged.model.PagedTopicSubscription;
import com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId;
import com.tangosol.internal.net.topic.impl.paged.model.SubscriberId;

import com.tangosol.internal.net.topic.impl.paged.statistics.PagedTopicStatistics;
import com.tangosol.net.topic.Subscriber;

import com.tangosol.net.topic.TopicBackingMapManager;

import com.tangosol.util.Filter;
import com.tangosol.util.ValueExtractor;

import java.util.Set;

/**
 * A {@link TopicService} which provides globally ordered topics.
 */
public interface PagedTopicService
        extends TopicService, DistributedCacheService
    {
    /**
     * Return the {@link TopicBackingMapManager} for this service.
     *
     * @return the {@link TopicBackingMapManager} for this service
     */
    PagedTopicBackingMapManager getTopicBackingMapManager();

    /**
     * Ensure the specified subscriber group is created in a subscription.
     *
     * @param sTopicName  the name of the topic
     * @param sGroupName  the name of the subscriber group
     *
     * @return  the unique identifier of the subscriber group or {@code -1} if
     *          the cluster is not version compatible and cannot create
     *          subscriptions
     */
    default long ensureSubscriberGroup(String sTopicName, String sGroupName)
        {
        return ensureSubscriberGroup(sTopicName, sGroupName, null, null);
        }

    /**
     * Ensure the specified subscriber group is created in a subscription.
     *
     * @param sTopicName  the name of the topic
     * @param sGroupName  the name of the subscriber group
     * @param filter      the {@link Filter} to use to filter messages sent to subscribers
     * @param extractor   the {@link ValueExtractor} to use to convert messages sent to subscribers
     *
     * @return  the unique identifier of the subscriber group or {@code -1} if
     *          the cluster is not version compatible and cannot create
     *          subscriptions
     */
    default long ensureSubscriberGroup(String sTopicName, String sGroupName, Filter filter, ValueExtractor extractor)
        {
        return ensureSubscription(sTopicName, SubscriberGroupId.withName(sGroupName),
                SubscriberId.NullSubscriber, filter, extractor);
        }

    /**
     * Destroy an existing subscriber group.
     *
     * @param sTopicName    the name of the topic
     * @param sGroupName    the name of the subscriber group
     */
    void destroySubscriberGroup(String sTopicName, String sGroupName);

    /**
     * Ensure the specified subscriber is created in a subscription.
     *
     * @param sTopicName    the name of the topic
     * @param groupId       the {@link SubscriberGroupId id} of the subscriber group
     * @param subscriberId  the {@link Subscriber.Id}
     * @param filter        the {@link Filter} to use to filter messages sent to subscribers
     * @param extractor     the {@link ValueExtractor} to use to convert messages sent to subscribers
     *
     * @return  the unique identifier of the subscriber group the {@link Subscriber}
     *          is subscribed to, of {@code -1} if the cluster is not version
     *          compatible and cannot create subscriptions
     */
    long ensureSubscription(String sTopicName, SubscriberGroupId groupId, Subscriber.Id subscriberId,
                            Filter filter, ValueExtractor extractor);

    /**
     * Ensure the specified subscriber is subscribed to a subscription.
     *
     * @param sTopicName     the name of the topic
     * @param lSubscription  the unique id of the subscriber group
     * @param subscriberId   the {@link Subscriber.Id}
     */
    void ensureSubscription(String sTopicName, long lSubscription, Subscriber.Id subscriberId);

    /**
     * Remove an existing subscriber from a subscriber group.
     *
     * @param lSubscriptionId  the subscription identifier
     * @param subscriberId     the {@link Subscriber.Id}
     */
    void destroySubscription(long lSubscriptionId, Subscriber.Id subscriberId);

    /**
     * Remove an existing subscriber group.
     *
     * @param lSubscriptionId  the subscription identifier
     */
    void destroySubscription(long lSubscriptionId);

    /**
     * Determine whether a subscriber group exists.
     *
     * @param lSubscriptionId  the id of the subscription to return
     *
     * @return  {@code true} if the group exists
     */
    boolean hasSubscription(long lSubscriptionId);

    /**
     * Determine whether a subscriber group has been destroyed.
     *
     * @param lSubscriptionId  the unique identifier of the subscriber group
     *
     * @return  {@code true} if the group has been destroyed
     */
    boolean isSubscriptionDestroyed(long lSubscriptionId);

    /**
     * Return a {@link PagedTopicSubscription}.
     *
     * @param lSubscriptionId  the id of the subscription to return
     *
     * @return the specified {@link PagedTopicSubscription} or {@code null}
     *         if the subscription does not exist.
     */
    PagedTopicSubscription getSubscription(long lSubscriptionId);

    /**
     * Return the subscription id for a subscriber group.
     *
     * @param sTopicName  the name of the topic
     * @param groupId     the {@link SubscriberGroupId identifier} for the subscriber group
     *
     * @return the subscription id for a subscriber group or zero
     *         if the subscription does not exist.
     */
    long getSubscriptionId(String sTopicName, SubscriberGroupId groupId);

    /**
     * Returns the {@link PagedTopicStatistics} for a topic.
     *
     * @param sTopicName  the name of the topic
     *
     * @return the {@link PagedTopicStatistics} for the topic or {@code null}
     *         if no statistics exist for the topic
     */
    PagedTopicStatistics getTopicStatistics(String sTopicName);

    /**
     * Returns the {@link SubscriberGroupId subscriber groups} for a topic
     * known to this service.
     *
     * @return the {@link SubscriberGroupId subscriber groups} for a topic
     *         known to this service
     */
    Set getSubscriberGroups(String sTopicName);

    /**
     * Returns the {@link SubscriberId subscriber ids} known to this service and
     * subscribed to a subscriber group for a topic
     * .
     *
     * @return the {@link SubscriberId subscriber ids} known to this service and
     *         subscribed to a subscriber group for a topic
     */
    Set getSubscribers(String sTopicName, SubscriberGroupId groupId);
    }