camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r859589 - in /websites/production/camel/content: cache/main.pageCache camel-2120-release.html componentconfiguration.html endpoint-annotations.html writing-components.html
Date Tue, 23 Apr 2013 10:18:07 GMT
Author: buildbot
Date: Tue Apr 23 10:18:07 2013
New Revision: 859589

Log:
Production update by buildbot for camel

Added:
    websites/production/camel/content/componentconfiguration.html
    websites/production/camel/content/endpoint-annotations.html
Modified:
    websites/production/camel/content/cache/main.pageCache
    websites/production/camel/content/camel-2120-release.html
    websites/production/camel/content/writing-components.html

Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/camel/content/camel-2120-release.html
==============================================================================
--- websites/production/camel/content/camel-2120-release.html (original)
+++ websites/production/camel/content/camel-2120-release.html Tue Apr 23 10:18:07 2013
@@ -84,7 +84,7 @@
 
 <p>Welcome to the 2.12.0 release which approx XXX issues resolved (new features, improvements
and bug fixes such as...)</p>
 
-<ul><li>highlighted issue fixed</li><li>highlighted issue fixed</li></ul>
+<ul><li><a shape="rect" href="endpoint-annotations.html" title="Endpoint Annotations">Endpoint
Annotations</a> along with automatically created HTML documentation for the endpoint
parameters.</li><li><a shape="rect" href="componentconfiguration.html" title="ComponentConfiguration">ComponentConfiguration</a>
API provides a handy API for tools developers to introspect on a Component to find all the
possible parameters, their types and any extra annotations (like Bean Validation Annotations)
to be able to create/edit endpoints or URI strings so that tools can generate nicer UIs for
configuring endpoints than just letting folks edit Strings.</li></ul>
 
 
 <h3><a shape="rect" name="Camel2.12.0Release-FixedIssues"></a>Fixed Issues</h3>

Added: websites/production/camel/content/componentconfiguration.html
==============================================================================
--- websites/production/camel/content/componentconfiguration.html (added)
+++ websites/production/camel/content/componentconfiguration.html Tue Apr 23 10:18:07 2013
@@ -0,0 +1,210 @@
+<!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="http://camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+    <link href="http://camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+    <script src="http://camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+    <script src="http://camel.apache.org/styles/rico.js" type="text/javascript"></script>
   
