Class AbstractIntegrationMessageBuilder<T>

java.lang.Object

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

Type Parameters:

T - the payload type.

Direct Known Subclasses:

BaseMessageBuilder, MutableMessageBuilder

public abstract class AbstractIntegrationMessageBuilder<T>
extends Object

Since:

4.0

Author:

Gary Russell, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
AbstractIntegrationMessageBuilder()

Method Summary

Modifier and Type	Method	Description
abstract Message<T>	build()
AbstractIntegrationMessageBuilder<T>	cloneMessageHistoryIfAny()	Make a copy of MessageHistory header (if present) for a new message to build.
abstract AbstractIntegrationMessageBuilder<T>	copyHeaders(Map<String,?> headersToCopy)	Copy the name-value pairs from the provided Map.
abstract AbstractIntegrationMessageBuilder<T>	copyHeadersIfAbsent(Map<String,?> headersToCopy)	Copy the name-value pairs from the provided Map.
AbstractIntegrationMessageBuilder<T>	filterAndCopyHeadersIfAbsent(Map<String,?> headersToCopy, String... headerPatternsToFilter)	Remove headers from the provided map matching to the provided pattens and only after that copy the result into the target message headers.
protected abstract Object	getCorrelationId()
abstract <V> V	getHeader(String key, Class<V> type)
abstract Map<String,Object>	getHeaders()
abstract T	getPayload()
protected abstract List<List<Object>>	getSequenceDetails()
protected abstract Object	getSequenceNumber()
protected abstract Object	getSequenceSize()
AbstractIntegrationMessageBuilder<T>	popSequenceDetails()
AbstractIntegrationMessageBuilder<T>	pushSequenceDetails(Object correlationId, int sequenceNumber, int sequenceSize)
abstract AbstractIntegrationMessageBuilder<T>	removeHeader(String headerName)	Remove the value for the given header name.
abstract AbstractIntegrationMessageBuilder<T>	removeHeaders(String... headerPatterns)	Removes all headers provided via array of 'headerPatterns'.
AbstractIntegrationMessageBuilder<T>	setCorrelationId(Object correlationId)
AbstractIntegrationMessageBuilder<T>	setErrorChannel(MessageChannel errorChannel)
AbstractIntegrationMessageBuilder<T>	setErrorChannelName(String errorChannelName)
AbstractIntegrationMessageBuilder<T>	setExpirationDate(Long expirationDate)
AbstractIntegrationMessageBuilder<T>	setExpirationDate(Date expirationDate)
abstract AbstractIntegrationMessageBuilder<T>	setHeader(String headerName, Object headerValue)	Set the value for the given header name.
abstract 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.
AbstractIntegrationMessageBuilder<T>	setPriority(Integer priority)
AbstractIntegrationMessageBuilder<T>	setReplyChannel(MessageChannel replyChannel)
AbstractIntegrationMessageBuilder<T>	setReplyChannelName(String replyChannelName)
AbstractIntegrationMessageBuilder<T>	setSequenceNumber(Integer sequenceNumber)
AbstractIntegrationMessageBuilder<T>	setSequenceSize(Integer sequenceSize)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractIntegrationMessageBuilder

public AbstractIntegrationMessageBuilder()

Method Details

setExpirationDate

public AbstractIntegrationMessageBuilder<T> setExpirationDate(@Nullable
 Long expirationDate)

setExpirationDate

public AbstractIntegrationMessageBuilder<T> setExpirationDate(@Nullable
 Date expirationDate)

setCorrelationId

public AbstractIntegrationMessageBuilder<T> setCorrelationId(Object correlationId)

pushSequenceDetails

public AbstractIntegrationMessageBuilder<T> pushSequenceDetails(Object correlationId,
 int sequenceNumber,
 int sequenceSize)

popSequenceDetails

public AbstractIntegrationMessageBuilder<T> popSequenceDetails()

setReplyChannel

public AbstractIntegrationMessageBuilder<T> setReplyChannel(MessageChannel replyChannel)

setReplyChannelName

public AbstractIntegrationMessageBuilder<T> setReplyChannelName(String replyChannelName)

setErrorChannel

public AbstractIntegrationMessageBuilder<T> setErrorChannel(MessageChannel errorChannel)

setErrorChannelName

public AbstractIntegrationMessageBuilder<T> setErrorChannelName(String errorChannelName)

setSequenceNumber

public AbstractIntegrationMessageBuilder<T> setSequenceNumber(Integer sequenceNumber)

setSequenceSize

public AbstractIntegrationMessageBuilder<T> setSequenceSize(Integer sequenceSize)

setPriority

public AbstractIntegrationMessageBuilder<T> setPriority(Integer priority)

filterAndCopyHeadersIfAbsent

public AbstractIntegrationMessageBuilder<T> filterAndCopyHeadersIfAbsent(Map<String,?> headersToCopy,
 @Nullable
 String... headerPatternsToFilter)

Remove headers from the provided map matching to the provided pattens and only after that copy the result into the target message headers.

Parameters:

headersToCopy - a map of headers to copy.

headerPatternsToFilter - an arrays of header patterns to filter before copying.

Returns:

the current AbstractIntegrationMessageBuilder.

Since:

5.1

See Also:

• copyHeadersIfAbsent(Map)

cloneMessageHistoryIfAny

public AbstractIntegrationMessageBuilder<T> cloneMessageHistoryIfAny()

Make a copy of MessageHistory header (if present) for a new message to build.

Returns:

the current AbstractIntegrationMessageBuilder.

Since:

6.3

getSequenceDetails

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

getCorrelationId

@Nullable
protected abstract Object getCorrelationId()

getSequenceNumber

@Nullable
protected abstract Object getSequenceNumber()

getSequenceSize

@Nullable
protected abstract Object getSequenceSize()

getPayload

public abstract T getPayload()

getHeaders

public abstract Map<String,Object> getHeaders()

getHeader

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

setHeader

public abstract AbstractIntegrationMessageBuilder<T> 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.

Parameters:

headerName - The header name.

headerValue - The header value.

Returns:

this.

setHeaderIfAbsent

public abstract 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.

Parameters:

headerName - The header name.

headerValue - The header value.

Returns:

this.

removeHeaders

public abstract AbstractIntegrationMessageBuilder<T> 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".

Parameters:

headerPatterns - The header patterns.

Returns:

this.

removeHeader

public abstract AbstractIntegrationMessageBuilder<T> removeHeader(String headerName)

Remove the value for the given header name.

Parameters:

headerName - The header name.

Returns:

this.

copyHeaders

public abstract AbstractIntegrationMessageBuilder<T> 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.

Parameters:

headersToCopy - The headers to copy.

Returns:

this.

See Also:

• MessageHeaders.ID
• MessageHeaders.TIMESTAMP

copyHeadersIfAbsent

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

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

Parameters:

headersToCopy - The headers to copy.

Returns:

this.

build

public abstract Message<T> build()