org.apache.pulsar.broker.service.Topic Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.pulsar.broker.service;
import io.netty.buffer.ByteBuf;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.apache.bookkeeper.mledger.Position;
import org.apache.pulsar.broker.service.persistent.DispatchRateLimiter;
import org.apache.pulsar.broker.service.persistent.SubscribeRateLimiter;
import org.apache.pulsar.broker.stats.ClusterReplicationMetrics;
import org.apache.pulsar.broker.stats.NamespaceStats;
import org.apache.pulsar.client.api.MessageId;
import org.apache.pulsar.client.api.transaction.TxnID;
import org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition;
import org.apache.pulsar.common.api.proto.CommandSubscribe.SubType;
import org.apache.pulsar.common.api.proto.KeySharedMeta;
import org.apache.pulsar.common.policies.data.BacklogQuota;
import org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType;
import org.apache.pulsar.common.policies.data.HierarchyTopicPolicies;
import org.apache.pulsar.common.policies.data.PersistentTopicInternalStats;
import org.apache.pulsar.common.policies.data.Policies;
import org.apache.pulsar.common.policies.data.stats.TopicStatsImpl;
import org.apache.pulsar.common.protocol.schema.SchemaData;
import org.apache.pulsar.common.protocol.schema.SchemaVersion;
import org.apache.pulsar.common.util.collections.ConcurrentOpenHashMap;
import org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats;
import org.apache.pulsar.utils.StatsOutputStream;
public interface Topic {
interface PublishContext {
default String getProducerName() {
return null;
}
default long getSequenceId() {
return -1L;
}
default void setOriginalProducerName(String originalProducerName) {
}
default void setOriginalSequenceId(long originalSequenceId) {
}
/**
* Return the producer name for the original producer.
*
* For messages published locally, this will return the same local producer name, though in case of replicated
* messages, the original producer name will differ
*/
default String getOriginalProducerName() {
return null;
}
default long getOriginalSequenceId() {
return -1L;
}
void completed(Exception e, long ledgerId, long entryId);
default void setMetadataFromEntryData(ByteBuf entryData) {
}
default long getHighestSequenceId() {
return -1L;
}
default void setOriginalHighestSequenceId(long originalHighestSequenceId) {
}
default long getOriginalHighestSequenceId() {
return -1L;
}
default long getNumberOfMessages() {
return 1L;
}
default boolean isMarkerMessage() {
return false;
}
default void setProperty(String propertyName, Object value) {
}
default Object getProperty(String propertyName) {
return null;
}
default boolean isChunked() {
return false;
}
}
CompletableFuture initialize();
void publishMessage(ByteBuf headersAndPayload, PublishContext callback);
/**
* Tries to add a producer to the topic. Several validations will be performed.
*
* @param producer
* @param producerQueuedFuture
* a future that will be triggered if the producer is being queued up prior of getting established
* @return the "topic epoch" if there is one or empty
*/
CompletableFuture> addProducer(Producer producer, CompletableFuture producerQueuedFuture);
void removeProducer(Producer producer);
/**
* Wait TransactionBuffer Recovers completely.
* Take snapshot after TB Recovers completely.
* @param isTxnEnabled
* @return a future which has completely if isTxn = false. Or a future return by takeSnapshot.
*/
CompletableFuture checkIfTransactionBufferRecoverCompletely(boolean isTxnEnabled);
/**
* record add-latency.
*/
void recordAddLatency(long latency, TimeUnit unit);
/**
* increase the publishing limited times.
*/
long increasePublishLimitedTimes();
@Deprecated
CompletableFuture subscribe(TransportCnx cnx, String subscriptionName, long consumerId, SubType subType,
int priorityLevel, String consumerName, boolean isDurable,
MessageId startMessageId,
Map metadata, boolean readCompacted,
InitialPosition initialPosition,
long startMessageRollbackDurationSec, boolean replicateSubscriptionState,
KeySharedMeta keySharedMeta);
/**
* Subscribe a topic.
* @param option
* @return
*/
CompletableFuture subscribe(SubscriptionOption option);
CompletableFuture createSubscription(String subscriptionName, InitialPosition initialPosition,
boolean replicateSubscriptionState, Map properties);
CompletableFuture unsubscribe(String subName);
ConcurrentOpenHashMap getSubscriptions();
CompletableFuture delete();
Map getProducers();
String getName();
CompletableFuture checkReplication();
CompletableFuture close(boolean closeWithoutWaitingClientDisconnect);
void checkGC();
void checkInactiveSubscriptions();
/**
* Activate cursors those caught up backlog-threshold entries and deactivate slow cursors which are creating
* backlog.
*/
void checkBackloggedCursors();
void checkDeduplicationSnapshot();
void checkMessageExpiry();
void checkMessageDeduplicationInfo();
void checkTopicPublishThrottlingRate();
void incrementPublishCount(int numOfMessages, long msgSizeInBytes);
void resetTopicPublishCountAndEnableReadIfRequired();
void resetBrokerPublishCountAndEnableReadIfRequired(boolean doneReset);
boolean isPublishRateExceeded();
boolean isTopicPublishRateExceeded(int msgSize, int numMessages);
boolean isResourceGroupRateLimitingEnabled();
boolean isResourceGroupPublishRateExceeded(int msgSize, int numMessages);
boolean isBrokerPublishRateExceeded();
void disableCnxAutoRead();
void enableCnxAutoRead();
CompletableFuture onPoliciesUpdate(Policies data);
CompletableFuture checkBacklogQuotaExceeded(String producerName, BacklogQuotaType backlogQuotaType);
boolean isEncryptionRequired();
boolean getSchemaValidationEnforced();
boolean isReplicated();
BacklogQuota getBacklogQuota(BacklogQuotaType backlogQuotaType);
void updateRates(NamespaceStats nsStats, NamespaceBundleStats currentBundleStats,
StatsOutputStream topicStatsStream, ClusterReplicationMetrics clusterReplicationMetrics,
String namespaceName, boolean hydratePublishers);
Subscription getSubscription(String subscription);
ConcurrentOpenHashMap getReplicators();
TopicStatsImpl getStats(boolean getPreciseBacklog, boolean subscriptionBacklogSize,
boolean getEarliestTimeInBacklog);
CompletableFuture asyncGetStats(boolean getPreciseBacklog,
boolean subscriptionBacklogSize,
boolean getEarliestTimeInBacklog);
CompletableFuture getInternalStats(boolean includeLedgerMetadata);
Position getLastPosition();
CompletableFuture getLastMessageId();
/**
* Whether a topic has had a schema defined for it.
*/
CompletableFuture hasSchema();
/**
* Add a schema to the topic. This will fail if the new schema is incompatible with the current
* schema.
*/
CompletableFuture addSchema(SchemaData schema);
/**
* Delete the schema if this topic has a schema defined for it.
*/
CompletableFuture deleteSchema();
/**
* Check if schema is compatible with current topic schema.
*/
CompletableFuture checkSchemaCompatibleForConsumer(SchemaData schema);
/**
* If the topic is idle (no producers, no entries, no subscribers and no existing schema),
* add the passed schema to the topic. Otherwise, check that the passed schema is compatible
* with what the topic already has.
*/
CompletableFuture addSchemaIfIdleOrCheckCompatible(SchemaData schema);
CompletableFuture deleteForcefully();
default Optional getDispatchRateLimiter() {
return Optional.empty();
}
default Optional getSubscribeRateLimiter() {
return Optional.empty();
}
default Optional getBrokerDispatchRateLimiter() {
return Optional.empty();
}
default boolean isSystemTopic() {
return false;
}
boolean isPersistent();
/* ------ Transaction related ------ */
/**
* Publish Transaction message to this Topic's TransactionBuffer.
*
* @param txnID Transaction Id
* @param headersAndPayload Message data
* @param publishContext Publish context
*/
void publishTxnMessage(TxnID txnID, ByteBuf headersAndPayload, PublishContext publishContext);
/**
* End the transaction in this topic.
*
* @param txnID Transaction id
* @param txnAction Transaction action.
* @param lowWaterMark low water mark of this tc
* @return
*/
CompletableFuture endTxn(TxnID txnID, int txnAction, long lowWaterMark);
/**
* Truncate a topic.
* The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.
* @return
*/
CompletableFuture truncate();
/**
* Get BrokerService.
* @return
*/
BrokerService getBrokerService();
/**
* Get HierarchyTopicPolicies.
* @return
*/
HierarchyTopicPolicies getHierarchyTopicPolicies();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy