org.springframework.integration.support

Class MutableMessageBuilder<T>

java.lang.Object

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

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

public final class MutableMessageBuilder<T>
extends AbstractIntegrationMessageBuilder<T>

Specialized message builder that can be used within a component to avoid the overhead of having to build multiple messages for mutations within that component.

IMPORTANT: Mutable messages may share state (such as message headers); such messages should never be exposed to other components or undesirable side-effects may result.

It is generally recommended that messages transferred between components should always be immutable unless great care is taken with their use.

Since:

4.0

Author:

Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method and Description
Message<T>	build()
AbstractIntegrationMessageBuilder<T>	copyHeaders(Map<String,?> headersToCopy) Copy the name-value pairs from the provided Map.
AbstractIntegrationMessageBuilder<T>	copyHeadersIfAbsent(Map<String,?> headersToCopy) Copy the name-value pairs from the provided Map.
static <T> MutableMessageBuilder<T>	fromMessage(Message<T> message) Create a builder for a new Message instance pre-populated with all of the headers copied from the provided message.
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()
AbstractIntegrationMessageBuilder<T>	removeHeader(String headerName) Remove the value for the given header name.
AbstractIntegrationMessageBuilder<T>	removeHeaders(String... headerPatterns) Removes all headers provided via array of 'headerPatterns'.
AbstractIntegrationMessageBuilder<T>	setHeader(String headerName, Object headerValue) Set the value for the given header name.
AbstractIntegrationMessageBuilder<T>	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.
static <T> MutableMessageBuilder<T>	withPayload(T payload) Create a builder for a new Message instance with the provided payload.
static <T> MutableMessageBuilder<T>	withPayload(T payload, boolean generateHeaders) Create a builder for a new Message instance with the provided payload.

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

filterAndCopyHeadersIfAbsent, popSequenceDetails, pushSequenceDetails, setCorrelationId, setErrorChannel, setErrorChannelName, setExpirationDate, setExpirationDate, setPriority, setReplyChannel, setReplyChannelName, setSequenceNumber, setSequenceSize

Methods inherited from class java.lang.Object

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

Method Detail

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>

withPayload

public static <T> MutableMessageBuilder<T> withPayload(T payload)

Create a builder for a new Message instance with the provided payload.

Type Parameters:

T - The type of the payload.

Parameters:

payload - the payload for the new message

Returns:

A MutableMessageBuilder.

withPayload

public static <T> MutableMessageBuilder<T> withPayload(T payload,
                                                       boolean generateHeaders)

Create a builder for a new Message instance with the provided payload. The generateHeaders flag allows to disable MessageHeaders.ID and MessageHeaders.TIMESTAMP headers generation.

Type Parameters:

T - The type of the payload.

Parameters:

payload - the payload for the new message

generateHeaders - whether generate MessageHeaders.ID and MessageHeaders.TIMESTAMP headers

Returns:

A MutableMessageBuilder.

Since:

5.0

fromMessage

public static <T> MutableMessageBuilder<T> fromMessage(Message<T> message)

Create a builder for a new Message instance pre-populated with all of the headers copied from the provided message. The payload of the provided Message will also be used as the payload for the new message.

Type Parameters:

T - The type of the payload.

Parameters:

message - the Message from which the payload and all headers will be copied

Returns:

A MutableMessageBuilder.

setHeader

public AbstractIntegrationMessageBuilder<T> setHeader(String headerName,
                                                      @Nullable
                                                      Object headerValue)

Description copied from class: AbstractIntegrationMessageBuilder

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.

setHeaderIfAbsent

public AbstractIntegrationMessageBuilder<T> setHeaderIfAbsent(String headerName,
                                                              Object headerValue)

Description copied from class: AbstractIntegrationMessageBuilder

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.

removeHeaders

public AbstractIntegrationMessageBuilder<T> removeHeaders(String... headerPatterns)

Description copied from class: AbstractIntegrationMessageBuilder

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.

removeHeader

public AbstractIntegrationMessageBuilder<T> removeHeader(String headerName)

Description copied from class: AbstractIntegrationMessageBuilder

Remove the value for the given header name.

Specified by:

removeHeader in class AbstractIntegrationMessageBuilder<T>

Parameters:

headerName - The header name.

Returns:

this.

copyHeaders

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

Description copied from class: AbstractIntegrationMessageBuilder

Copy the name-value pairs from the provided Map. This operation will overwrite any existing values. Use { AbstractIntegrationMessageBuilder.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.

See Also:

MessageHeaders.ID, MessageHeaders.TIMESTAMP

copyHeadersIfAbsent

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

Description copied from class: AbstractIntegrationMessageBuilder

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

Specified by:

copyHeadersIfAbsent in class AbstractIntegrationMessageBuilder<T>

Parameters:

headersToCopy - The headers to copy.

Returns:

this.

getSequenceDetails

protected List<List<Object>> getSequenceDetails()

Specified by:

getSequenceDetails in class AbstractIntegrationMessageBuilder<T>

getCorrelationId

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>

build

public Message<T> build()

Specified by:

build in class AbstractIntegrationMessageBuilder<T>