camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [3/3] camel git commit: Added camel-stream docs to Gitbook
Date Wed, 08 Jun 2016 13:48:39 GMT
Added camel-stream docs to Gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/60e042ae
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/60e042ae
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/60e042ae

Branch: refs/heads/master
Commit: 60e042ae7d961bf9105bcffb901270703f1d87d5
Parents: ca0215d
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Wed Jun 8 15:48:01 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Wed Jun 8 15:48:01 2016 +0200

----------------------------------------------------------------------
 .../camel-stream/src/main/docs/stream.adoc      | 150 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 151 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/60e042ae/components/camel-stream/src/main/docs/stream.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stream/src/main/docs/stream.adoc b/components/camel-stream/src/main/docs/stream.adoc
new file mode 100644
index 0000000..8a6d563
--- /dev/null
+++ b/components/camel-stream/src/main/docs/stream.adoc
@@ -0,0 +1,150 @@
+[[Stream-StreamComponent]]
+Stream Component
+~~~~~~~~~~~~~~~~
+
+The *stream:* component provides access to the `System.in`, `System.out`
+and `System.err` streams as well as allowing streaming of file and URL.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<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-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-----------------------
+stream:in[?options]
+stream:out[?options]
+stream:err[?options]
+stream:header[?options]
+-----------------------
+
+In addition, the `file` and `url` endpoint URIs are supported:
+
+[source,java]
+---------------------------------
+stream:file?fileName=/foo/bar.txt
+stream:url[?options]
+---------------------------------
+
+If the `stream:header` URI is specified, the `stream` header is used to
+find the stream to write to. This option is available only for stream
+producers (that is, it cannot appear in `from()`).
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[Stream-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Stream component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Stream component supports 18 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| url | common |  | String | *Required* 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 facility.
+| encoding | common |  | String | You can configure the encoding (is a charset name) to use
text-based streams (for example message body is a String object). If not provided Camel uses
the JVM default Charset.
+| fileName | common |  | String | When using the stream:file URI format this option specifies
the filename to stream to/from.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the
Camel routing Error Handler which mean any exceptions occurred while the consumer is trying
to pickup incoming messages or the likes will now be processed as a message and handled by
the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler
to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| groupLines | consumer |  | int | 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.
+| groupStrategy | consumer |  | GroupStrategy | Allows to use a custom GroupStrategy to control
how to group lines.
+| initialPromptDelay | consumer | 2000 | long | 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.
+| promptDelay | consumer |  | long | Optional delay in milliseconds before showing the message
prompt.
+| promptMessage | consumer |  | String | Message prompt to use when reading from stream:in;
for example you could set this to Enter a command:
+| retry | consumer | false | boolean | Will retry opening the file if it's overwritten somewhat
like tail --retry
+| scanStream | consumer | false | boolean | To be used for continuously reading a stream
such as the unix tail command.
+| scanStreamDelay | consumer |  | long | Delay in milliseconds between read attempts when
using scanStream.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| autoCloseCount | producer |  | int | 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 | producer | false | boolean | 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.
+| delay | producer |  | long | Initial delay in milliseconds before producing the stream.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[Stream-Messagecontent]]
+Message content
+^^^^^^^^^^^^^^^
+
+The *stream:* component supports either `String` or `byte[]` for writing
+to streams. Just add either `String` or `byte[]` content to the
+`message.in.body`. Messages sent to the *stream:* producer in binary
+mode are not followed by the newline character (as opposed to the
+`String` messages). Message with `null` body will not be appended to the
+output stream. +
+ The special `stream:header` URI is used for custom output streams. Just
+add a `java.io.OutputStream` object to `message.in.header` in the key
+`header`. +
+ See samples for an example.
+
+[[Stream-Samples]]
+Samples
+^^^^^^^
+
+In the following sample we route messages from the `direct:in` endpoint
+to the `System.out` stream:
+
+[source,java]
+---------------------------------------------------------------
+// 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());
+---------------------------------------------------------------
+
+The following sample demonstrates how the header type can be used to
+determine which stream to use. In the sample we use our own output
+stream, `MyOutputStream`.
+
+The following sample demonstrates how to continuously read a file stream
+(analogous to the UNIX `tail` command):
+
+[source,java]
+------------------------------------------------------------------------------------------------------------------------------------
+from("stream:file?fileName=/server/logs/server.log&scanStream=true&scanStreamDelay=1000").to("bean:logService?method=parseLogLine");
+------------------------------------------------------------------------------------------------------------------------------------
+
+One gotcha with scanStream (pre Camel 2.7) or scanStream + retry is the
+file will be re-opened and scanned with each iteration of
+scanStreamDelay. Until NIO2 is available we cannot reliably detect when
+a file is deleted/recreated.
+
+[[Stream-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/60e042ae/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 2d0a2d1..bec8f80 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -260,6 +260,7 @@
     * [SSH](ssh.adoc)
     * [StAX](stax.adoc)
     * [Stomp](stomp.adoc)
+    * [Stream](stream.adoc)
     * [Telegram](telegram.adoc)
     * [Twitter](twitter.adoc)
     * [Websocket](websocket.adoc)


Mime
View raw message