spring-framework / org.springframework.messaging.support / IdTimestampMessageHeaderInitializer

IdTimestampMessageHeaderInitializer

open class IdTimestampMessageHeaderInitializer : MessageHeaderInitializer

A org.springframework.messaging.support.MessageHeaderInitializer to customize the strategy for ID and TIMESTAMP message header generation.

Author
Rossen Stoyanchev

Since
4.1

Constructors

<init>

IdTimestampMessageHeaderInitializer()

A org.springframework.messaging.support.MessageHeaderInitializer to customize the strategy for ID and TIMESTAMP message header generation.

Functions

getIdGenerator

open fun getIdGenerator(): IdGenerator

Return the configured IdGenerator, if any.

initHeaders

open fun initHeaders(headerAccessor: MessageHeaderAccessor): Unit

isEnableTimestamp

open fun isEnableTimestamp(): Boolean

Return whether the timestamp header is enabled or not.

setDisableIdGeneration

open fun setDisableIdGeneration(): Unit

A shortcut for calling #setIdGenerator with an id generation strategy to disable id generation completely.

setEnableTimestamp

open fun setEnableTimestamp(enableTimestamp: Boolean): Unit

Whether to enable the automatic addition of the org.springframework.messaging.MessageHeaders#TIMESTAMP header on MessageHeaderAccessor instances being initialized.

By default this property is set to false.

setIdGenerator

open fun setIdGenerator(idGenerator: IdGenerator): Unit

Configure the IdGenerator strategy to initialize MessageHeaderAccessor instances with.

By default this property is set to null in which case the default IdGenerator of org.springframework.messaging.MessageHeaders is used.

To have no ids generated at all, see #setDisableIdGeneration().