Package org.apache.pulsar.broker.service.persistent

Class SystemTopic

java.lang.Object

org.apache.pulsar.broker.service.AbstractTopic

org.apache.pulsar.broker.service.persistent.PersistentTopic

org.apache.pulsar.broker.service.persistent.SystemTopic

All Implemented Interfaces:

AsyncCallbacks.AddEntryCallback, Topic, TopicPolicyListener

public class SystemTopic
extends PersistentTopic

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pulsar.broker.service.Topic

Topic.PublishContext

Field Summary

Fields inherited from class org.apache.pulsar.broker.service.persistent.PersistentTopic

DEDUPLICATION_CURSOR_NAME, ledger, MESSAGE_RATE_BACKOFF_MS, messageDeduplication, msgChunkPublished, transactionBuffer

Fields inherited from class org.apache.pulsar.broker.service.AbstractTopic

addEntryLatencyStatsUsec, additionalSystemCursorNames, brokerService, bytesOutFromRemovedSubscriptions, bytesOutFromRemovedSystemSubscriptions, clock, entryFilters, hasBatchMessagePublished, isAllowAutoUpdateSchema, isEncryptionRequired, isFenced, lastActive, lock, msgOutFromRemovedSubscriptions, preciseTopicPublishRateLimitingEnable, producers, publishRateLimitedTimes, replicatorPrefix, resourceGroupPublishLimiter, resourceGroupRateLimitingEnabled, topic, topicEpoch, topicPolicies, topicPublishRateLimiter, totalPublishRateLimitedCounter, transferring, userCreatedProducerCount

Constructor Summary

Constructors

Constructor	Description
SystemTopic(String topic, ManagedLedger ledger, BrokerService brokerService)

Method Summary

Modifier and Type	Method	Description
void	checkGC()
void	checkMessageExpiry()
CompletableFuture<Void>	checkReplication()
CompletableFuture<Boolean>	checkTimeBacklogExceeded(boolean shouldUpdateOldPositionInfo)
Optional<DispatchRateLimiter>	getBrokerDispatchRateLimiter()
PublishRateLimiter	getBrokerPublishRateLimiter()
List<EntryFilter>	getEntryFilters()
org.apache.pulsar.common.policies.data.EntryFilters	getEntryFiltersPolicy()
boolean	isCompactionEnabled()
boolean	isDeduplicationEnabled()	Indicate if the current topic enabled server side deduplication.
boolean	isDeleteWhileInactive()
boolean	isEncryptionRequired()
boolean	isSizeBacklogExceeded()
boolean	isSystemTopic()
void	updateResourceGroupLimiter(org.apache.pulsar.common.policies.data.Policies namespacePolicies)

Methods inherited from class org.apache.pulsar.broker.service.persistent.PersistentTopic

