Page History

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-stream</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

stream:in[?options]
stream:out[?options]
stream:err[?options]
stream:header[?options]

stream:file?fileName=/foo/bar.txt
stream:url[?options]

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{delay}} | {{0}} | Initial delay in milliseconds before consuming or producing the stream. |
| {{encoding}} | _JVM Default_ |  You can configure the encoding (is a [charset name|http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html]) to use text-based streams (for example, message body is a {{String}} object). If not provided, Camel uses the [JVM default Charset|http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html#defaultCharset()]. |
| {{promptMessage}} | {{null}} | Message prompt to use when reading from {{stream:in}}; for example, you could set this to {{Enter a command:}} |
| {{promptDelay}} | {{0}} | Optional delay in milliseconds before showing the message prompt. |
| {{initialPromptDelay}} | {{2000}} | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. |
| {{fileName}} | {{null}} | When using the {{stream:file}} URI format, this option specifies the filename to stream to/from. |
| {{url}} | {{null}} | When using the {{stream:url}} URI format, this option specifies the URL to stream to/from. The input/output stream will be opened using the [JDK URLConnection|http://docs.oracle.com/javase/6/docs/api/java/net/URLConnection.html] facility. |
| {{scanStream}} | {{false}} | To be used for continuously reading a stream such as the unix {{tail}} command. 
                               *Camel 2.4 to Camel 2.6:* will retry opening the file if it is overwritten, somewhat like {{tail --retry}} |
| {{retry}} | {{false}} | *Camel 2.7:* will retry opening the file if it's overwritten, somewhat like {{tail --retry}} |
| {{scanStreamDelay}} | {{0}} | Delay in milliseconds between read attempts when using {{scanStream}}. |
| {{groupLines}} | {{0}} | *Camel 2.5:* To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an [Exchange] with 10 lines, instead of 1 [Exchange] per line. |
| {{autoCloseCount}} | {{0}} | *Camel 2.10.0:* (2.9.3 and 2.8.6) Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another {{autoCloseCount}} batch. |
| {{closeOnDone}} | {{false}} | *Camel 2.11.0:* This option is used in combination with [Splitter] and streaming to the same file. The idea is to keep the stream open and only close when the [Splitter] is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files. |
{div}

// Route messages to the standard output.
from("direct:in").to("stream:out");

// Send String payload to the standard output.
// Message will be followed by the newline.
template.sendBody("direct:in", "Hello Text World");

// Send byte[] payload to the standard output.
// No newline will be added after the message.
template.sendBody("direct:in", "Hello Bytes World".getBytes());

{snippet:id=e1|lang=java|url=camel/trunk/components/camel-stream/src/test/java/org/apache/camel/component/stream/StreamHeaderTest.java}

from("stream:file?fileName=/server/logs/server.log&scanStream=true&scanStreamDelay=1000").to("bean:logService?method=parseLogLine");