Package org.springframework.integration.support

Class BaseMessageBuilder<T,B extends BaseMessageBuilder<T,B>>

java.lang.Object

org.springframework.integration.support.AbstractIntegrationMessageBuilder<T>

org.springframework.integration.support.BaseMessageBuilder<T,B>

Type Parameters:

T - the payload type.

B - the target builder class type.

Direct Known Subclasses:

MessageBuilder

public abstract class BaseMessageBuilder<T,B extends BaseMessageBuilder<T,B>>
extends AbstractIntegrationMessageBuilder<T>

The AbstractIntegrationMessageBuilder extension for the default logic to build message. The MessageBuilder is fully based on this class. This abstract class can be used for creating custom Message instances. For that purpose its build() method has to be overridden. The custom Message type could be used, for example, to hide sensitive information from payload and headers when message is logged. For this goal there would be enough to override GenericMessage.toString() and filter out (or mask) those headers which container such sensitive information.

Since:

6.4

Author:

Artem Bilan

See Also:

• MessageBuilder
• MessageBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseMessageBuilder(T payload, Message<T> originalMessage)

Method Summary

Modifier and Type	Method	Description
Message<T>	build()	Return an original message instance if it is not modified and does not have read-only headers.
B	copyHeaders(Map<String,?> headersToCopy)	Copy the name-value pairs from the provided Map.
B	copyHeadersIfAbsent(Map<String,?> headersToCopy)	Copy the name-value pairs from the provided Map.
protected Object	getCorrelationId()
<V> V	getHeader(String key, Class<V> type)
Map<String,Object>	getHeaders()
T	getPayload()
protected List<List<Object>>	getSequenceDetails()
protected Object	getSequenceNumber()
protected Object	getSequenceSize()
B	popSequenceDetails()
B	pushSequenceDetails(Object correlationId, int sequenceNumber, int sequenceSize)
B	readOnlyHeaders(String... readOnlyHeaders)	Specify a list of headers which should be considered as read only and prohibited from being populated in the message.
B	removeHeader(String headerName)	Remove the value for the given header name.
B	removeHeaders(String... headerPatterns)	Removes all headers provided via array of 'headerPatterns'.
B	setCorrelationId(Object correlationId)
B	setErrorChannel(MessageChannel errorChannel)
B	setErrorChannelName(String errorChannelName)
B	setExpirationDate(Long expirationDate)
B	setExpirationDate(Date expirationDate)
B	setHeader(String headerName, Object headerValue)	Set the value for the given header name.
B	setHeaderIfAbsent(String headerName, Object headerValue)	Set the value for the given header name only if the header name is not already associated with a value.
B	setPriority(Integer priority)
B	setReplyChannel(MessageChannel replyChannel)
B	setReplyChannelName(String replyChannelName)
B	setSequenceNumber(Integer sequenceNumber)
B	setSequenceSize(Integer sequenceSize)

Methods inherited from class org.springframework.integration.support.AbstractIntegrationMessageBuilder

cloneMessageHistoryIfAny, filterAndCopyHeadersIfAbsent

Methods inherited from class java.lang.Object

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

Constructor Details

BaseMessageBuilder

protected BaseMessageBuilder(T payload,
 @Nullable
 Message<T> originalMessage)

Method Details

getPayload

public T getPayload()

Specified by:

getPayload in class AbstractIntegrationMessageBuilder<T>

getHeaders

public Map<String,Object> getHeaders()

Specified by:

getHeaders in class AbstractIntegrationMessageBuilder<T>

getHeader

@Nullable
public <V> V getHeader(String key,
 Class<V> type)

Specified by:

getHeader in class AbstractIntegrationMessageBuilder<T>

setHeader

public B setHeader(String headerName,
 @Nullable
 Object headerValue)

Set the value for the given header name. If the provided value is null, the header will be removed.

Specified by:

setHeader in class AbstractIntegrationMessageBuilder<T>

Parameters:

headerName - The header name.

headerValue - The header value.

Returns:

this MessageBuilder.

setHeaderIfAbsent

public B setHeaderIfAbsent(String headerName,
 Object headerValue)

Set the value for the given header name only if the header name is not already associated with a value.

Specified by:

setHeaderIfAbsent in class AbstractIntegrationMessageBuilder<T>

Parameters:

headerName - The header name.

headerValue - The header value.

Returns:

this MessageBuilder.

removeHeaders

public B removeHeaders(String... headerPatterns)

Removes all headers provided via array of 'headerPatterns'. As the name suggests the array may contain simple matching patterns for header names. Supported pattern styles are: xxx*, *xxx, *xxx* and xxx*yyy.

Specified by:

removeHeaders in class AbstractIntegrationMessageBuilder<T>

