Author: davsclaus
Date: Mon Jan  3 08:51:12 2011
New Revision: 1054558

URL: http://svn.apache.org/viewvc?rev=1054558&view=rev
Log:
CAMEL-3429: Added excludePattern parameter to removeHeaders DSL. Thanks to 
Richard Kettelerij for the patch.

Added:
    
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersExcludeTest.java
      - copied, changed from r1054538, 
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersTest.java
    
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersExcludeTest.java
      - copied, changed from r1054538, 
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersTest.java
    
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeadersExclude.xml
      - copied, changed from r1054538, 
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeaders.xml
Modified:
    camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/builder/ProcessorBuilder.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java
    
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/DefaultMessageHeaderTest.java

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Message.java Mon Jan  
3 08:51:12 2011
@@ -133,6 +133,16 @@ public interface Message {
      * @return boolean whether any headers matched
      */
     boolean removeHeaders(String pattern);
+    
+    /**
+     * Removes the headers from this message that match the given 
<tt>pattern</tt>, 
+     * except for the ones matching one ore more <tt>exceptionPatterns</tt>
+     * 
+     * @param pattern pattern of names that should be removed
+     * @param excludePatterns one or more pattern of header names that should 
be excluded (= preserved)
+     * @return boolean whether any headers matched
+     */ 
+    boolean removeHeaders(String pattern, String... excludePatterns);
 
     /**
      * Returns all of the headers associated with the message.

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/builder/ProcessorBuilder.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/builder/ProcessorBuilder.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/builder/ProcessorBuilder.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/builder/ProcessorBuilder.java
 Mon Jan  3 08:51:12 2011
@@ -16,6 +16,8 @@
  */
 package org.apache.camel.builder;
 
+import java.util.Arrays;
+
 import org.apache.camel.Exchange;
 import org.apache.camel.Expression;
 import org.apache.camel.Processor;
@@ -185,6 +187,22 @@ public final class ProcessorBuilder {
             }
         };
     }
