CAMEL-6723: Fixed Message history - Possible ArrayIndexOutOfBoundsException
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/19c96be7 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/19c96be7 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/19c96be7 Branch: refs/heads/camel-2.12.x Commit: 19c96be7b4bc7427d000d7a0e6daf301f46f8842 Parents: 3d1b979 Author: Claus Ibsen <davscl...@apache.org> Authored: Tue Sep 10 11:08:16 2013 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Sep 10 11:11:19 2013 +0200 ---------------------------------------------------------------------- .../org/apache/camel/impl/DefaultExchange.java | 9 +++ .../org/apache/camel/processor/Splitter.java | 2 + .../org/apache/camel/util/ExchangeHelper.java | 11 ++++ .../MessageHistoryCopyExchangeTest.java | 66 ++++++++++++++++++++ 4 files changed, 88 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/19c96be7/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java index b755b70..2c4a615 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java @@ -26,6 +26,7 @@ import org.apache.camel.Endpoint; import org.apache.camel.Exchange; import org.apache.camel.ExchangePattern; import org.apache.camel.Message; +import org.apache.camel.MessageHistory; import org.apache.camel.spi.Synchronization; import org.apache.camel.spi.UnitOfWork; import org.apache.camel.util.ExchangeHelper; @@ -95,10 +96,18 @@ public final class DefaultExchange implements Exchange { return exchange; } + @SuppressWarnings("unchecked") private static Map<String, Object> safeCopy(Map<String, Object> properties) { if (properties == null) { return null; } + + // safe copy message history using a defensive copy + List<MessageHistory> history = (List<MessageHistory>) properties.remove(Exchange.MESSAGE_HISTORY); + if (history != null) { + properties.put(Exchange.MESSAGE_HISTORY, new ArrayList<MessageHistory>(history)); + } + return new ConcurrentHashMap<String, Object>(properties); } http://git-wip-us.apache.org/repos/asf/camel/blob/19c96be7/camel-core/src/main/java/org/apache/camel/processor/Splitter.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/Splitter.java b/camel-core/src/main/java/org/apache/camel/processor/Splitter.java index 76b5e02..a9dd334 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/Splitter.java +++ b/camel-core/src/main/java/org/apache/camel/processor/Splitter.java @@ -252,6 +252,8 @@ public class Splitter extends MulticastProcessor implements AsyncProcessor, Trac Exchange answer = ExchangeHelper.createCopy(exchange, preserveExchangeId); // we do not want attachments for the splitted sub-messages answer.getIn().setAttachments(null); + // we do not want to copy the message history for splitted sub-messages + answer.getProperties().remove(Exchange.MESSAGE_HISTORY); return answer; } } http://git-wip-us.apache.org/repos/asf/camel/blob/19c96be7/camel-core/src/main/java/org/apache/camel/util/ExchangeHelper.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/ExchangeHelper.java b/camel-core/src/main/java/org/apache/camel/util/ExchangeHelper.java index b6f04d8..bc9943d 100644 --- a/camel-core/src/main/java/org/apache/camel/util/ExchangeHelper.java +++ b/camel-core/src/main/java/org/apache/camel/util/ExchangeHelper.java @@ -16,7 +16,9 @@ */ package org.apache.camel.util; +import java.util.ArrayList; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ExecutionException; @@ -32,6 +34,7 @@ import org.apache.camel.Exchange; import org.apache.camel.ExchangePattern; import org.apache.camel.InvalidPayloadException; import org.apache.camel.Message; +import org.apache.camel.MessageHistory; import org.apache.camel.NoSuchBeanException; import org.apache.camel.NoSuchEndpointException; import org.apache.camel.NoSuchHeaderException; @@ -813,10 +816,18 @@ public final class ExchangeHelper { return answer; } + @SuppressWarnings("unchecked") private static Map<String, Object> safeCopy(Map<String, Object> properties) { if (properties == null) { return null; } + + // safe copy message history using a defensive copy + List<MessageHistory> history = (List<MessageHistory>) properties.remove(Exchange.MESSAGE_HISTORY); + if (history != null) { + properties.put(Exchange.MESSAGE_HISTORY, new ArrayList<MessageHistory>(history)); + } + return new ConcurrentHashMap<String, Object>(properties); } } http://git-wip-us.apache.org/repos/asf/camel/blob/19c96be7/camel-core/src/test/java/org/apache/camel/processor/MessageHistoryCopyExchangeTest.java ---------------------------------------------------------------------- diff --git a/camel-core/src/test/java/org/apache/camel/processor/MessageHistoryCopyExchangeTest.java b/camel-core/src/test/java/org/apache/camel/processor/MessageHistoryCopyExchangeTest.java new file mode 100644 index 0000000..3628f87 --- /dev/null +++ b/camel-core/src/test/java/org/apache/camel/processor/MessageHistoryCopyExchangeTest.java @@ -0,0 +1,66 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.processor; + +import java.util.List; + +import org.apache.camel.ContextTestSupport; +import org.apache.camel.Exchange; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.mock.MockEndpoint; + +/** + * @version + */ +public class MessageHistoryCopyExchangeTest extends ContextTestSupport { + + public void testDefensiveCopyOfMessageHistory() throws Exception { + MockEndpoint a = getMockEndpoint("mock:a"); + a.expectedMessageCount(1); + MockEndpoint b = getMockEndpoint("mock:b"); + b.expectedMessageCount(1); + + template.sendBody("seda:start", "Hello World"); + + assertMockEndpointsSatisfied(); + + List listA = (List) a.getReceivedExchanges().get(0).getProperty(Exchange.MESSAGE_HISTORY); + List listB = (List) b.getReceivedExchanges().get(0).getProperty(Exchange.MESSAGE_HISTORY); + + assertNotSame(listA, listB); + } + + @Override + protected RouteBuilder createRouteBuilder() throws Exception { + return new RouteBuilder() { + @Override + public void configure() throws Exception { + context.setMessageHistory(true); + + from("seda:start") + .to("log:foo") + .to("mock:a") + .to("direct:bar") + .to("mock:b"); + + from("direct:bar") + .to("log:bar") + .to("mock:bar"); + } + }; + } +}
