Author: buildbot
Date: Tue Jan 20 10:18:46 2015
New Revision: 936920
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/rest-dsl.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/rest-dsl.html
==============================================================================
--- websites/production/camel/content/rest-dsl.html (original)
+++ websites/production/camel/content/rest-dsl.html Tue Jan 20 10:18:46 2015
@@ -251,7 +251,7 @@ public class UserPojo {
}
]]></script>
-</div></div><p>By having the JAXB annotations the POJO supports both json and
xml bindings.</p><h3 id="RestDSL-ConfiguringRestDSL"><span style="line-height:
1.5625;">Configuring Rest DSL</span></h3><p>The Rest DSL allows to configure
the following options using a builder style</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Option</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">component</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The Camel Rest component to use for the REST transport,
such as restlet, spark-rest. If no component has been explicit configured, then
Camel will lookup if there is a Camel component that integrates with the Rest
DSL, or if a <code>org.apache.camel.spi.RestConsumerFactory</cod
e> is registered in the registry. If either one is found, then that is
being used.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">scheme</td><td colspan="1" rowspan="1"
class="confluenceTd">http</td><td colspan="1" rowspan="1"
class="confluenceTd">The scheme to use for exposing the REST service. Usually
http or https is supported</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">hostname</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The hostname to use for exposing the REST
service.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">port</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The port number to use for exposing the REST service.
Notice if you use servlet component then the port number configured here does
not apply, as the port number in use is the actual port number the servlet
component is using. eg
if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the
HTTP service in Karaf that uses port 8181 by default etc. Though in those
situations setting the port number here, allows tooling and JMX to know the
port number, so its recommended to set the port number to the number that the
servlet engine uses.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">contextPath</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Sets a leading context-path the REST services will be
using. This can be used when using components such as <a shape="rect"
href="servlet.html">SERVLET</a> where the deployed web application is deployed
using a context-path.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">restHostNameResolver</td><td colspan="1" rowspan="1"
class="confluenceTd">localHostName</td><td colspan="1" rowspan="1"
class="confluenceTd">If no hostname has been explicit configured, then this
resolver is used to compute the hostname the REST service will be using. The
resolver supports <code>localHostName</code> or
<code>localIp</code>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">bindingMode</td><td colspan="1" rowspan="1"
class="confluenceTd">off</td><td colspan="1" rowspan="1"
class="confluenceTd">Whether binding is in use. See further above for more
details.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">skipBindingOnCustomError</td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.14.1</strong>: Whether to skip binding on
output if there is a custom HTTP error code header. This allows to build custom
error messages that do not bind to json / xml etc, as success messages
otherwise will do. See further below for an example.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">enableCORS</td><td colspan="1"
rowspan="1" class="confluenceTd">false</td><td co
lspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.14.1:</strong>
Whether to enable CORS headers in the HTTP response.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">jsonDataFormat</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Name of specific json data format to use. By default
<code>json-jackson</code> will be used. <strong>Important:</strong> This option
is only for setting a custom name of the data format, not to refer to an
existing data format instance. <strong>Notice:</strong> Currently Jackson is
what we recommend and are using for testing.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">xmlDataFormat</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Name of specific XML data format to use. By default
<code>jaxb</code> will be used. <strong>Important:</strong><span> This option
is only for setting a custom name
of the data format, not to refer to an existing data format instance.
</span><strong>Notice:</strong> Currently only <code>jaxb</code> is
supported.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">componentProperty</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Allows to configure as many additional properties. This is
used to configure component specific options such as for <a shape="rect"
href="restlet.html">Restlet</a> / <a shape="rect"
href="spark-rest.html">Spark-Rest</a> etc.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">endpointProperty</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><span>Allows to configure as many additional properties.
This is used to configure endpoint specific options for <span> </span><a
shape="rect" href="restlet.html">Restlet</a><span> / </span><a
shape="re
ct"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">consumerProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><span>Allows to configure as many additional
properties. This is used to configure consumer specific options for
</span><span> </span><a shape="rect"
href="restlet.html">Restlet</a><span> / </span><a shape="rect"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">dataFormatProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows to configure as many additional
properties. This is used to configure the data format specific options. For
example set property prettyPrint to true to have json outputted in pretty mode.
From <strong>Camel 2.14.1</strong> onwards the keys
can be prefixed with either</p><ul style="list-style-type:
square;"><li>json.in.</li><li>json.out.</li><li>xml.in.</li><li>xml.out.</li></ul><p>to
denote that the option is only for either JSON or XML data format, and only
for either the in or the out going. For example a key with value
"xml.out.mustBeJAXBElement" is only for the XML data format for the outgoing. A
key without a prefix is a common key for all situations.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">corsHeaderProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd">Allows to configure custom CORS
headers.</td></tr></tbody></table></div><p> </p><p><span
style="line-height: 1.4285715;">For example to configure to use the spark-rest
component on port 9091, then we can do as follows</span></p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>By having the JAXB annotations the POJO supports both json and
xml bindings.</p><h3 id="RestDSL-ConfiguringRestDSL"><span style="line-height:
1.5625;">Configuring Rest DSL</span></h3><p>The Rest DSL allows to configure
the following options using a builder style</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Option</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">component</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The Camel Rest component to use for the REST transport,
such as restlet, spark-rest. If no component has been explicit configured, then
Camel will lookup if there is a Camel component that integrates with the Rest
DSL, or if a <code>org.apache.camel.spi.RestConsumerFactory</cod
e> is registered in the registry. If either one is found, then that is
being used.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">scheme</td><td colspan="1" rowspan="1"
class="confluenceTd">http</td><td colspan="1" rowspan="1"
class="confluenceTd">The scheme to use for exposing the REST service. Usually
http or https is supported</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">hostname</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The hostname to use for exposing the REST
service.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">port</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">The port number to use for exposing the REST service.
Notice if you use servlet component then the port number configured here does
not apply, as the port number in use is the actual port number the servlet
component is using. eg
if using Apache Tomcat its the tomcat http port, if using Apache Karaf its the
HTTP service in Karaf that uses port 8181 by default etc. Though in those
situations setting the port number here, allows tooling and JMX to know the
port number, so its recommended to set the port number to the number that the
servlet engine uses.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">contextPath</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Sets a leading context-path the REST services will be
using. This can be used when using components such as <a shape="rect"
href="servlet.html">SERVLET</a> where the deployed web application is deployed
using a context-path.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">restHostNameResolver</td><td colspan="1" rowspan="1"
class="confluenceTd">localHostName</td><td colspan="1" rowspan="1"
class="confluenceTd">If no hostname has been explicit configured, then this
resolver is used to compute the hostname the REST service will be using. The
resolver supports <code>localHostName</code> or
<code>localIp</code>.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">bindingMode</td><td colspan="1" rowspan="1"
class="confluenceTd">off</td><td colspan="1" rowspan="1"
class="confluenceTd">Whether binding is in use. See further above for more
details.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">skipBindingOnErrorCode</td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.14.1</strong>: Whether to skip binding on
output if there is a custom HTTP error code header. This allows to build custom
error messages that do not bind to json / xml etc, as success messages
otherwise will do. See further below for an example.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">enableCORS</td><td colspan="1"
rowspan="1" class="confluenceTd">false</td><td cols
pan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.14.1:</strong>
Whether to enable CORS headers in the HTTP response.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">jsonDataFormat</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Name of specific json data format to use. By default
<code>json-jackson</code> will be used. <strong>Important:</strong> This option
is only for setting a custom name of the data format, not to refer to an
existing data format instance. <strong>Notice:</strong> Currently Jackson is
what we recommend and are using for testing.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">xmlDataFormat</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Name of specific XML data format to use. By default
<code>jaxb</code> will be used. <strong>Important:</strong><span> This option
is only for setting a custom name o
f the data format, not to refer to an existing data format instance.
</span><strong>Notice:</strong> Currently only <code>jaxb</code> is
supported.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">componentProperty</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Allows to configure as many additional properties. This is
used to configure component specific options such as for <a shape="rect"
href="restlet.html">Restlet</a> / <a shape="rect"
href="spark-rest.html">Spark-Rest</a> etc.</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">endpointProperty</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><span>Allows to configure as many additional properties.
This is used to configure endpoint specific options for <span> </span><a
shape="rect" href="restlet.html">Restlet</a><span> / </span><a
shape="rect
"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">consumerProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><span>Allows to configure as many additional
properties. This is used to configure consumer specific options for
</span><span> </span><a shape="rect"
href="restlet.html">Restlet</a><span> / </span><a shape="rect"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">dataFormatProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows to configure as many additional
properties. This is used to configure the data format specific options. For
example set property prettyPrint to true to have json outputted in pretty mode.
From <strong>Camel 2.14.1</strong> onwards the keys ca
n be prefixed with either</p><ul style="list-style-type:
square;"><li>json.in.</li><li>json.out.</li><li>xml.in.</li><li>xml.out.</li></ul><p>to
denote that the option is only for either JSON or XML data format, and only
for either the in or the out going. For example a key with value
"xml.out.mustBeJAXBElement" is only for the XML data format for the outgoing. A
key without a prefix is a common key for all situations.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">corsHeaderProperty</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd">Allows to configure custom CORS
headers.</td></tr></tbody></table></div><p> </p><p><span
style="line-height: 1.4285715;">For example to configure to use the spark-rest
component on port 9091, then we can do as follows</span></p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[restConfiguration().component("spark-rest").port(9091).componentProperty("foo",
"123");]]></script>
</div></div><p><span style="line-height: 1.4285715;"><br
clear="none"></span></p><p><span style="line-height: 1.4285715;">And with XML
DSL</span></p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[<restConfiguration
component="spark-rest" port="9091">
<componentProperty key="foo" value="123"/>
</restConfiguration>]]></script>