addComplete, addFailed, addProducer, addReplicationCluster, addSchemaIfIdleOrCheckCompatible, addShadowReplicationCluster, asyncGetStats, asyncGetStats, asyncReadEntry, checkBackloggedCursors, checkBacklogQuotaExceeded, checkClusterMigration, checkCompaction, checkCursorsToCacheEntries, checkDeduplicationSnapshot, checkDeduplicationStatus, checkIfTransactionBufferRecoverCompletely, checkInactiveLedgers, checkInactiveSubscriptions, checkInactiveSubscriptions, checkMessageDeduplicationInfo, checkReplicatedSubscriptionControllerState, checkSubscriptionTypesEnable, clearBacklog, clearBacklog, close, close, close, compactionStatus, createSubscription, delete, deleteForcefully, deleteSchema, endTxn, getBacklogQuota, getBacklogSize, getBestEffortOldestUnacknowledgedMessageAgeSeconds, getCompactedTopicContext, getCompactedTopicContextAsync, getDelayedDeliveryMaxDelayInMillis, getDelayedDeliveryTickTimeMillis, getDispatchRateLimiter, getFirstPosition, getInternalStats, getLastDispatchablePosition, getLastMessageId, getLastPosition, getLastPublishedSequenceId, getLastUpdatedAvgPublishRateInByte, getLastUpdatedAvgPublishRateInMsg, getManagedLedger, getMaxReadPosition, getMaxUnackedMessagesOnSubscription, getMessageDeduplication, getNumberOfConsumers, getNumberOfEntries, getNumberOfSameAddressConsumers, getPendingAckManagedLedger, getPendingWriteOps, getPersistentReplicator, getPositionAfterN, getReplicatedSubscriptionController, getReplicators, getSchemaId, getShadowReplicators, getShadowSourceTopic, getStats, getStats, getSubscribeRateLimiter, getSubscription, getSubscriptions, getTopicAttributes, getTopicCompactionService, getTransactionBufferStats, getTransactionBufferStats, getTransactionInBufferStats, getTransactionInPendingAckStats, getTransactionPendingAckStats, handleProducerRemoved, incrementTopicEpoch, initialize, initTopicPolicy, isActive, isCompactionSubscription, isDedupCursorName, isDelayedDeliveryEnabled, isDispatcherPauseOnAckStatePersistentEnabled, isExceedMaximumDeliveryDelay, isMigrated, isOldestMessageExpired, isPersistent, isReplicated, isReplicationBacklogExist, isShadowReplicated, isTerminated, isTxnAborted, offloadStatus, onLocalPoliciesUpdate, onPoliciesUpdate, onUpdate, preCreateSubscriptionForCompactionIfNeeded, publishMessage, publishTxnMessage, setTopicEpoch, shouldProducerMigrate, startReplProducers, stopReplProducers, subscribe, subscribe, terminate, triggerCompaction, triggerOffload, truncate, unloadSubscription, unsubscribe, updateBrokerDispatchPauseOnAckStatePersistentEnabled, updateDispatchRateLimiter, updateLastDispatchablePosition, updateOldPositionInfo, updateRates, updateSubscribeRateLimiter

Methods inherited from class org.apache.pulsar.broker.service.AbstractTopic

addConsumerToSubscription, addFilteredEntriesCount, addSchema, checkSchemaCompatibleForConsumer, checkTopicFenced, currentUsageCount, decrementUsageCount, deletePartitionedTopicMetadataWhileInactive, deleteTopicPolicies, getActiveConsumer, getBrokerService, getBytesInCounter, getBytesOutCounter, getDispatchRate, getFilteredEntriesCount, getHierarchyTopicPolicies, getInactiveTopicPolicies, getMigratedClusterUrl, getMigratedClusterUrl, getMigratedClusterUrlAsync, getMsgInCounter, getMsgOutCounter, getName, getNumberOfSameAddressConsumers, getNumberOfSameAddressProducers, getProducers, getReplicatorDispatchRate, getReplicatorPrefix, getSchemaCompatibilityStrategy, getSchemaValidationEnforced, getSubscribeRate, getSubscriptionDispatchRate, getSystemTopicBytesInCounter, getTopicPublishRateLimiter, getTotalPublishRateLimitCounter, getWaitingProducersCount, handleConsumerAdded, hasLocalProducers, hasSchema, increasePublishLimitedTimes, incrementPublishCount, incrementTopicEpochIfNeeded, internalAddProducer, isClusterMigrationEnabled, isConsumersExceededOnTopic, isExceedMaximumMessageSize, isProducersExceeded, isProducersExceeded, isProducersExceeded, isSameAddressConsumersExceededOnTopic, isSameAddressProducersExceeded, isSystemCursor, isTransferring, markBatchMessagePublished, recordAddLatency, registerTopicPolicyListener, removeProducer, toString, unregisterTopicPolicyListener, updateBrokerDispatchRate, updateBrokerPublishRate, updateBrokerReplicatorDispatchRate, updateBrokerSubscribeRate, updateBrokerSubscriptionDispatchRate, updateBrokerSubscriptionTypesEnabled, updateEntryFilters, updatePublishRateLimiter, updateResourceGroupLimiter, updateTopicPolicy, updateTopicPolicyByNamespacePolicy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.pulsar.broker.service.Topic