+    <script src="http://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]-->
+
+    <title>
+    Apache Camel: ComponentConfiguration
+    </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>&nbsp;&gt;&nbsp;<a href="documentation.html">Documentation</a>&nbsp;&gt;&nbsp;<a
href="architecture.html">Architecture</a>&nbsp;&gt;&nbsp;<a href="componentconfiguration.html">ComponentConfiguration</a>
+          </div>
+          <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html" title="Download">Download</a>
| <a shape="rect" href="javadoc.html" title="JavaDoc">JavaDoc</a> | <a shape="rect"
href="source.html" title="Source">Source</a> | <a shape="rect" href="discussion-forums.html"
title="Discussion Forums">Forums</a> | <a shape="rect" href="support.html" title="Support">Support</a></p></div>
+          <!-- Quicklinks -->
+        </div>
+
+	<table border="0">
+	<tbody>
+        <tr>
+        <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2><a shape="rect" name="ComponentConfiguration-ComponentConfigurationAPI"></a>ComponentConfiguration
API</h2>
+
+<p>As of <b>Camel 2.12</b> the new ComponentConfiguration API provides
a mechanism for tools (command line, IDE, web based) to introspect the available Camel components
and introspect what configuration parameters are available on the components to create new
endpoints, edit existing endpoints or create/edit URIs for endpoints (if the aim is to allow
UI editting of Camel routes for example).</p>
+
+<p>To get an idea for the kinds of things you can do with the ComponentConfiguration
API <a shape="rect" class="external-link" href="https://github.com/apache/camel/blob/trunk/camel-core/src/test/java/org/apache/camel/impl/ComponentConfigurationTest.java#L69"
rel="nofollow">check out the test case</a>.</p>
+
+<p>For example given a Component object you can create a new configuration; then introspect
the available properties...</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<pre class="code-java">
+Component component = camelContext.getComponent(<span class="code-quote">"seda"</span>);
+ComponentConfiguration configuration = component.createComponentConfiguration();
+
+<span class="code-comment">// now lets introspect the available parameters...
+</span>SortedMap&lt;<span class="code-object">String</span>, ParameterConfiguration&gt;
parameterMap = configuration.getParameterConfigurationMap();
+
+<span class="code-comment">// or lets look up a named parameter
+</span>ParameterConfiguration config = configuration.getParameterConfiguration(<span
class="code-quote">"foo"</span>);
+
+
+<span class="code-comment">// lets get or set the parameter values...
+</span>configuration.setParameter(<span class="code-quote">"concurrentConsumers"</span>,
5);
+configuration.setParameter(<span class="code-quote">"size"</span>, 1000);
+
+<span class="code-comment">// or lets set the base URI and parameters from a URI string
+</span>configuration.setUriString(<span class="code-quote">"foo?concurrentConsumers=5&amp;size=1000"</span>);
+
+
+<span class="code-comment">// now lets convert the configuration to a URI string
+</span><span class="code-object">String</span> uriString = configuration.getUriString();
+
+<span class="code-comment">// now lets convert the configuration to an Endpoint
+</span>Endpoint newEndpoint = configuration.createEndpoint();
+</pre>
+</div></div></div>
+        </td>
+        <td valign="top">
+          <div class="navigation">
+            <div class="navigation_top">
+                <!-- NavigationBar -->
+<div class="navigation_bottom" id="navigation_bottom"><h3><a shape="rect"
name="Navigation-Overview"></a><a shape="rect" href="overview.html" title="Overview">Overview</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="index.html"
title="Index">Home</a></li><li><a shape="rect" href="download.html"
title="Download">Download</a></li><li><a shape="rect" href="getting-started.html"
title="Getting Started">Getting Started</a></li><li><a shape="rect"
href="faq.html" title="FAQ">FAQ</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Documentation"></a><a shape="rect"
href="documentation.html" title="Documentation">Documentation</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="user-guide.html"
title="User Guide">User Guide</a></li><li><a shape="rect" href="manual.html"
title="Manual">Manual</a></li><li><a shape="rect" href="books.html"
title="Books">Books</a></li><li><a shape="rect" href="tutorials.html"
title="Tutorials">Tutorials</a></li><li><a shape="rect" href="examples.html"
title="Examples">Examples</a></li><li><a shape="rect" href="cookbook.html"
title="Cookbook">Cookbook</a></li><li><a shape="rect" href="architecture.html"
title="Architecture">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html"
title="Enterprise Integration Patterns">Enterprise Integration Patterns</a></li><li><a
shape="rect" href="dsl.html" title="DSL">DSL</a></li><li><a shape="rect"
href="components.html" title="Components">Components</a></li><li><a
shape="rect" href="data-format.html" title="Data Format">Data Format</a></li><li><a
shape="rect" href="languages.html" title="Lang
 uages">Languages</a></li><li><a shape="rect" href="security.html"
title="Security">Security</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Search"></a>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&amp;lang=en"></script>
+
+
+<h3><a shape="rect" name="Navigation-Community"></a><a shape="rect"
href="community.html" title="Community">Community</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="support.html"
title="Support">Support</a></li><li><a shape="rect" href="contributing.html"
title="Contributing">Contributing</a></li><li><a shape="rect" href="discussion-forums.html"
title="Discussion Forums">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li><li><a
shape="rect" href="user-stories.html" title="User Stories">User Stories</a></li><li><a
shape="rect" href="news.html" title="News">News</a></li><li><a shape="rect"
href="articles.html" title="Articles">Articles</a></li><li><a shape="rect"
href="site.html" title="Site">Site</a></li><li><a shape="rect" href="team.html"
title="Team">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Developers"></a><a shape="rect"
href="developers.html" title="Developers">Developers</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="developers.html"
title="Developers">Developer Guide</a></li><li><a shape="rect" href="source.html"
title="Source">Source</a></li><li><a shape="rect" href="building.html"
title="Building">Building</a></li><li><a shape="rect" href="javadoc.html"
title="JavaDoc">JavaDoc</a></li><li><a shape="rect" href="irc-room.html"
title="IRC Room">IRC Room</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-ApacheSoftwareFoundation"></a>Apache
Software Foundation</h3>
+
+<ul class="alternate" type="square"><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=31819233">edit
page</a>)
+   	 (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=31819233&amp;showComments=true&amp;showCommentArea=true#addcomment">add
comment</a>)
+      </div>
+    </div>
+  </div>
+</div>
+</div>
+</div>
+<div class="design_attribution">
+&copy; 2004-2011 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>
+
+

Added: websites/production/camel/content/endpoint-annotations.html
==============================================================================
--- websites/production/camel/content/endpoint-annotations.html (added)
+++ websites/production/camel/content/endpoint-annotations.html Tue Apr 23 10:18:07 2013
@@ -0,0 +1,197 @@
+<!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="http://camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+    <link href="http://camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+    <script src="http://camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+    <script src="http://camel.apache.org/styles/rico.js" type="text/javascript"></script>
   
