org.apache.pulsar.broker.service

Class AbstractTopic

java.lang.Object

org.apache.pulsar.broker.service.AbstractTopic

All Implemented Interfaces:

Topic

Direct Known Subclasses:

NonPersistentTopic, PersistentTopic

public abstract class AbstractTopic
extends Object
implements Topic

Nested Class Summary

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

Topic.PublishContext

Field Summary

Fields

Modifier and Type	Field and Description
protected StatsBuckets	addEntryLatencyStatsUsec
protected BrokerService	brokerService
protected boolean	hasBatchMessagePublished
protected org.apache.pulsar.common.policies.data.InactiveTopicPolicies	inactiveTopicPolicies
protected boolean	isAllowAutoUpdateSchema
protected boolean	isEncryptionRequired
protected boolean	isFenced
protected long	lastActive
protected ReentrantReadWriteLock	lock
protected Integer	maxSubscriptionsPerTopic
protected int	maxUnackedMessagesOnConsumer
protected static long	POLICY_UPDATE_FAILURE_RETRY_TIME_SECONDS
protected boolean	preciseTopicPublishRateLimitingEnable
protected ConcurrentHashMap<String,Producer>	producers
protected String	replicatorPrefix
protected org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy	schemaCompatibilityStrategy
protected boolean	schemaValidationEnforced
protected String	topic
protected PublishRateLimiter	topicPublishRateLimiter
protected CompletableFuture<TransactionBuffer>	transactionBuffer
protected ReentrantLock	transactionBufferLock

Constructor Summary

Constructors

Constructor and Description
AbstractTopic(String topic, BrokerService brokerService)

Method Summary

Modifier and Type	Method and Description
protected void	addConsumerToSubscription(Subscription subscription, Consumer consumer)
CompletableFuture<org.apache.pulsar.common.protocol.schema.SchemaVersion>	addSchema(org.apache.pulsar.common.protocol.schema.SchemaData schema) Add a schema to the topic.
CompletableFuture<Void>	checkSchemaCompatibleForConsumer(org.apache.pulsar.common.protocol.schema.SchemaData schema) Check if schema is compatible with current topic schema.
protected void	checkTopicFenced()
void	checkTopicPublishThrottlingRate()
boolean	deletePartitionedTopicMetadataWhileInactive()
CompletableFuture<org.apache.pulsar.common.protocol.schema.SchemaVersion>	deleteSchema() Delete the schema if this topic has a schema defined for it.
void	disableCnxAutoRead()
protected void	disableProducerRead()
void	enableCnxAutoRead()
protected void	enableProducerReadForPublishBufferLimiting()
protected void	enableProducerReadForPublishRateLimiting() it sets cnx auto-readable if producer's cnx is disabled due to publish-throttling
PublishRateLimiter	getBrokerPublishRateLimiter()
BrokerService	getBrokerService()
long	getBytesInCounter()
long	getBytesOutCounter()
org.apache.pulsar.common.policies.data.InactiveTopicPolicies	getInactiveTopicPolicies()
long	getMsgInCounter()
long	getMsgOutCounter()
String	getName()
abstract int	getNumberOfConsumers()
Map<String,Producer>	getProducers()
String	getReplicatorPrefix()
boolean	getSchemaValidationEnforced()
org.apache.pulsar.common.policies.data.TopicPolicies	getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName) Get TopicPolicies for this topic.
PublishRateLimiter	getTopicPublishRateLimiter()
protected abstract void	handleProducerRemoved(Producer producer)
protected boolean	hasLocalProducers()
CompletableFuture<Boolean>	hasSchema() Whether a topic has had a schema defined for it.
void	incrementPublishCount(int numOfMessages, long msgSizeInBytes)
protected void	internalAddProducer(Producer producer)
boolean	isBrokerPublishRateExceeded()
protected boolean	isConsumersExceededOnTopic()
boolean	isDeleteWhileInactive()
boolean	isEncryptionRequired()
protected boolean	isExceedMaximumMessageSize(int size)
protected boolean	isProducersExceeded()
boolean	isPublishRateExceeded()
boolean	isTopicPublishRateExceeded(int numberMessages, int bytes)
void	markBatchMessagePublished()
void	recordAddLatency(long latency, TimeUnit unit) record add-latency
void	resetBrokerPublishCountAndEnableReadIfRequired(boolean doneBrokerReset)
void	resetInactiveTopicPolicies(org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode inactiveTopicDeleteMode, int maxInactiveDurationSeconds, boolean deleteWhileInactive)
void	resetTopicPublishCountAndEnableReadIfRequired()
void	setDeleteWhileInactive(boolean deleteWhileInactive)
protected void	setSchemaCompatibilityStrategy(org.apache.pulsar.common.policies.data.Policies policies)
String	toString()
void	updateMaxPublishRate(org.apache.pulsar.common.policies.data.Policies policies)
protected void	updatePublishDispatcher(org.apache.pulsar.common.policies.data.PublishRate publishRate) update topic publish dispatcher for this topic.

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

