Package org.springframework.integration
Class IntegrationMessageHeaderAccessor
java.lang.Object
org.springframework.messaging.support.MessageHeaderAccessor
org.springframework.integration.IntegrationMessageHeaderAccessor
public class IntegrationMessageHeaderAccessor
extends org.springframework.messaging.support.MessageHeaderAccessor
Adds standard SI Headers.
- Since:
- 4.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
A callback to acknowledge message delivery.static final String
static final String
static final String
static final String
static final String
static final String
static final String
Raw source message.static final String
static final String
static final String
static final String
static final String
Raw source message.Fields inherited from class org.springframework.messaging.support.MessageHeaderAccessor
DEFAULT_CHARSET
-
Constructor Summary
ConstructorDescriptionIntegrationMessageHeaderAccessor
(org.springframework.messaging.Message<?> message) -
Method Summary
Modifier and TypeMethodDescriptionReturn the acknowledgment callback, if present.If the payload was created by aCloseable
that needs to remain open until the payload is consumed, the resource will be added to this header.When a message-driven endpoint supports retry implicitly, this header is incremented for each delivery attempt.<T> T
reactor.util.context.ContextView
Get aContextView
header if present.int
int
<T> T
Get the source data header, if present.boolean
isReadOnly
(String headerName) void
setReadOnlyHeaders
(String... readOnlyHeaders) Specify a list of headers which should be considered as read only and prohibited from being populated in the message.toMap()
protected void
verifyType
(String headerName, Object headerValue) Methods inherited from class org.springframework.messaging.support.MessageHeaderAccessor
copyHeaders, copyHeadersIfAbsent, createAccessor, getAccessor, getAccessor, getAccessor, getContentType, getDetailedLogMessage, getDetailedPayloadLogMessage, getErrorChannel, getHeader, getId, getMessageHeaders, getMutableAccessor, getReplyChannel, getShortLogMessage, getShortPayloadLogMessage, getTimestamp, isModified, isMutable, isReadableContentType, removeHeader, removeHeaders, setContentType, setErrorChannel, setErrorChannelName, setHeader, setHeaderIfAbsent, setImmutable, setLeaveMutable, setModified, setReplyChannel, setReplyChannelName, toMessageHeaders, toString
-
Field Details
-
CORRELATION_ID
- See Also:
-
EXPIRATION_DATE
- See Also:
-
PRIORITY
- See Also:
-
SEQUENCE_NUMBER
- See Also:
-
SEQUENCE_SIZE
- See Also:
-
SEQUENCE_DETAILS
- See Also:
-
ROUTING_SLIP
- See Also:
-
DUPLICATE_MESSAGE
- See Also:
-
CLOSEABLE_RESOURCE
- See Also:
-
DELIVERY_ATTEMPT
- See Also:
-
ACKNOWLEDGMENT_CALLBACK
A callback to acknowledge message delivery. The type of the header value depends on the context in which the header is used. See the reference manual for more information.- See Also:
-
SOURCE_DATA
Raw source message.- See Also:
-
REACTOR_CONTEXT
Raw source message.- See Also:
-
-
Constructor Details
-
IntegrationMessageHeaderAccessor
public IntegrationMessageHeaderAccessor(@Nullable org.springframework.messaging.Message<?> message)
-
-
Method Details
-
setReadOnlyHeaders
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 forreadOnly
mode. Defaults toMessageHeaders.ID
andMessageHeaders.TIMESTAMP
.- Since:
- 4.3.2
- See Also:
-
getExpirationDate
-
getCorrelationId
-
getSequenceNumber
public int getSequenceNumber() -
getSequenceSize
public int getSequenceSize() -
getPriority
-
getCloseableResource
If the payload was created by aCloseable
that needs to remain open until the payload is consumed, the resource will be added to this header. After the payload is consumed theCloseable
should be closed. Usually this must occur in an endpoint close to the message origin in the flow, and in the same JVM.- Returns:
- the
Closeable
. - Since:
- 4.3
-
getAcknowledgmentCallback
Return the acknowledgment callback, if present.- Returns:
- the callback.
- Since:
- 5.0.1
-
getDeliveryAttempt
When a message-driven endpoint supports retry implicitly, this header is incremented for each delivery attempt.- Returns:
- the delivery attempt.
- Since:
- 5.0.1
-
getSourceData
@Nullable public <T> T getSourceData()Get the source data header, if present.- Type Parameters:
T
- the data type.- Returns:
- the source header.
- Since:
- 5.1.6
-
getReactorContext
@Nullable public reactor.util.context.ContextView getReactorContext()Get aContextView
header if present.- Returns:
- the
ContextView
header if present. - Since:
- 6.0.5
-
getHeader
-
verifyType
- Overrides:
verifyType
in classorg.springframework.messaging.support.MessageHeaderAccessor
-
isReadOnly
- Overrides:
isReadOnly
in classorg.springframework.messaging.support.MessageHeaderAccessor
-
toMap
- Overrides:
toMap
in classorg.springframework.messaging.support.MessageHeaderAccessor
-