+    <script src="http://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]-->
+
+    <title>
+    Apache Camel: Endpoint Annotations
+    </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>&nbsp;&gt;&nbsp;<a href="documentation.html">Documentation</a>&nbsp;&gt;&nbsp;<a
href="architecture.html">Architecture</a>&nbsp;&gt;&nbsp;<a href="endpoint-annotations.html">Endpoint
Annotations</a>
+          </div>
+          <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html" title="Download">Download</a>
| <a shape="rect" href="javadoc.html" title="JavaDoc">JavaDoc</a> | <a shape="rect"
href="source.html" title="Source">Source</a> | <a shape="rect" href="discussion-forums.html"
title="Discussion Forums">Forums</a> | <a shape="rect" href="support.html" title="Support">Support</a></p></div>
+          <!-- Quicklinks -->
+        </div>
+
+	<table border="0">
+	<tbody>
+        <tr>
+        <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2><a shape="rect" name="EndpointAnnotations-EndpointAnnotations"></a>Endpoint
Annotations</h2>
+
+<p>As of <b>Camel 2.12</b> you can annotate <a shape="rect" href="endpoint.html"
title="Endpoint">Endpoint</a> and Consumer classes so that their configuration documentation
can be automatically generated by the camel-package-maven-plugin (rather like maven plugin
goals get their parameters documented automatically).</p>
+
+<p>The documentation is then included into the jar as org/apache/camel/component/scheme.html
as well as appearing in the maven site documentation as a project report.</p>
+
+<h3><a shape="rect" name="EndpointAnnotations-Supportedannotations"></a>Supported
annotations</h3>
+
+<div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Annotation</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">@UriEndpoint</td><td colspan="1"
rowspan="1" class="confluenceTd">Specifies that an endpoint is annotated with @UriParam
and/or @UriParams annotations. Also specifies the default scheme to use in the generated documentation
and the associated Consumer class for this endpoint</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">@UriParam</td><td colspan="1" rowspan="1"
class="confluenceTd">Used to annotate a parameter value; usually specified via ?foo=bar
syntax in the URI strings in Camel. Used currently only on field declarations but in the future
could be used on setter methods too. If no name is specified then the name of the field/setter
property is used.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">@UriParams</td><td
co
 lspan="1" rowspan="1" class="confluenceTd">Specifies that a field is a nested object of
one or more configuration parameters; then the class of this field should be annotated with
one or more @UriParam or @UriParams annotations</td></tr></tbody></table>
+</div>
+
+
+<p>For example here is the <a shape="rect" class="external-link" href="https://github.com/apache/camel/blob/trunk/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java#L40"
rel="nofollow">TimerEndpoint</a>, notice the use of these annotations and in its
base classes.</p>
+
+<p>Not only are the annotations useful for automatically generating the documentation;
we can use them to refine the validation of the code during configuration and they can be
useful for tool providers so they can more easily introspect the configuration options. See
the <a shape="rect" href="componentconfiguration.html" title="ComponentConfiguration">ComponentConfiguration</a>
documentation on the tooling aspect.</p>
+
+<h3><a shape="rect" name="EndpointAnnotations-UsingtheUriEndpointComponentbaseclass"></a>Using
the UriEndpointComponent base class</h3>
+
+<p>If you use the @UriEndpoint annotation on your Endpoint along with one or more @UriParam
/ @UriParams annotations on your class (or any base classes of your endpoint) its recommended
that your Component class inherit from the UriEndpointComponent base class as that means your
Component will automatically generate better metadata for the <a shape="rect" href="componentconfiguration.html"
title="ComponentConfiguration">ComponentConfiguration</a> API.</p>
+
+<p>This will allow your component to work better inside tools which make use of the
<a shape="rect" href="componentconfiguration.html" title="ComponentConfiguration">ComponentConfiguration</a>
API to generate nice forms and so forth.</p></div>
+        </td>
+        <td valign="top">
+          <div class="navigation">
+            <div class="navigation_top">
+                <!-- NavigationBar -->
+<div class="navigation_bottom" id="navigation_bottom"><h3><a shape="rect"
name="Navigation-Overview"></a><a shape="rect" href="overview.html" title="Overview">Overview</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="index.html"
title="Index">Home</a></li><li><a shape="rect" href="download.html"
title="Download">Download</a></li><li><a shape="rect" href="getting-started.html"
title="Getting Started">Getting Started</a></li><li><a shape="rect"
href="faq.html" title="FAQ">FAQ</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Documentation"></a><a shape="rect"
href="documentation.html" title="Documentation">Documentation</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="user-guide.html"
title="User Guide">User Guide</a></li><li><a shape="rect" href="manual.html"
title="Manual">Manual</a></li><li><a shape="rect" href="books.html"
title="Books">Books</a></li><li><a shape="rect" href="tutorials.html"
title="Tutorials">Tutorials</a></li><li><a shape="rect" href="examples.html"
title="Examples">Examples</a></li><li><a shape="rect" href="cookbook.html"
title="Cookbook">Cookbook</a></li><li><a shape="rect" href="architecture.html"
title="Architecture">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html"
title="Enterprise Integration Patterns">Enterprise Integration Patterns</a></li><li><a
shape="rect" href="dsl.html" title="DSL">DSL</a></li><li><a shape="rect"
href="components.html" title="Components">Components</a></li><li><a
shape="rect" href="data-format.html" title="Data Format">Data Format</a></li><li><a
shape="rect" href="languages.html" title="Lang
 uages">Languages</a></li><li><a shape="rect" href="security.html"