addSchema, checkSchemaCompatibleForConsumer, getBrokerService, getHierarchyTopicPolicies, getName, getProducers, getSchemaValidationEnforced, hasSchema, increasePublishLimitedTimes, incrementPublishCount, isTransferring, recordAddLatency, removeProducer

Constructor Details

SystemTopic

public SystemTopic(String topic,
 ManagedLedger ledger,
 BrokerService brokerService)
            throws PulsarServerException

Throws:

PulsarServerException

Method Details

isDeleteWhileInactive

public boolean isDeleteWhileInactive()

Overrides:

isDeleteWhileInactive in class AbstractTopic

isSizeBacklogExceeded

public boolean isSizeBacklogExceeded()

Overrides:

isSizeBacklogExceeded in class PersistentTopic

Returns:

determine if backlog quota enforcement needs to be done for topic based on size limit

checkTimeBacklogExceeded

public CompletableFuture<Boolean> checkTimeBacklogExceeded(boolean shouldUpdateOldPositionInfo)

Overrides:

checkTimeBacklogExceeded in class PersistentTopic

Returns:

determine if backlog quota enforcement needs to be done for topic based on time limit

isSystemTopic

public boolean isSystemTopic()

Specified by:

isSystemTopic in interface Topic

Overrides:

isSystemTopic in class PersistentTopic

checkMessageExpiry

public void checkMessageExpiry()

Specified by:

checkMessageExpiry in interface Topic

Overrides:

checkMessageExpiry in class PersistentTopic

checkGC

public void checkGC()

Specified by:

checkGC in interface Topic

Overrides:

checkGC in class PersistentTopic

checkReplication

public CompletableFuture<Void> checkReplication()

Specified by:

checkReplication in interface Topic

Overrides:

checkReplication in class PersistentTopic

isCompactionEnabled

public boolean isCompactionEnabled()

Overrides:

isCompactionEnabled in class PersistentTopic

isDeduplicationEnabled

public boolean isDeduplicationEnabled()

Description copied from interface: Topic

Indicate if the current topic enabled server side deduplication. This is a dynamic configuration, user may update it by namespace/topic policies.

Specified by:

isDeduplicationEnabled in interface Topic

Overrides:

isDeduplicationEnabled in class PersistentTopic

Returns:

whether enabled server side deduplication

isEncryptionRequired

public boolean isEncryptionRequired()

Specified by:

isEncryptionRequired in interface Topic

Overrides:

isEncryptionRequired in class AbstractTopic

getEntryFiltersPolicy

public org.apache.pulsar.common.policies.data.EntryFilters getEntryFiltersPolicy()

Specified by:

getEntryFiltersPolicy in interface Topic

Overrides:

getEntryFiltersPolicy in class AbstractTopic

getEntryFilters

public List<EntryFilter> getEntryFilters()

Specified by:

getEntryFilters in interface Topic

Overrides:

getEntryFilters in class AbstractTopic

getBrokerPublishRateLimiter

public PublishRateLimiter getBrokerPublishRateLimiter()

Overrides:

getBrokerPublishRateLimiter in class AbstractTopic

updateResourceGroupLimiter

public void updateResourceGroupLimiter(@Nonnull
 org.apache.pulsar.common.policies.data.Policies namespacePolicies)

Overrides:

updateResourceGroupLimiter in class AbstractTopic

getBrokerDispatchRateLimiter

public Optional<DispatchRateLimiter> getBrokerDispatchRateLimiter()

Specified by:

getBrokerDispatchRateLimiter in interface Topic

Overrides:

getBrokerDispatchRateLimiter in class PersistentTopic