Update documentation reflecting the recent changes to AmqpInboundChannelAdapter and its header copying behavior. [INT-2344]

[spring-operator]

Victor Romero opened INT-2344 and commented

When receiving a message AmqpInboundChannelAdapter will :

public void onMessage(Message message) {
	Object payload = messageConverter.fromMessage(message);
	Map<String, ?> headers = headerMapper.toHeadersFromRequest(message.getMessageProperties());
	sendMessage(MessageBuilder.withPayload(payload).copyHeaders(headers).build());
}

That headerMapper, usually DefaultAmqpHeaderMapper, will through AbstractHeaderMapper :

private Map<String, Object> toHeaders(T source, List<String> headerPatterns) {
	Map<String, Object> headers = new HashMap<String, Object>();
	Map<String, Object> standardHeaders = this.extractStandardHeaders(source);
	this.copyHeaders(this.standardHeaderPrefix, standardHeaders, headers, headerPatterns);
	Map<String, Object> userDefinedHeaders = this.extractUserDefinedHeaders(source);
	this.copyHeaders(this.userDefinedHeaderPrefix, userDefinedHeaders, headers, headerPatterns);
	return headers;
}

this.extractUserDefinedHeaders(source); extracts them correctly but this.copyHeaders(this.userDefinedHeaderPrefix, userDefinedHeaders, headers, headerPatterns); :

private <V> void copyHeaders(String prefix, Map<String, Object> source, Map<String, Object> target, List<String> headerPatterns) {
	if (!CollectionUtils.isEmpty(source)) {
		for (Map.Entry<String, Object> entry : source.entrySet()) {
			try {
				String headerName = this.addPrefixIfNecessary(prefix, entry.getKey());
				if (this.shouldMapHeader(headerName, headerPatterns)){
					target.put(headerName, entry.getValue());
	

will only copy the headers that matches the headerPatterns (amqp_appId, amqp_clusterId, amqp_contentEncoding, amqp_contentLength, amqp_contentType, amqp_correlationId, amqp_deliveryMode, amqp_deliveryTag, amqp_expiration, amqp_messageCount, amqp_messageId, amqp_receivedExchange, amqp_receivedRoutingKey, amqp_redelivered, amqp_replyTo, amqp_timestamp, amqp_type, amqp_userId)

private volatile List<String> requestHeaderNames = new ArrayList<String>();

private volatile List<String> replyHeaderNames = new ArrayList<String>();

protected AbstractHeaderMapper() {
	...
	this.requestHeaderNames.addAll(this.getStandardRequestHeaderNames());
	...
}

---

Affects: 2.0.5

[spring-operator]

Oleg Zhurakousky commented

Victor, please upgrade to at least 2.1.RC1 (the current one is RC2). This issue was adressed in RC1 (not only for AMQP but other adapters as well). Please see #6039 and let us know so we can resolve this as duplicate.

[spring-operator]

Oleg Zhurakousky commented

Also, in RC2 we've addressed another related issue #6291. So ideally if you can upgrade to RC2 and let us know that would be great.

[spring-operator]

Victor Romero commented

Sadly still happens after switching to RC2.

userDefinedHeaders is extracted correctly,

Map<String, Object> userDefinedHeaders = this.extractUserDefinedHeaders(source);
this.copyHeaders(this.userDefinedHeaderPrefix, userDefinedHeaders, headers, headerPatterns);

but it won't be copied to headers because of :

private <V> void copyHeaders(String prefix, Map<String, Object> source, Map<String, Object> target, List<String> headerPatterns) {
	...
	if (this.shouldMapHeader(headerName, headerPatterns)){

[spring-operator]

Oleg Zhurakousky commented

That's correct. Custom headers are not copied by default. You have to use copy-request-headers and/or copy-response-headers attributes on the adapters. If you want to copy all headers use wild card (e.g., copy-request-headers='*')

[spring-operator]

Mark Fisher commented

The actual names of those attributes are 'mapped-request-headers' and 'mapped-reply-headers', but otherwise what Oleg says above is correct: you should add a wildcard if you want everything to be mapped.

[spring-operator]

Victor Romero commented

I can't find copy-request-headers in the xsd's (probably my fault, I'll keep searching).

But if I should use them it's probably the case of changing the javadoc of the DefaultAmqpHeaderMapper.

Any user-defined headers within the AMQP
MessageProperties will also be copied from an AMQP Message to a Spring Integration
Message, and any other headers on a Spring Integration Message (beyond the standard
AMQP properties) will likewise be copied to an AMQP Message.

/**
 * Default implementation of {@link AmqpHeaderMapper}.
 * <p/>
 * This implementation copies AMQP properties (e.g. contentType) to and from
 * Spring Integration MessageHeaders. Any user-defined headers within the AMQP
 * MessageProperties will also be copied from an AMQP Message to a Spring Integration
 * Message, and any other headers on a Spring Integration Message (beyond the standard
 * AMQP properties) will likewise be copied to an AMQP Message.
 * <p/>
 * Constants for the AMQP header keys are defined in {@link AmqpHeaders}.

[spring-operator]

Mark Fisher commented

Setting the target version of this to 2.1 GA for tracking purposes even though it will most likely be resolved with "works as designed".

[spring-operator]

Oleg Zhurakousky commented

Sorry about it, I am far away from my computer ;)

[spring-operator]

Mark Fisher commented

@Victor please see my comment about the correct names of those attributes. Oleg mis-typed them.

@Oleg I'll assign this to you - he's correct that the JavaDoc needs to be updated (that was there before we refactored to use AbstractHeaderMapper with pattern-matching, etc).

[spring-operator]

Victor Romero commented

Thanks Mark and Oleg, mapped-request-headers works like a charm.

[spring-operator]

Oleg Zhurakousky commented

Cool, I'll change the javadoc and resolve it

[spring-operator]

Oleg Zhurakousky commented

Changing it to a documentation issue