+    
+    /**
+     * Removes all headers on the IN message, except for the ones provided in 
the <tt>names</tt> parameter
+     */
+    public static Processor removeHeaders(final String pattern, final 
String... exceptionPatterns) {
+        return new Processor() {
+            public void process(Exchange exchange) {
+                exchange.getIn().removeHeaders(pattern, exceptionPatterns);
+            }
+
+            @Override
+            public String toString() {
+                return "removeHeaders(" + pattern + ", " + 
Arrays.toString(exceptionPatterns) + ")";
+            }
+        };
+    }
 
     /**
      * Removes the header on the FAULT message

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java 
Mon Jan  3 08:51:12 2011
@@ -128,6 +128,10 @@ public class DefaultMessage extends Mess
     }
 
     public boolean removeHeaders(String pattern) {
+        return removeHeaders(pattern, (String[]) null);
+    }
+
+    public boolean removeHeaders(String pattern, String... excludePatterns) {
         if (!hasHeaders()) {
             return false;
         }
@@ -136,13 +140,26 @@ public class DefaultMessage extends Mess
         for (Map.Entry<String, Object> entry : headers.entrySet()) {
             String key = entry.getKey();
             if (EndpointHelper.matchPattern(key, pattern)) {
+                if (excludePatterns != null && isExcludePatternMatch(key, 
excludePatterns)) {
+                    continue;
+                }
                 matches = true;
                 headers.remove(entry.getKey());
             }
+
         }
         return matches;
     }
 
+    private boolean isExcludePatternMatch(String key, String... 
excludePatterns) {
+        for (String pattern : excludePatterns) {
+            if (EndpointHelper.matchPattern(key, pattern)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     public Map<String, Object> getHeaders() {
         if (headers == null) {
             headers = createHeaders();

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java
 Mon Jan  3 08:51:12 2011
@@ -2424,6 +2424,20 @@ public abstract class ProcessorDefinitio
     }
 
     /**
+     * Adds a processor which removes the headers on the IN message
+     *
+     * @param pattern  a pattern to match header names to be removed
+     * @param excludePatterns one or more pattern of header names that should 
be excluded (= preserved)
+     * @return the builder
+     */
+    @SuppressWarnings("unchecked")
+    public Type removeHeaders(String pattern, String... excludePatterns) {
+        RemoveHeadersDefinition answer = new RemoveHeadersDefinition(pattern, 
excludePatterns);
+        addOutput(answer);
+        return (Type) this;
+    }
+
+    /**
      * Adds a processor which removes the header on the FAULT message
      *
      * @param name  the header name

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/model/RemoveHeadersDefinition.java
 Mon Jan  3 08:51:12 2011
@@ -20,6 +20,7 @@ import javax.xml.bind.annotation.XmlAcce
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlTransient;
 
 import org.apache.camel.Processor;
 import org.apache.camel.builder.ProcessorBuilder;
@@ -34,6 +35,11 @@ import org.apache.camel.util.ObjectHelpe
 public class RemoveHeadersDefinition extends 
OutputDefinition<RemoveHeadersDefinition> {
     @XmlAttribute(required = true)
     private String pattern;
+    @XmlAttribute(required = false)
+    private String excludePattern;
+    // in XML we cannot use String[] for attributes, so we provide a single 
attribute instead
+    @XmlTransient
+    private String[] excludePatterns;
 
     public RemoveHeadersDefinition() {
     }
@@ -41,6 +47,11 @@ public class RemoveHeadersDefinition ext
     public RemoveHeadersDefinition(String pattern) {
         setPattern(pattern);
     }
+    
+    public RemoveHeadersDefinition(String pattern, String... excludePatterns) {
+        setPattern(pattern);
+        setExcludePatterns(excludePatterns);
+    }
 
     @Override
     public String toString() {
@@ -60,7 +71,13 @@ public class RemoveHeadersDefinition ext
     @Override
     public Processor createProcessor(RouteContext routeContext) throws 
Exception {
         ObjectHelper.notNull(getPattern(), "patterns", this);
-        return ProcessorBuilder.removeHeaders(getPattern());
+        if (getExcludePatterns() != null) {
+            return ProcessorBuilder.removeHeaders(getPattern(), 
getExcludePatterns());
+        } else if (getExcludePattern() != null) {
+            return ProcessorBuilder.removeHeaders(getPattern(), 
getExcludePattern());
+        } else {
+            return ProcessorBuilder.removeHeaders(getPattern());
+        }
     }
 
     public void setPattern(String pattern) {
@@ -70,4 +87,20 @@ public class RemoveHeadersDefinition ext
     public String getPattern() {
         return pattern;
     }
+
+    public String[] getExcludePatterns() {
+        return excludePatterns;
+    }
+
+    public void setExcludePatterns(String[] excludePatterns) {
+        this.excludePatterns = excludePatterns;
+    }
+
+    public String getExcludePattern() {
+        return excludePattern;
+    }
+
+    public void setExcludePattern(String excludePattern) {
+        this.excludePattern = excludePattern;
+    }
 }
\ No newline at end of file

Modified: 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/DefaultMessageHeaderTest.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/impl/DefaultMessageHeaderTest.java?rev=1054558&r1=1054557&r2=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/DefaultMessageHeaderTest.java
 (original)
+++ 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/DefaultMessageHeaderTest.java
 Mon Jan  3 08:51:12 2011
@@ -128,6 +128,151 @@ public class DefaultMessageHeaderTest ex
         assertTrue(msg.getHeaders().isEmpty());
     }
 
+    public void testRemoveHeaderWithNullArg() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+
+        msg.removeHeader(null);
+
+        assertFalse(msg.getHeaders().isEmpty());
+    }
+
+    public void testRemoveHeaderWithNullValue() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", null);
+        msg.removeHeader("tick");
+
+        assertTrue(msg.getHeaders().isEmpty());
+    }
+
+    public void testRemoveHeadersWithWildcard() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+
+        msg.removeHeaders("t*");
+
+        assertTrue(msg.getHeaders().isEmpty());
+    }
+
+    public void testRemoveHeadersAllWithWildcard() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+
+        msg.removeHeaders("*");
+
+        assertTrue(msg.getHeaders().isEmpty());
+    }
+
+    public void testRemoveHeadersWithExclude() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tiack", "blaa");
+        msg.setHeader("tiock", "blaaa");
+        msg.setHeader("tiuck", "blaaaa");
+
+        msg.removeHeaders("ti*", "tiuck", "tiack");
+
+        assertEquals(2, msg.getHeaders().size());
+        assertEquals("blaa", msg.getHeader("tiack"));
+        assertEquals("blaaaa", msg.getHeader("tiuck"));
+    }
+
+    public void testRemoveHeadersAllWithExclude() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+
+        msg.removeHeaders("*", "tick", "tock", "toe");
+
+        // new message headers
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals(null, msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+    }
+
+    public void testRemoveHeadersWithWildcardInExclude() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("taick", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        msg.removeHeaders("*", "ta*");
+
+        assertEquals(2, msg.getHeaders().size());
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaa", msg.getHeader("taick"));
+    }
+
+    public void testRemoveHeadersWithNulls() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+        msg.setHeader("taack", "blaaaa");
+
+        assertEquals("bla", msg.getHeader("tick"));
+        assertEquals("blaa", msg.getHeader("tack"));
+        assertEquals("blaaa", msg.getHeader("tock"));
+        assertEquals("blaaaa", msg.getHeader("taack"));
+
+        msg.removeHeaders(null, null, null, null);
+
+        assertFalse(msg.getHeaders().isEmpty());
+    }
+
+    public void testRemoveHeadersWithNonExcludeHeaders() {
+        Message msg = new DefaultMessage();
+        assertNull(msg.getHeader("foo"));
+
+        msg.setHeader("tick", "bla");
+        msg.setHeader("tack", "blaa");
+        msg.setHeader("tock", "blaaa");
+
+        msg.removeHeaders("*", "camels", "are", "fun");
+
+        assertTrue(msg.getHeaders().isEmpty());
+    }
+
     public void testWithDefaults() {
         DefaultMessage msg = new DefaultMessage();
         // must have exchange so to leverage the type converters
@@ -144,8 +289,6 @@ public class DefaultMessageHeaderTest ex
         assertEquals(null, msg.getHeader("beer"));
         assertEquals("foo", msg.getHeader("beer", "foo"));
         assertEquals(Integer.valueOf(123), msg.getHeader("beer", "123", 
Integer.class));
-
     }
 
-
-}
\ No newline at end of file
+}

Copied: 
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersExcludeTest.java
 (from r1054538, 
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersTest.java)
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersExcludeTest.java?p2=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersExcludeTest.java&p1=camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersTest.java&r1=1054538&r2=1054558&rev=1054558&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersTest.java
 (original)
+++ 
camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RemoveHeadersExcludeTest.java
 Mon Jan  3 08:51:12 2011
@@ -23,7 +23,7 @@ import org.apache.camel.ContextTestSuppo
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
 
-public class RemoveHeadersTest extends ContextTestSupport {
+public class RemoveHeadersExcludeTest extends ContextTestSupport {
 
     public void testRemoveHeadersWildcard() throws Exception {
         MockEndpoint mock = getMockEndpoint("mock:end");
@@ -48,6 +48,7 @@ public class RemoveHeadersTest extends C
         mock.expectedBodiesReceived("Hello World");
         mock.expectedHeaderReceived("duck", "Donald");
         mock.expectedHeaderReceived("BeerHeineken", "Good");
+        mock.expectedHeaderReceived("BeerTuborg", "Also Great");
 
         Map<String, Object> headers = new HashMap<String, Object>();
         headers.put("dudeCool", "cool");
@@ -61,7 +62,7 @@ public class RemoveHeadersTest extends C
 
         assertMockEndpointsSatisfied();
 
-        assertEquals(2, 
mock.getReceivedExchanges().get(0).getIn().getHeaders().size());
+        assertEquals(3, 
mock.getReceivedExchanges().get(0).getIn().getHeaders().size());
     }
 
     protected RouteBuilder createRouteBuilder() {
@@ -69,7 +70,8 @@ public class RemoveHeadersTest extends C
             public void configure() {
                 from("direct:start")
                     .removeHeaders("dude*")
-                    .removeHeaders("Beer(Carlsberg|Tuborg)")
+                    // remove all beers, excluding Heineken or Tuborg, which 
we want to keep
+                    .removeHeaders("Beer*", ".*Heineken.*", ".*Tuborg.*")
                     .removeHeaders("foo")
                     .to("mock:end");
             }

Copied: 
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersExcludeTest.java
 (from r1054538, 
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersTest.java)
URL: 
http://svn.apache.org/viewvc/camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersExcludeTest.java?p2=camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersExcludeTest.java&p1=camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersTest.java&r1=1054538&r2=1054558&rev=1054558&view=diff
==============================================================================
--- 
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersTest.java
 (original)
+++ 
camel/trunk/components/camel-spring/src/test/java/org/apache/camel/spring/processor/SpringRemoveHeadersExcludeTest.java
 Mon Jan  3 08:51:12 2011
@@ -17,14 +17,14 @@
 package org.apache.camel.spring.processor;
 
 import org.apache.camel.CamelContext;
-import org.apache.camel.processor.RemoveHeadersTest;
+import org.apache.camel.processor.RemoveHeadersExcludeTest;
 
 import static 
org.apache.camel.spring.processor.SpringTestHelper.createSpringCamelContext;
 
-public class SpringRemoveHeadersTest extends RemoveHeadersTest {
+public class SpringRemoveHeadersExcludeTest extends RemoveHeadersExcludeTest {
 
     protected CamelContext createCamelContext() throws Exception {
-        return createSpringCamelContext(this, 
"org/apache/camel/spring/processor/removeHeaders.xml");
+        return createSpringCamelContext(this, 
"org/apache/camel/spring/processor/removeHeadersExclude.xml");
     }
     
 }
\ No newline at end of file

Copied: 
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeadersExclude.xml
 (from r1054538, 
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeaders.xml)
URL: 
http://svn.apache.org/viewvc/camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeadersExclude.xml?p2=camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeadersExclude.xml&p1=camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeaders.xml&r1=1054538&r2=1054558&rev=1054558&view=diff
==============================================================================
--- 
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeaders.xml
 (original)
+++ 
camel/trunk/components/camel-spring/src/test/resources/org/apache/camel/spring/processor/removeHeadersExclude.xml
 Mon Jan  3 08:51:12 2011
@@ -27,8 +27,8 @@
             <from uri="direct:start"/>
             <!-- remove all dude headers by wildcard -->
             <removeHeaders pattern="dude*"/>
-            <!-- remove all Carlsberg or Tuborg headers using reg exp -->
-            <removeHeaders pattern="Beer(Carlsberg|Tuborg)"/>
+            <!-- remove all beers, excluding Heineken or Tuborg, which we want 
to keep -->
+            <removeHeaders pattern="Beer*" 
excludePattern="Beer(Heineken|Tuborg)"/>
             <!-- remove the header with the name foo -->
             <removeHeaders pattern="foo"/>
             <to uri="mock:end"/>


Reply via email to