Author: davsclaus
Date: Fri May  6 10:46:53 2011
New Revision: 1100166

URL: http://svn.apache.org/viewvc?rev=1100166&view=rev
Log:
CAMEL-3949: Sending message to log endpoint should not convert payload to 
StreamCache. Added showStreams options to log endpoint.

Added:
    
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogInputStreamTest.java
      - copied, changed from r1100070, 
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogEndpointTest.java
Modified:
    
camel/trunk/camel-core/src/main/java/org/apache/camel/component/log/LogFormatter.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultMessage.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/util/MessageHelper.java
    
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/LogDebugBodyStreamsTest.java

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/component/log/LogFormatter.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/component/log/LogFormatter.java?rev=1100166&r1=1100165&r2=1100166&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/component/log/LogFormatter.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/component/log/LogFormatter.java
 Fri May  6 10:46:53 2011
@@ -22,8 +22,8 @@ import java.util.concurrent.Future;
 
 import org.apache.camel.Exchange;
 import org.apache.camel.Message;
-import org.apache.camel.StreamCache;
 import org.apache.camel.spi.ExchangeFormatter;
+import org.apache.camel.util.MessageHelper;
 import org.apache.camel.util.ObjectHelper;
 
 /**
@@ -44,6 +44,7 @@ public class LogFormatter implements Exc
     private boolean showAll;
     private boolean multiline;
     private boolean showFuture;
+    private boolean showStreams;
     private int maxChars;
 
     public String format(Exchange exchange) {
@@ -291,6 +292,19 @@ public class LogFormatter implements Exc
         this.showExchangePattern = showExchangePattern;
     }
 
+    public boolean isShowStreams() {
+        return showStreams;
+    }
+
+    /**
+     * If enabled Camel will output stream objects
+     * <p/>
+     * Is default disabled.
+     */
+    public void setShowStreams(boolean showStreams) {
+        this.showStreams = showStreams;
+    }
+
     // Implementation methods
     //-------------------------------------------------------------------------
     protected Object getBodyAsString(Message message) {
@@ -301,21 +315,8 @@ public class LogFormatter implements Exc
             }
         }
 
-        StreamCache newBody = message.getBody(StreamCache.class);
-        if (newBody != null) {
-            message.setBody(newBody);
-        }
-
-        Object answer = message.getBody(String.class);
-        if (answer == null) {
-            answer = message.getBody();
-        }
-
-        if (newBody != null) {
-            // Reset the StreamCache
-            newBody.reset();
-        }
-        return answer;
+        // is the body a stream cache then we can log it
+        return MessageHelper.extractBodyForLogging(message, "", 
isShowStreams(), -1);
     }
 
     protected Object getBodyTypeAsString(Message message) {

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java?rev=1100166&r1=1100165&r2=1100166&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultExchange.java 
Fri May  6 10:46:53 2011
@@ -128,8 +128,16 @@ public final class DefaultExchange imple
         return answer != null ? answer : defaultValue;
     }
 
+    @SuppressWarnings("unchecked")
     public <T> T getProperty(String name, Class<T> type) {
         Object value = getProperty(name);
+        if (value == null) {
+            // lets avoid NullPointerException when converting to boolean for 
null values
+            if (boolean.class.isAssignableFrom(type)) {
+                return (T) Boolean.FALSE;
+            }
+            return null;
+        }
 
         // eager same instance type test to avoid the overhead of invoking the 
type converter
         // if already same type
@@ -140,8 +148,16 @@ public final class DefaultExchange imple
         return ExchangeHelper.convertToType(this, type, value);
     }
 