Parameters:

headerPatterns - The header patterns.

Returns:

this MessageBuilder.

removeHeader

public B removeHeader(String headerName)

Remove the value for the given header name.

Specified by:

removeHeader in class AbstractIntegrationMessageBuilder<T>

Parameters:

headerName - The header name.

Returns:

this MessageBuilder.

copyHeaders

public B copyHeaders(@Nullable
 Map<String,?> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will overwrite any existing values. Use copyHeadersIfAbsent(Map) to avoid overwriting values. Note that the 'id' and 'timestamp' header values will never be overwritten.

Specified by:

copyHeaders in class AbstractIntegrationMessageBuilder<T>

Parameters:

headersToCopy - The headers to copy.

Returns:

this MessageBuilder.

See Also:

• MessageHeaders.ID
• MessageHeaders.TIMESTAMP

copyHeadersIfAbsent

public B copyHeadersIfAbsent(@Nullable
 Map<String,?> headersToCopy)

Copy the name-value pairs from the provided Map. This operation will not override any existing values.

Specified by:

copyHeadersIfAbsent in class AbstractIntegrationMessageBuilder<T>

Parameters:

headersToCopy - The headers to copy.

Returns:

this MessageBuilder.

getSequenceDetails

@Nullable
protected List<List<Object>> getSequenceDetails()

Specified by:

getSequenceDetails in class AbstractIntegrationMessageBuilder<T>

getCorrelationId

@Nullable
protected Object getCorrelationId()

Specified by:

getCorrelationId in class AbstractIntegrationMessageBuilder<T>

getSequenceNumber

protected Object getSequenceNumber()

Specified by:

getSequenceNumber in class AbstractIntegrationMessageBuilder<T>

getSequenceSize

protected Object getSequenceSize()

Specified by:

getSequenceSize in class AbstractIntegrationMessageBuilder<T>

pushSequenceDetails

public B pushSequenceDetails(Object correlationId,
 int sequenceNumber,
 int sequenceSize)

Overrides:

pushSequenceDetails in class AbstractIntegrationMessageBuilder<T>

popSequenceDetails

public B popSequenceDetails()

Overrides:

popSequenceDetails in class AbstractIntegrationMessageBuilder<T>

setExpirationDate

public B setExpirationDate(@Nullable
 Long expirationDate)

Overrides:

setExpirationDate in class AbstractIntegrationMessageBuilder<T>

setExpirationDate

public B setExpirationDate(@Nullable
 Date expirationDate)

Overrides:

setExpirationDate in class AbstractIntegrationMessageBuilder<T>

setCorrelationId

public B setCorrelationId(Object correlationId)

Overrides:

setCorrelationId in class AbstractIntegrationMessageBuilder<T>

setReplyChannel

public B setReplyChannel(MessageChannel replyChannel)

Overrides:

setReplyChannel in class AbstractIntegrationMessageBuilder<T>

setReplyChannelName

public B setReplyChannelName(String replyChannelName)

Overrides:

setReplyChannelName in class AbstractIntegrationMessageBuilder<T>

setErrorChannel

public B setErrorChannel(MessageChannel errorChannel)

Overrides:

setErrorChannel in class AbstractIntegrationMessageBuilder<T>

setErrorChannelName

public B setErrorChannelName(String errorChannelName)

Overrides:

setErrorChannelName in class AbstractIntegrationMessageBuilder<T>

setSequenceNumber

public B setSequenceNumber(Integer sequenceNumber)

Overrides:

setSequenceNumber in class AbstractIntegrationMessageBuilder<T>

setSequenceSize

public B setSequenceSize(Integer sequenceSize)

Overrides:

setSequenceSize in class AbstractIntegrationMessageBuilder<T>

setPriority

public B setPriority(Integer priority)

Overrides:

setPriority in class AbstractIntegrationMessageBuilder<T>

readOnlyHeaders

public B readOnlyHeaders(@Nullable
 String... readOnlyHeaders)

Specify a list of headers which should be considered as read only and prohibited from being populated in the message.

Parameters:

readOnlyHeaders - the list of headers for readOnly mode. Defaults to MessageHeaders.ID and MessageHeaders.TIMESTAMP.

Returns:

the current BaseMessageBuilder

See Also:

• IntegrationMessageHeaderAccessor.isReadOnly(String)

build

public Message<T> build()

Return an original message instance if it is not modified and does not have read-only headers. If payload is an instance of Throwable, then an ErrorMessage is built. Otherwise, a new instance of GenericMessage is produced. This method can be overridden to provide any custom message implementations.

Specified by:

build in class AbstractIntegrationMessageBuilder<T>

Returns:

the message instance

See Also:

• getPayload()
• getHeaders()