addProducer, addSchemaIfIdleOrCheckCompatible, checkBackloggedCursors, checkDeduplicationSnapshot, checkGC, checkInactiveSubscriptions, checkMessageDeduplicationInfo, checkMessageExpiry, checkReplication, close, createSubscription, delete, deleteForcefully, endTxn, getBacklogQuota, getDispatchRateLimiter, getInternalStats, getLastMessageId, getLastPosition, getReplicators, getStats, getSubscription, getSubscriptions, getTransactionBuffer, isBacklogQuotaExceeded, isReplicated, isSystemTopic, onPoliciesUpdate, publishMessage, publishTxnMessage, removeProducer, subscribe, unsubscribe, updateRates

Field Detail

POLICY_UPDATE_FAILURE_RETRY_TIME_SECONDS

protected static final long POLICY_UPDATE_FAILURE_RETRY_TIME_SECONDS

See Also:

Constant Field Values

topic

protected final String topic

producers

protected final ConcurrentHashMap<String,Producer> producers

brokerService

protected final BrokerService brokerService

replicatorPrefix

protected final String replicatorPrefix

lock

protected final ReentrantReadWriteLock lock

isFenced

protected volatile boolean isFenced

inactiveTopicPolicies

protected org.apache.pulsar.common.policies.data.InactiveTopicPolicies inactiveTopicPolicies

lastActive

protected volatile long lastActive

hasBatchMessagePublished

protected volatile boolean hasBatchMessagePublished

addEntryLatencyStatsUsec

protected StatsBuckets addEntryLatencyStatsUsec

isEncryptionRequired

protected volatile boolean isEncryptionRequired

schemaCompatibilityStrategy

protected volatile org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy schemaCompatibilityStrategy

isAllowAutoUpdateSchema

protected volatile boolean isAllowAutoUpdateSchema

schemaValidationEnforced

protected volatile boolean schemaValidationEnforced

maxUnackedMessagesOnConsumer

protected volatile int maxUnackedMessagesOnConsumer

maxSubscriptionsPerTopic

protected volatile Integer maxSubscriptionsPerTopic

topicPublishRateLimiter

protected volatile PublishRateLimiter topicPublishRateLimiter

preciseTopicPublishRateLimitingEnable

protected boolean preciseTopicPublishRateLimitingEnable

transactionBuffer

protected CompletableFuture<TransactionBuffer> transactionBuffer

transactionBufferLock

protected ReentrantLock transactionBufferLock

Constructor Detail

AbstractTopic

public AbstractTopic(String topic,
                     BrokerService brokerService)

Method Detail

isProducersExceeded

protected boolean isProducersExceeded()

isConsumersExceededOnTopic

protected boolean isConsumersExceededOnTopic()

getNumberOfConsumers

public abstract int getNumberOfConsumers()

addConsumerToSubscription

protected void addConsumerToSubscription(Subscription subscription,
                                         Consumer consumer)
                                  throws BrokerServiceException

Throws:

BrokerServiceException

disableCnxAutoRead

public void disableCnxAutoRead()

Specified by:

disableCnxAutoRead in interface Topic

enableCnxAutoRead

public void enableCnxAutoRead()

Specified by:

enableCnxAutoRead in interface Topic

hasLocalProducers

protected boolean hasLocalProducers()

toString

public String toString()

Overrides:

toString in class Object

getProducers

public Map<String,Producer> getProducers()

Specified by:

getProducers in interface Topic

getBrokerService

public BrokerService getBrokerService()

getName

public String getName()

Specified by:

getName in interface Topic

isEncryptionRequired

public boolean isEncryptionRequired()

Specified by:

isEncryptionRequired in interface Topic

getSchemaValidationEnforced

public boolean getSchemaValidationEnforced()

Specified by:

getSchemaValidationEnforced in interface Topic

markBatchMessagePublished

public void markBatchMessagePublished()

getReplicatorPrefix

public String getReplicatorPrefix()

hasSchema

public CompletableFuture<Boolean> hasSchema()

Description copied from interface: Topic

Whether a topic has had a schema defined for it.

Specified by:

hasSchema in interface Topic

addSchema

public CompletableFuture<org.apache.pulsar.common.protocol.schema.SchemaVersion> addSchema(org.apache.pulsar.common.protocol.schema.SchemaData schema)

Description copied from interface: Topic