title="Security">Security</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Search"></a>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&amp;lang=en"></script>
+
+
+<h3><a shape="rect" name="Navigation-Community"></a><a shape="rect"
href="community.html" title="Community">Community</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="support.html"
title="Support">Support</a></li><li><a shape="rect" href="contributing.html"
title="Contributing">Contributing</a></li><li><a shape="rect" href="discussion-forums.html"
title="Discussion Forums">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li><li><a
shape="rect" href="user-stories.html" title="User Stories">User Stories</a></li><li><a
shape="rect" href="news.html" title="News">News</a></li><li><a shape="rect"
href="articles.html" title="Articles">Articles</a></li><li><a shape="rect"
href="site.html" title="Site">Site</a></li><li><a shape="rect" href="team.html"
title="Team">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-Developers"></a><a shape="rect"
href="developers.html" title="Developers">Developers</a></h3>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="developers.html"
title="Developers">Developer Guide</a></li><li><a shape="rect" href="source.html"
title="Source">Source</a></li><li><a shape="rect" href="building.html"
title="Building">Building</a></li><li><a shape="rect" href="javadoc.html"
title="JavaDoc">JavaDoc</a></li><li><a shape="rect" href="irc-room.html"
title="IRC Room">IRC Room</a></li></ul>
+
+
+<h3><a shape="rect" name="Navigation-ApacheSoftwareFoundation"></a>Apache
Software Foundation</h3>
+
+<ul class="alternate" type="square"><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=31819227">edit
page</a>)
+   	 (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=31819227&amp;showComments=true&amp;showCommentArea=true#addcomment">add
comment</a>)
+      </div>
+    </div>
+  </div>
+</div>
+</div>
+</div>
+<div class="design_attribution">
+&copy; 2004-2011 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/writing-components.html
==============================================================================
--- websites/production/camel/content/writing-components.html (original)
+++ websites/production/camel/content/writing-components.html Tue Apr 23 10:18:07 2013
@@ -96,6 +96,16 @@
 
 <p>If your endpoint is a polling-centric component you can derive from <a shape="rect"
class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/impl/DefaultPollingEndpoint.html">DefaultPollingEndpoint</a>
and then implement <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createPollingConsumer()">createPollingConsumer()</a>;
the <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html#createConsumer(org.apache.camel.Processor)">createConsumer()</a>
 method will be created for you which avoids you having to write any polling code.</p>
 
+<h3><a shape="rect" name="WritingComponents-AnnotatingyourEndpoint"></a>Annotating
your Endpoint</h3>
+
+<p>As of <b>Camel 2.12</b> if you want to benefit from the automatic generation
of HTML documentation for all the parameters on your endpoint as part of the maven site reports,
you need to <a shape="rect" href="endpoint-annotations.html" title="Endpoint Annotations">annotate
your Endpoint's parameters</a>.</p>
+
+<p>So this means you add a @UriEndpoint annotation to your Endpoint class and then
annotate each parameter you wish to be configured via the URI configuration mechanism with
@UriParam (or @UriParams for nested configuration objects).</p>
+
+<p>In addition its recommended that your Component implementation inherit from the
UriEndpointComponent base class as that means your Component will automatically generate better
metadata for the <a shape="rect" href="componentconfiguration.html" title="ComponentConfiguration">ComponentConfiguration</a>
API.</p>
+
+<p>Refer to the <a shape="rect" href="endpoint-annotations.html" title="Endpoint
Annotations">Endpoint Annotations guide for details</a>.</p>
+
 <h3><a shape="rect" name="WritingComponents-UsingaProcessor"></a>Using
a Processor</h3>
 
 <p>If you are writing a simple endpoint which just processes messages in some way,
you can just implement a <a shape="rect" href="processor.html" title="Processor">Processor</a>
and <a shape="rect" href="processor.html" title="Processor">use that to create an endpoint</a>.</p>



Mime
View raw message