com.atlassian.bitbucket.topic

Class TopicSettings<T extends Serializable>

java.lang.Object

com.atlassian.bitbucket.topic.TopicSettings<T>

public class TopicSettings<T extends Serializable>
extends Object

Settings for creating a Topic. Allows the topic creator to control the message queue size and the message deduplication policy.

Since:

5.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopicSettings.Builder<T extends Serializable>

Field Summary

Fields

Modifier and Type	Field and Description
static int	QUEUE_SIZE_DEFAULT

Method Summary

Modifier and Type	Method and Description
static <T extends Serializable> TopicSettings.Builder<T>	builder(Class<T> messageType)
Optional<Class<T>>	getMessageType()
int	getQueueSize() If the rate at which messages are published on the topic (temporarily) exceeds the rate at which the messages are consumed, pending messages will be stored on the topic's message queue.
boolean	isDedupePendingMessages() Whether identical messages that haven't been dispatched yet should be deduplicated.

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_SIZE_DEFAULT

public static final int QUEUE_SIZE_DEFAULT

See Also:

Constant Field Values

Method Detail

builder

@Nonnull
public static <T extends Serializable> TopicSettings.Builder<T> builder(@Nullable
                                                                                 Class<T> messageType)

getMessageType

@Nonnull
public Optional<Class<T>> getMessageType()

Returns:

the type of message that will be sent to the topic, or Optional.empty() if none has been provided

getQueueSize

public int getQueueSize()

If the rate at which messages are published on the topic (temporarily) exceeds the rate at which the messages are consumed, pending messages will be stored on the topic's message queue. This setting controls how many messages can be stored on the queue. When the queue is full, messages will be dropped (and errors logged).

Returns:

the maximum number of messages that can be queued for the topic. A value of QUEUE_SIZE_DEFAULT indicates that the default queue size will be used.

isDedupePendingMessages

public boolean isDedupePendingMessages()

Whether identical messages that haven't been dispatched yet should be deduplicated. Enabling this prevents the message queue from filling up with identical messages. The deduplication only applies to pending messages and does not take into account any messages that have been dispatched to the TopicListener in the past. Enabling this option is not appropriate for listeners that care about timestamp on the message, since deduplication only retains the oldest (identical) message in the queue. Deduplication is performed by using the equals method on the message.

Returns:

whether messages should deduplicated in the message queue