You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2016/05/24 10:19:41 UTC
svn commit: r989024 [4/4] - in /websites/production/camel/content:
book-architecture.html book-component-appendix.html book-in-one-page.html
cache/main.pageCache component-list.html component.html components.html
telegram.html transport.html uris.html
Modified: websites/production/camel/content/component.html
==============================================================================
--- websites/production/camel/content/component.html (original)
+++ websites/production/camel/content/component.html Tue May 24 10:19:41 2016
@@ -621,7 +621,10 @@ flink:datastream[?options]]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates a response using a <a shape="rect" class="external-link" href="http://www.stringtemplate.org/" rel="nofollow">String Template</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="stub.html">Stub</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[stub:someOtherCamelUri[?options]
]]></script>
-</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="telegram.html">Telegram</a> / camel-telegram</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[telegram://bots/authToken[?options]
+]]></script>
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to exchange data with the Telegram messaging network</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[test:expectedMessagesEndpointUri[?options]
]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Creates a <a shape="rect" href="mock.html">Mock</a> endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="timer.html">Timer</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/camel/content/components.html
==============================================================================
--- websites/production/camel/content/components.html (original)
+++ websites/production/camel/content/components.html Tue May 24 10:19:41 2016
@@ -621,7 +621,10 @@ flink:datastream[?options]]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates a response using a <a shape="rect" class="external-link" href="http://www.stringtemplate.org/" rel="nofollow">String Template</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="stub.html">Stub</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[stub:someOtherCamelUri[?options]
]]></script>
-</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="telegram.html">Telegram</a> / camel-telegram</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[telegram://bots/authToken[?options]
+]]></script>
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to exchange data with the Telegram messaging network</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[test:expectedMessagesEndpointUri[?options]
]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Creates a <a shape="rect" href="mock.html">Mock</a> endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="timer.html">Timer</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Added: websites/production/camel/content/telegram.html
==============================================================================
--- websites/production/camel/content/telegram.html (added)
+++ websites/production/camel/content/telegram.html Tue May 24 10:19:41 2016
@@ -0,0 +1,209 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+
+ 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.
+-->
+<html>
+<head>
+ <link href="//camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+ <link href="//camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+ <script src="//camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+ <script src="//camel.apache.org/styles/rico.js" type="text/javascript"></script>
+ <script src="//camel.apache.org/styles/site.js" type="text/javascript"></script>
+
+ <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
+
+ <style type="text/css">
+ .maincontent { overflow:hidden; }
+ </style>
+ <!--[if IE]>
+ <style type="text/css">
+ .maincontent { width:100%; }
+ </style>
+ <![endif]-->
+
+
+ <link href='//camel.apache.org/styles/highlighter/styles/shCoreCamel.css' rel='stylesheet' type='text/css' />
+ <link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' />
+ <script src='//camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='//camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
+ <title>
+ Apache Camel: Telegram
+ </title>
+</head>
+<body>
+<div class="white_box">
+<div class="header">
+ <div class="header_l">
+ <div class="header_r">
+ </div>
+ </div>
+</div>
+<div class="content">
+ <div class="content_l">
+ <div class="content_r">
+ <div>
+ <!-- Banner -->
+<div id="banner-content"><div id="asf_logo">
+ <div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png) no-repeat scroll left top;">
+ <a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px; margin-top:20px; margin-left:18px;" href="http://camel.apache.org/">Camel</a>
+ <a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px; margin-top:45px; margin-right:10px;" href="http://www.apache.org">Apache</a>
+ </div>
+</div></div>
+ <!-- Banner -->
+ <div class="top_red_bar">
+ <div id="site-breadcrumbs">
+ <!-- Breadcrumbs -->
+<a href="index.html">Apache Camel</a> > <a href="index.html">Index</a> > <a href="telegram.html">Telegram</a>
+ </div>
+ <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html">Download</a> | <a shape="rect" href="javadoc.html">JavaDoc</a> | <a shape="rect" href="source.html">Source</a> | <a shape="rect" href="discussion-forums.html">Forums</a> | <a shape="rect" href="support.html">Support</a></p></div>
+ <!-- Quicklinks -->
+ </div>
+
+ <table border="0">
+ <tbody>
+ <tr>
+ <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2 id="Telegram-TelegramComponent">Telegram Component</h2><p><strong>Available as of Camel 2.18</strong></p><p>The <strong>Telegram</strong> component provides access to the <a shape="rect" class="external-link" href="https://core.telegram.org/bots/api" rel="nofollow">Telegram Bot API</a>. It allows a Camel-based application to send and receive messages by acting as a Bot, participating in direct conversations with normal users, private and public groups or channels.</p><p>A Telegram Bot must be created before using this component, following the instructions at the <a shape="rect" class="external-link" href="https://core.telegram.org/bots#3-how-do-i-create-a-bot" rel="nofollow">Telegram Bot developers home</a>. When a new Bot is created, the BotFather provides an <strong>authorization token</strong> corresponding to the Bot. The authorization token is a mandatory parameter for the camel-telegram endpoint.</p><div class="confluence-information-m
acro confluence-information-macro-note"><p class="title">Note</p><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p><span>In order to allow the Bot to receive all messages exchanged within a group or channel (not just the ones starting with a '/' character), ask the BotFather to </span><strong>disable the privacy mode</strong><span>, using the </span><strong>/setprivacy</strong><span> command.</span></p></div></div><p>Maven users will need to add the following dependency to their pom.xml for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-telegram</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>]]></script>
+</div></div><h3 id="Telegram-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[telegram:type/authorizationToken[?options]]]></script>
+</div></div><h3 id="Telegram-Options">Options</h3><p>The Telegram component has no options.</p><p>The Telegram component supports 24 endpoint options which are listed below:</p><div class="confluenceTableSmall"><div><div class="sect2"><div class="sect3"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Group</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>type</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">common</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>Required</strong> The endpoint type. Currently only the 'bots' type is supported.</p></td></tr><tr>
<td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>authorizationToken</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">common</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>Required</strong> The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>bridgeErrorHandler</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pi
ckup 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>limit</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>100</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Limit on the number of updates that can be received in a single polling request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>sendEmptyMessageWhenIdle</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p
class="tableblock"><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>timeout</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>30</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>exceptionHandler</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer (advanced)</p></td><td colspan="1
" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>pollStrategy</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">consumer (advanced)</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.</p></td></tr><tr><td colspan="1" rowspan="
1" class="confluenceTd"><p class="tableblock"><strong>chatId</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>exchangePattern</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">advanced</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>InOnly</code></p></td><td colspan
="1" rowspan="1" class="confluenceTd"><p class="tableblock">Sets the default exchange pattern when creating an exchange</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>synchronous</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">advanced</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>backoffErrorThreshold</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The number of
subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>backoffIdleThreshold</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>backoffMultiplier</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To let the scheduled polling consumer backoff if there has been a number of subseq
uent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>delay</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>500</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>greedy</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td cols
pan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>initialDelay</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>runLoggingLevel</strong></p></td><td colspan="1" rowspan="1" class="
confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>TRACE</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>scheduledExecutorService</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>scheduler</strong></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>none</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To use a cron scheduler from either camel-spring or camel-quartz2 component</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>schedulerProperties</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>startScheduler</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan
="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Whether the scheduler should be auto started.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>timeUnit</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>ms</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">Time unit for initialDelay and delay options.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><strong>useFixedDelay</strong></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">scheduler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class=
"tableblock">Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.</p></td></tr></tbody></table></div></div></div></div></div><h3 id="Telegram-MessageHeaders">Message Headers</h3><div class="confluenceTableSmall"><div class="sect2"><div class="sect3"><div><div class="sect2"><div class="sect3"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>CamelTelegramChatId</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">This header is used by the producer endpoint in order to resolve the chat id that will receive the message. The recipient chat id can be placed (in order of priority) in message body, in the <code>CamelTelegramChatId</code> header or in the endpoint configuration (<code>chatId</c
ode> option). This header is also present in all incoming messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>CamelTelegramMediaType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">This header is used to identify the media type when the outgoing message is composed of pure binary data. Possible values are strings or enum values belonging to the <code>org.apache.camel.component.telegram.TelegramMediaType</code> enumeration.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>CamelTelegramMediaTitleCaption</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">This header is used to provide a caption or title for outgoing binary messages.</p></td></tr></tbody></table></div></div></div></div></div></div></div><h3 id="Telegram-Usage">Usage</h3><div><div class="sect2"><div class="sect3"><div class="paragraph"><p>The Telegram co
mponent supports both consumer and producer endpoints. It can also be used in <strong style="line-height: 1.42857;">reactive chat-bot mode</strong> (to consume, then produce messages).</p><h4 id="Telegram-ProducerExample">Producer Example</h4><div><div class="sect2"><div class="sect3"><div class="paragraph"><p>The following is a basic example of how to send a message to a Telegram chat through the Telegram Bot API.</p><p>in Java DSL</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start").to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L");]]></script>
+</div></div><p>or in Spring XML</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<route>
+ <from uri="direct:start"/>
+ <to uri="telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"/>
+</route>]]></script>
+</div></div><div><div class="sect2"><div class="sect3"><div class="paragraph"><p>The code <em><code style="line-height: 1.42857;">123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L</code></em> is the <strong style="line-height: 1.42857;">authorization token</strong> corresponding to the Bot.</p><p>When using the producer endpoint without specifying the <strong>chat id</strong> option, the target chat will be identified using information contained in the body or headers of the message. The following message bodies are allowed for a producer endpoint (messages of type <em>OutgoingXXXMessage</em> belong to the package <em>org.apache.camel.component.telegram.model</em>)</p><div class="confluenceTableSmall"><div class="sect2"><div class="sect3"><div class="sect2"><div class="sect3"><div><div class="sect2"><div class="sect3"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Java T
ype</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>OutgoingTextMessage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send a text message to a chat</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>OutgoingPhotoMessage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send a photo (JPG, PNG) to a chat</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>OutgoingAudioMessage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send a mp3 audio to a chat</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>OutgoingVideoMessage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send a mp4 video to a chat
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>byte[]</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send any media type supported. It requires the <code>CamelTelegramMediaType</code> header to be set to the appropriate media type</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">To send a text message to a chat. It gets converted automatically into a <code>OutgoingTextMessage</code></p></td></tr></tbody></table></div></div></div></div></div></div></div></div></div><h4 id="Telegram-ConsumerExample">Consumer Example</h4></div></div></div></div><p>The following is a basic example of how to receive all messages that telegram users are sending to the configured Bot.</p><p>In Java DSL</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L")
+.bean(ProcessorBean.class)]]></script>
+</div></div><p>or in Spring XML</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<route>
+ <from uri="telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"/>
+ <bean ref="myBean" />
+</route>
+<bean id="myBean" class="com.example.MyBean"/>]]></script>
+</div></div><p>The<em style="line-height: 1.42857;"> MyBean</em> is a simple bean that will receive the messages</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class MyBean {
+ public void process(String message) {
+ // or Exchange, or org.apache.camel.component.telegram.model.IncomingMessage (or both)
+ // do process
+ }
+}]]></script>
+</div></div><p>Supported types for incoming messages are</p><div class="confluenceTableSmall"><div class="sect2"><div class="sect3"><div class="sect2"><div class="sect3"><div class="sect2"><div class="sect3"><div><div class="sect2"><div class="sect3"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Java Type</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>IncomingMessage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The full object representation of an incoming message</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock"><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p class="tableblock">The content of the message, for text messages only</p></td></tr></tbody></table></div></div></div></div></div></div></div><
/div></div></div></div><h4 id="Telegram-ReactiveChat-BotExample">Reactive Chat-Bot Example</h4><p>The reactive chat-bot mode is a simple way of using the Camel component to build a simple chat bot that replies directly to chat messages received from the Telegram users.</p><p>The following is a basic configuration of the chat-bot in Java DSL</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L")
+.bean(ChatBotLogic.class)
+.to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L");]]></script>
+</div></div><p>or in Spring XML</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<route>
+ <from uri="telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"/>
+ <bean ref="chatBotLogic" />
+ <to uri="telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"/>
+</route>
+<bean id="chatBotLogic" class="com.example.ChatBotLogic"/>]]></script>
+</div></div><p>The ChatBotLogic is a simple bean that implements a generic String-to-String method.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class ChatBotLogic {
+ public String chatBotProcess(String message) {
+ if( "do-not-reply".equals(message) ) {
+ return null; // no response in the chat
+ }
+ return "echo from the bot: " + message; // echoes the message
+ }
+}]]></script>
+</div></div><p>Every non-null string returned by the <em style="line-height: 1.42857;">chatBotProcess</em> method is automatically routed to the chat that originated the request (as the <em style="line-height: 1.42857;">CamelTelegramChatId</em> header is used to route the message).</p></div></div></div></div></div></div></div></div></div>
+ </td>
+ <td valign="top">
+ <div class="navigation">
+ <div class="navigation_top">
+ <!-- NavigationBar -->
+<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+ <div>
+ <input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="21">
+ <input type="submit" name="sa" value="Search">
+ </div>
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
+ <!-- NavigationBar -->
+ </div>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+ <div class="bottom_red_bar"></div>
+ </div>
+ </div>
+ </div>
+</div>
+<div class="black_box">
+<div class="footer">
+ <div class="footer_l">
+ <div class="footer_r">
+ <div>
+ <a href="$base/privacy-policy.html">Privacy Policy</a> -
+ (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=63406657">edit page</a>)
+ (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=63406657&showComments=true&showCommentArea=true#addcomment">add comment</a>)
+ </div>
+ </div>
+ </div>
+</div>
+</div>
+</div>
+<div class="design_attribution">
+© 2004-2015 The Apache Software Foundation.
+<br>
+Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+<br>
+<a href="http://hiramchirino.com">Graphic Design By Hiram</a>
+</div>
+
+<!-- Camel committers that would like access to the Analytics, send a note to private@camel.apache.org -->
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976253-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+</script>
+
+</body>
+</html>
+
+
Modified: websites/production/camel/content/transport.html
==============================================================================
--- websites/production/camel/content/transport.html (original)
+++ websites/production/camel/content/transport.html Tue May 24 10:19:41 2016
@@ -625,7 +625,10 @@ flink:datastream[?options]]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates a response using a <a shape="rect" class="external-link" href="http://www.stringtemplate.org/" rel="nofollow">String Template</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="stub.html">Stub</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[stub:someOtherCamelUri[?options]
]]></script>
-</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="telegram.html">Telegram</a> / camel-telegram</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[telegram://bots/authToken[?options]
+]]></script>
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to exchange data with the Telegram messaging network</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[test:expectedMessagesEndpointUri[?options]
]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Creates a <a shape="rect" href="mock.html">Mock</a> endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="timer.html">Timer</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/camel/content/uris.html
==============================================================================
--- websites/production/camel/content/uris.html (original)
+++ websites/production/camel/content/uris.html Tue May 24 10:19:41 2016
@@ -630,7 +630,10 @@ flink:datastream[?options]]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Generates a response using a <a shape="rect" class="external-link" href="http://www.stringtemplate.org/" rel="nofollow">String Template</a></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="stub.html">Stub</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[stub:someOtherCamelUri[?options]
]]></script>
-</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows you to <a shape="rect" href="stub.html">stub out some physical middleware endpoint</a> for easier testing or debugging</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="telegram.html">Telegram</a> / camel-telegram</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[telegram://bots/authToken[?options]
+]]></script>
+</div></div></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to exchange data with the Telegram messaging network</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="test.html">Test</a> / camel-spring</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: plain; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[test:expectedMessagesEndpointUri[?options]
]]></script>
</div></div></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Creates a <a shape="rect" href="mock.html">Mock</a> endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect" href="timer.html">Timer</a> / camel-core</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">