Add a schema to the topic. This will fail if the new schema is incompatible with the current schema.

Specified by:

addSchema in interface Topic

deleteSchema

public CompletableFuture<org.apache.pulsar.common.protocol.schema.SchemaVersion> deleteSchema()

Description copied from interface: Topic

Delete the schema if this topic has a schema defined for it.

Specified by:

deleteSchema in interface Topic

checkSchemaCompatibleForConsumer

public CompletableFuture<Void> checkSchemaCompatibleForConsumer(org.apache.pulsar.common.protocol.schema.SchemaData schema)

Description copied from interface: Topic

Check if schema is compatible with current topic schema.

Specified by:

checkSchemaCompatibleForConsumer in interface Topic

recordAddLatency

public void recordAddLatency(long latency,
                             TimeUnit unit)

Description copied from interface: Topic

record add-latency

Specified by:

recordAddLatency in interface Topic

setSchemaCompatibilityStrategy

protected void setSchemaCompatibilityStrategy(org.apache.pulsar.common.policies.data.Policies policies)

checkTopicPublishThrottlingRate

public void checkTopicPublishThrottlingRate()

Specified by:

checkTopicPublishThrottlingRate in interface Topic

incrementPublishCount

public void incrementPublishCount(int numOfMessages,
                                  long msgSizeInBytes)

Specified by:

incrementPublishCount in interface Topic

resetTopicPublishCountAndEnableReadIfRequired

public void resetTopicPublishCountAndEnableReadIfRequired()

Specified by:

resetTopicPublishCountAndEnableReadIfRequired in interface Topic

resetBrokerPublishCountAndEnableReadIfRequired

public void resetBrokerPublishCountAndEnableReadIfRequired(boolean doneBrokerReset)

Specified by:

resetBrokerPublishCountAndEnableReadIfRequired in interface Topic

enableProducerReadForPublishRateLimiting

protected void enableProducerReadForPublishRateLimiting()

it sets cnx auto-readable if producer's cnx is disabled due to publish-throttling

enableProducerReadForPublishBufferLimiting

protected void enableProducerReadForPublishBufferLimiting()

disableProducerRead

protected void disableProducerRead()

checkTopicFenced

protected void checkTopicFenced()
                         throws BrokerServiceException

Throws:

BrokerServiceException

internalAddProducer

protected void internalAddProducer(Producer producer)
                            throws BrokerServiceException

Throws:

BrokerServiceException

handleProducerRemoved

protected abstract void handleProducerRemoved(Producer producer)

isPublishRateExceeded

public boolean isPublishRateExceeded()

Specified by:

isPublishRateExceeded in interface Topic

isTopicPublishRateExceeded

public boolean isTopicPublishRateExceeded(int numberMessages,
                                          int bytes)

Specified by:

isTopicPublishRateExceeded in interface Topic

isBrokerPublishRateExceeded

public boolean isBrokerPublishRateExceeded()

Specified by:

isBrokerPublishRateExceeded in interface Topic

getTopicPublishRateLimiter

public PublishRateLimiter getTopicPublishRateLimiter()

getBrokerPublishRateLimiter

public PublishRateLimiter getBrokerPublishRateLimiter()

updateMaxPublishRate

public void updateMaxPublishRate(org.apache.pulsar.common.policies.data.Policies policies)

getMsgInCounter

public long getMsgInCounter()

getBytesInCounter

public long getBytesInCounter()

getMsgOutCounter

public long getMsgOutCounter()

getBytesOutCounter

public long getBytesOutCounter()

isDeleteWhileInactive

public boolean isDeleteWhileInactive()

deletePartitionedTopicMetadataWhileInactive

public boolean deletePartitionedTopicMetadataWhileInactive()

setDeleteWhileInactive

public void setDeleteWhileInactive(boolean deleteWhileInactive)

getInactiveTopicPolicies

public org.apache.pulsar.common.policies.data.InactiveTopicPolicies getInactiveTopicPolicies()

resetInactiveTopicPolicies

public void resetInactiveTopicPolicies(org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode inactiveTopicDeleteMode,
                                       int maxInactiveDurationSeconds,
                                       boolean deleteWhileInactive)

getTopicPolicies

public org.apache.pulsar.common.policies.data.TopicPolicies getTopicPolicies(org.apache.pulsar.common.naming.TopicName topicName)

Get TopicPolicies for this topic.

Parameters:

topicName -

Returns:

TopicPolicies is exist else return null.

isExceedMaximumMessageSize

protected boolean isExceedMaximumMessageSize(int size)

updatePublishDispatcher

protected void updatePublishDispatcher(org.apache.pulsar.common.policies.data.PublishRate publishRate)

update topic publish dispatcher for this topic.