+    @SuppressWarnings("unchecked")
     public <T> T getProperty(String name, Object defaultValue, Class<T> type) {
         Object value = getProperty(name, defaultValue);
+        if (value == null) {
+            // lets avoid NullPointerException when converting to boolean for 
null values
+            if (boolean.class.isAssignableFrom(type)) {
+                return (T) Boolean.FALSE;
+            }
+            return null;
+        }
 
         // eager same instance type test to avoid the overhead of invoking the 
type converter
         // if already same type

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=1100166&r1=1100165&r2=1100166&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 
Fri May  6 10:46:53 2011
@@ -77,7 +77,6 @@ public class DefaultMessage extends Mess
     @SuppressWarnings("unchecked")
     public <T> T getHeader(String name, Class<T> type) {
         Object value = getHeader(name);
-
         if (value == null) {
             // lets avoid NullPointerException when converting to boolean for 
null values
             if (boolean.class.isAssignableFrom(type)) {
@@ -100,8 +99,16 @@ public class DefaultMessage extends Mess
         }
     }
 
+    @SuppressWarnings("unchecked")
     public <T> T getHeader(String name, Object defaultValue, Class<T> type) {
         Object value = getHeader(name, defaultValue);
+        if (value == null) {
+            // lets avoid NullPointerException when converting to boolean for 
null values
+            if (boolean.class.isAssignableFrom(type)) {
+                return (T) Boolean.FALSE;
+            }
+            return null;
+        }
 
         // eager same instance type test to avoid the overhead of invoking the 
type converter
         // if already same type

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/util/MessageHelper.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/util/MessageHelper.java?rev=1100166&r1=1100165&r2=1100166&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/util/MessageHelper.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/util/MessageHelper.java 
Fri May  6 10:46:53 2011
@@ -125,18 +125,29 @@ public final class MessageHelper {
      * Extracts the body for logging purpose.
      * <p/>
      * Will clip the body if its too big for logging.
+     * Will prepend the message with <tt>Message: </tt>
      *
+     * @see org.apache.camel.Exchange#LOG_DEBUG_BODY_STREAMS
      * @see org.apache.camel.Exchange#LOG_DEBUG_BODY_MAX_CHARS
      * @param message the message
      * @return the logging message
      */
     public static String extractBodyForLogging(Message message) {
-        Object obj = message.getBody();
-        if (obj == null) {
-            return "Message: [Body is null]";
-        }
+        return extractBodyForLogging(message, "Message: ");
+    }
 
-        // do not log streams by default
+    /**
+     * Extracts the body for logging purpose.
+     * <p/>
+     * Will clip the body if its too big for logging.
+     *
+     * @see org.apache.camel.Exchange#LOG_DEBUG_BODY_STREAMS
+     * @see org.apache.camel.Exchange#LOG_DEBUG_BODY_MAX_CHARS
+     * @param message the message
+     * @param prepend a message to prepend
+     * @return the logging message
+     */
+    public static String extractBodyForLogging(Message message, String 
prepend) {
         boolean streams = false;
         if (message.getExchange() != null) {
             String property = 
message.getExchange().getContext().getProperties().get(Exchange.LOG_DEBUG_BODY_STREAMS);
@@ -145,41 +156,83 @@ public final class MessageHelper {
             }
         }
 
-        if (obj instanceof StringSource || obj instanceof BytesSource) {
-            // these two are okay
-        } else if (!streams && obj instanceof StreamSource) {
-            return "Message: [Body is instance of 
java.xml.transform.StreamSource]";
-        } else if (!streams && obj instanceof InputStream) {
-            return "Message: [Body is instance of java.io.InputStream]";
-        } else if (!streams && obj instanceof OutputStream) {
-            return "Message: [Body is instance of java.io.OutputStream]";
-        } else if (!streams && obj instanceof Reader) {
-            return "Message: [Body is instance of java.io.Reader]";
-        } else if (!streams && obj instanceof Writer) {
-            return "Message: [Body is instance of java.io.Writer]";
-        }
-
         // default to 1000 chars
-        int length = 1000;
+        int maxChars = 1000;
 
         if (message.getExchange() != null) {
             String property = 
message.getExchange().getContext().getProperties().get(Exchange.LOG_DEBUG_BODY_MAX_CHARS);
             if (property != null) {
-                length = 
message.getExchange().getContext().getTypeConverter().convertTo(Integer.class, 
property);
+                maxChars = 
message.getExchange().getContext().getTypeConverter().convertTo(Integer.class, 
property);
             }
         }
+        return extractBodyForLogging(message, prepend, streams, maxChars);
+    }
+
+    /**
+     * Extracts the body for logging purpose.
+     * <p/>
+     * Will clip the body if its too big for logging.
+     *
+     * @see org.apache.camel.Exchange#LOG_DEBUG_BODY_MAX_CHARS
+     * @param message the message
+     * @param prepend a message to prepend
+     * @param allowStreams whether or not streams is allowed
+     * @param maxChars limit to maximum number of chars. Use 0 or negative 
value to not limit at all.
+     * @return the logging message
+     */
+    public static String extractBodyForLogging(Message message, String 
prepend, boolean allowStreams, int maxChars) {
+        Object obj = message.getBody();
+        if (obj == null) {
+            return prepend + "[Body is null]";
+        }
+
+        if (obj instanceof StringSource || obj instanceof BytesSource) {
+            // these two are okay
+        } else if (!allowStreams && obj instanceof StreamCache) {
+            return prepend + "[Body is instance of 
org.apache.camel.StreamCache]";
+        } else if (!allowStreams && obj instanceof StreamSource) {
+            return prepend + "[Body is instance of 
java.xml.transform.StreamSource]";
+        } else if (!allowStreams && obj instanceof InputStream) {
+            return prepend + "[Body is instance of java.io.InputStream]";
+        } else if (!allowStreams && obj instanceof OutputStream) {
+            return prepend + "[Body is instance of java.io.OutputStream]";
+        } else if (!allowStreams && obj instanceof Reader) {
+            return prepend + "[Body is instance of java.io.Reader]";
+        } else if (!allowStreams && obj instanceof Writer) {
+            return prepend + "[Body is instance of java.io.Writer]";
+        }
+
+        // is the body a stream cache
+        StreamCache cache;
+        if (obj instanceof StreamCache) {
+            cache = (StreamCache) obj;
+        } else {
+            cache = null;
+        }
+
+        // grab the message body as a string
+        String body;
+        if (message.getExchange() != null) {
+            body = 
message.getExchange().getContext().getTypeConverter().convertTo(String.class, 
obj);
+        } else {
+            body = obj.toString();
+        }
+
+        // reset stream cache after use
+        if (cache != null) {
+            cache.reset();
+        }
 
-        String body = obj.toString();
         if (body == null) {
-            return "Message: [Body is null]";
+            return prepend + "[Body is null]";
         }
 
         // clip body if length enabled and the body is too big
-        if (length > 0 && body.length() > length) {
-            body = body.substring(0, length) + "... [Body clipped after " + 
length + " chars, total length is " + body.length() + "]";
+        if (maxChars > 0 && body.length() > maxChars) {
+            body = body.substring(0, maxChars) + "... [Body clipped after " + 
maxChars + " chars, total length is " + body.length() + "]";
         }
 
-        return "Message: " + body;
+        return prepend + body;
     }
 
 }

Copied: 
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogInputStreamTest.java
 (from r1100070, 
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogEndpointTest.java)
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogInputStreamTest.java?p2=camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogInputStreamTest.java&p1=camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogEndpointTest.java&r1=1100070&r2=1100166&rev=1100166&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogEndpointTest.java
 (original)
+++ 
camel/trunk/camel-core/src/test/java/org/apache/camel/component/log/LogInputStreamTest.java
 Fri May  6 10:46:53 2011
@@ -16,42 +16,60 @@
  */
 package org.apache.camel.component.log;
 
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+
 import org.apache.camel.ContextTestSupport;
-import org.apache.camel.Exchange;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
-import org.apache.camel.processor.CamelLogger;
 
 /**
  * @version 
  */
-public class LogEndpointTest extends ContextTestSupport {
+public class LogInputStreamTest extends ContextTestSupport {
 
-    private static Exchange logged;
+    public void testA() throws Exception {
+        MockEndpoint mock = getMockEndpoint("mock:a");
+        mock.expectedBodiesReceived("Hello World");
 
-    private class MyLogger extends CamelLogger {
+        InputStream is = new ByteArrayInputStream("Hello World".getBytes());
+        template.sendBody("direct:a", is);
 
-        @Override
-        public void process(Exchange exchange) {
-            super.process(exchange);
-            logged = exchange;
-        }
-
-        @Override
-        public String toString() {
-            return "myLogger";
-        }
+        assertMockEndpointsSatisfied();
     }
 
-    public void testLogEndpoint() throws Exception {
-        MockEndpoint mock = getMockEndpoint("mock:result");
+    public void testB() throws Exception {
+        MockEndpoint mock = getMockEndpoint("mock:b");
         mock.expectedMessageCount(1);
+        // showStreams is enabled so we cannot re-read the input stream
+        mock.message(0).body(String.class).isEqualTo("");
 
-        template.sendBody("direct:start", "Hello World");
+        InputStream is = new ByteArrayInputStream("Hello World".getBytes());
+        template.sendBody("direct:b", is);
 
         assertMockEndpointsSatisfied();
+    }
+
+    public void testC() throws Exception {
+        MockEndpoint mock = getMockEndpoint("mock:c");
+        mock.expectedMessageCount(1);
+        mock.expectedBodiesReceived("Hello World");
+
+        InputStream is = new ByteArrayInputStream("Hello World".getBytes());
+        template.sendBody("direct:c", is);
 
-        assertNotNull(logged);
+        assertMockEndpointsSatisfied();
+    }
+
+    public void testD() throws Exception {
+        MockEndpoint mock = getMockEndpoint("mock:d");
+        mock.expectedMessageCount(1);
+        mock.expectedBodiesReceived("Hello World");
+
+        InputStream is = new ByteArrayInputStream("Hello World".getBytes());
+        template.sendBody("direct:d", is);
+
+        assertMockEndpointsSatisfied();
     }
 
     @Override
@@ -59,14 +77,21 @@ public class LogEndpointTest extends Con
         return new RouteBuilder() {
             @Override
             public void configure() throws Exception {
-                LogEndpoint end = new LogEndpoint();
-                end.setCamelContext(context);
-                end.setLogger(new MyLogger());
-
-                assertEquals("log:myLogger", end.getEndpointUri());
-                assertNotNull(end.getLogger());
-
-                from("direct:start").to(end).to("mock:result");
+                from("direct:a")
+                    .to("log:a")
+                    .to("mock:a");
+
+                from("direct:b")
+                    .to("log:b?showStreams=true")
+                    .to("mock:b");
+
+                from("direct:c").streamCaching()
+                    .to("log:c")
+                    .to("mock:c");
+
+                from("direct:d").streamCaching()
+                    .to("log:d?showStreams=true")
+                    .to("mock:d");
             }
         };
     }

Modified: 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/LogDebugBodyStreamsTest.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/impl/LogDebugBodyStreamsTest.java?rev=1100166&r1=1100165&r2=1100166&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/LogDebugBodyStreamsTest.java
 (original)
+++ 
camel/trunk/camel-core/src/test/java/org/apache/camel/impl/LogDebugBodyStreamsTest.java
 Fri May  6 10:46:53 2011
@@ -44,7 +44,7 @@ public class LogDebugBodyStreamsTest ext
 
         // should be logged anyway
         String msg = mock.getReceivedExchanges().get(0).getIn().toString();
-        assertEquals("Message: StringSource[<?xml 
version=\"1.0\"?><person><name>Claus</name></person>]", msg);
+        assertEquals("Message: <?xml 
version=\"1.0\"?><person><name>Claus</name></person>", msg);
     }
 
     public void testLogBodyStreamStringSourceDisabledByDefault() throws 
Exception {
@@ -61,7 +61,7 @@ public class LogDebugBodyStreamsTest ext
 
         // should be logged anyway
         String msg = mock.getReceivedExchanges().get(0).getIn().toString();
-        assertEquals("Message: StringSource[<?xml 
version=\"1.0\"?><person><name>Claus</name></person>]", msg);
+        assertEquals("Message: <?xml 
version=\"1.0\"?><person><name>Claus</name></person>", msg);
     }
 
     public void testLogBodyStreamStringSourceEnabled() throws Exception {
@@ -78,7 +78,7 @@ public class LogDebugBodyStreamsTest ext
 
         // should be logged anyway
         String msg = mock.getReceivedExchanges().get(0).getIn().toString();
-        assertEquals("Message: StringSource[<?xml 
version=\"1.0\"?><person><name>Claus</name></person>]", msg);
+        assertEquals("Message: <?xml 
version=\"1.0\"?><person><name>Claus</name></person>", msg);
     }
 
     public void testLogBodyStreamDisabled() throws Exception {


Reply via email to