http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-netty-http/src/main/docs/netty-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 03545f9..6fb6476 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -1,4 +1,4 @@ -# Netty HTTP Component +## Netty HTTP Component *Available as of Camel 2.12* @@ -35,9 +35,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[NettyHTTP-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a netty component is as follows @@ -64,9 +62,7 @@ headers (like `CamelHttpQuery`). Endpoint options can be specified only at the endpoint URI definition level (like `to` or `from` DSL elements). -[[NettyHTTP-HTTPOptions]] -HTTP Options -^^^^^^^^^^^^ +### HTTP Options INFO: *A lot more options*. *Important:* This component inherits all the options from link:netty.html[Netty]. So make sure to look at the @@ -200,9 +196,7 @@ The Netty HTTP component supports 82 endpoint options which are listed below: -[[NettyHTTP-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following headers can be used on the producer to control the HTTP request. @@ -267,9 +261,7 @@ with the value `Basic`. |`Content-Type` |`String` | The content type if provided. For example: `text/plain; charset="UTF-8"`. |======================================================================= -[[NettyHTTP-AccesstoNettytypes]] -Access to Netty types -^^^^^^^^^^^^^^^^^^^^^ +### Access to Netty types This component uses the `org.apache.camel.component.netty.http.NettyHttpMessage` as the message @@ -283,9 +275,7 @@ accessible at all times. org.jboss.netty.handler.codec.http.HttpRequest request = exchange.getIn(NettyHttpMessage.class).getHttpRequest(); ----------------------------------------------------------------------------------------------------------------- -[[NettyHTTP-Examples]] -Examples -^^^^^^^^ +### Examples In the route below we use link:netty-http.html[Netty HTTP] as a HTTP server, which returns back a hardcoded "Bye World" message. @@ -307,9 +297,7 @@ link:producertemplate.html[ProducerTemplate] as shown below: And we get back "Bye World" as the output. -[[NettyHTTP-HowdoIletNettymatchwildcards]] -How do I let Netty match wildcards -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How do I let Netty match wildcards By default link:netty-http.html[Netty HTTP] will only match on exact uri's. But you can instruct Netty to match prefixes. For example @@ -340,9 +328,7 @@ To match *any* endpoint you can do: from("netty-http:http://0.0.0.0:8123?matchOnUriPrefix=true";).to("mock:foo"); ---------------------------------------------------------------------------- -[[NettyHTTP-Usingmultiplerouteswithsameport]] -Using multiple routes with same port -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using multiple routes with same port In the same link:camelcontext.html[CamelContext] you can have multiple routes from link:netty-http.html[Netty HTTP] that shares the same port @@ -395,9 +381,7 @@ from("netty-http:http://0.0.0.0:{{port}}/bar?ssl=true";) .transform().constant("Bye Camel"); -------------------------------------------------------------------------------------- -[[NettyHTTP-Reusingsameserverbootstrapconfigurationwithmultipleroutes]] -Reusing same server bootstrap configuration with multiple routes -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reusing same server bootstrap configuration with multiple routes By configuring the common server bootstrap option in an single instance of a @@ -435,16 +419,12 @@ And in the routes you refer to this option as shown below </route> --------------------------------------------------------------------------------------------------------- -[[NettyHTTP-ReusingsameserverbootstrapconfigurationwithmultipleroutesacrossmultiplebundlesinOSGicontainer]] -Reusing same server bootstrap configuration with multiple routes across multiple bundles in OSGi container -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reusing same server bootstrap configuration with multiple routes across multiple bundles in OSGi container See the link:netty-http-server-example.html[Netty HTTP Server Example] for more details and example how to do that. -[[NettyHTTP-UsingHTTPBasicAuthentication]] -Using HTTP Basic Authentication -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using HTTP Basic Authentication The link:netty-http.html[Netty HTTP] consumer supports HTTP basic authentication by specifying the security realm name to use, as shown @@ -467,9 +447,7 @@ End user of Apache Karaf / ServiceMix has a karaf realm out of the box, and hence why the example above would work out of the box in these containers. -[[NettyHTTP-SpecifyingACLonwebresources]] -Specifying ACL on web resources -+++++++++++++++++++++++++++++++ +#### Specifying ACL on web resources The `org.apache.camel.component.netty.http.SecurityConstraint` allows to define constrains on web resources. And the @@ -521,9 +499,7 @@ below: </route> ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[NettyHTTP-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -532,5 +508,4 @@ See Also * link:netty.html[Netty] * link:netty-http-server-example.html[Netty HTTP Server Example] -* link:jetty.html[Jetty] - +* link:jetty.html[Jetty] \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-netty/src/main/docs/netty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index 57132d0..694e578 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -1,4 +1,4 @@ -# Netty Component +## Netty Component *Available as of Camel 2.3* @@ -33,9 +33,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Netty-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a netty component is as follows @@ -51,9 +49,7 @@ UDP. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Netty-Options]] -Options -^^^^^^^ +### Options @@ -165,9 +161,7 @@ The Netty component supports 70 endpoint options which are listed below: -[[Netty-RegistrybasedOptions]] -Registry based Options -^^^^^^^^^^^^^^^^^^^^^^ +### Registry based Options Codec Handlers and SSL Keystores can be enlisted in the link:registry.html[Registry], such as in the Spring XML file. @@ -223,9 +217,7 @@ so Camel knows it should lookup. *Important:* Read below about using non shareable encoders/decoders. -[[Netty-Usingnonshareableencodersordecoders]] -Using non shareable encoders or decoders -++++++++++++++++++++++++++++++++++++++++ +#### Using non shareable encoders or decoders If your encoders or decoders is not shareable (eg they have the @Shareable class annotation), then your encoder/decoder must implement @@ -239,13 +231,9 @@ The Netty component offers a `org.apache.camel.component.netty.ChannelHandlerFactories` factory class, that has a number of commonly used methods. -[[Netty-SendingMessagestoandfromaNettyendpoint]] -Sending Messages to/from a Netty endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending Messages to/from a Netty endpoint -[[Netty-NettyProducer]] -Netty Producer -++++++++++++++ +#### Netty Producer In Producer mode, the component provides the ability to send payloads to a socket endpoint + @@ -254,9 +242,7 @@ a socket endpoint + The producer mode supports both one-way and request-response based operations. -[[Netty-NettyConsumer]] -Netty Consumer -++++++++++++++ +#### Netty Consumer In Consumer mode, the component provides the ability to: @@ -269,9 +255,7 @@ object based payloads and The consumer mode supports both one-way and request-response based operations. -[[Netty-Headers]] -Headers -^^^^^^^ +### Headers The following headers are filled for the exchanges created by the Netty consumer: @@ -292,13 +276,9 @@ netty. |`NettyConstants.NETTY_LOCAL_ADDRESS` / `CamelNettyLocalAddress` |`java.net.SocketAddress` |Local address of the incoming socket connection. |======================================================================= -[[Netty-UsageSamples]] -Usage Samples -^^^^^^^^^^^^^ +### Usage Samples -[[Netty-AUDPNettyendpointusingRequest-Replyandserializedobjectpayload]] -A UDP Netty endpoint using Request-Reply and serialized object payload -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### A UDP Netty endpoint using Request-Reply and serialized object payload [source,java] ------------------------------------------------------------------ @@ -316,9 +296,7 @@ RouteBuilder builder = new RouteBuilder() { }; ------------------------------------------------------------------ -[[Netty-ATCPbasedNettyconsumerendpointusingOne-waycommunication]] -A TCP based Netty consumer endpoint using One-way communication -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### A TCP based Netty consumer endpoint using One-way communication [source,java] ------------------------------------------- @@ -330,9 +308,7 @@ RouteBuilder builder = new RouteBuilder() { }; ------------------------------------------- -[[Netty-AnSSLTCPbasedNettyconsumerendpointusingRequest-Replycommunication]] -An SSL/TCP based Netty consumer endpoint using Request-Reply communication -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### An SSL/TCP based Netty consumer endpoint using Request-Reply communication [[Netty-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility @@ -444,9 +420,7 @@ enriches the Camel link:message.html[Message] with headers having details about the client certificate. For example the subject name is readily available in the header `CamelNettySSLClientCertSubjectName`. -[[Netty-UsingMultipleCodecs]] -Using Multiple Codecs -+++++++++++++++++++++ +#### Using Multiple Codecs In certain cases it may be necessary to add chains of encoders and decoders to the netty pipeline. To add multpile codecs to a camel netty @@ -470,9 +444,7 @@ a comma separated list or contained in a List e.g. or via spring. -[[Netty-ClosingChannelWhenComplete]] -Closing Channel When Complete -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Closing Channel When Complete When acting as a server you sometimes want to close the channel when, for example, a client conversion is finished. + @@ -500,9 +472,7 @@ written the bye message back to the client: }); -------------------------------------------------------------------------------------------------------- -[[Netty-Addingcustomchannelpipelinefactoriestogaincompletecontroloveracreatedpipeline]] -Adding custom channel pipeline factories to gain complete control over a created pipeline -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Adding custom channel pipeline factories to gain complete control over a created pipeline *Available as of Camel 2.5* @@ -576,9 +546,7 @@ context.addRoutes(new RouteBuilder() { }); ------------------------------------------------------------------- -[[Netty-ReusingNettybossandworkerthreadpools]] -Reusing Netty boss and worker thread pools -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Reusing Netty boss and worker thread pools *Available as of Camel 2.12* @@ -637,9 +605,7 @@ And if we have another route we can refer to the shared worker pool: ... and so forth. -[[Netty-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -647,5 +613,4 @@ See Also * link:getting-started.html[Getting Started] * link:netty-http.html[Netty HTTP] -* link:mina.html[MINA] - +* link:mina.html[MINA] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc index 79f724a..a90eb96 100644 --- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc +++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc @@ -1,4 +1,4 @@ -# Netty4 HTTP Component +## Netty4 HTTP Component *Available as of Camel 2.14* @@ -32,9 +32,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Netty4HTTP-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a netty component is as follows @@ -62,9 +60,7 @@ Keep also in mind that you cannot specify endpoint options using dynamic headers (like `CamelHttpQuery`). Endpoint options can be specified only at the endpoint URI definition level (like `to` or `from` DSL elements). -[[Netty4HTTP-HTTPOptions]] -HTTP Options -^^^^^^^^^^^^ +### HTTP Options INFO: *A lot more options*. *Important:* This component inherits all the options from @@ -205,9 +201,7 @@ The Netty4 HTTP component supports 83 endpoint options which are listed below: -[[Netty4HTTP-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers The following headers can be used on the producer to control the HTTP request. @@ -271,9 +265,7 @@ with the value `Basic`. `text/plain; charset="UTF-8"`. |======================================================================= -[[Netty4HTTP-AccesstoNettytypes]] -Access to Netty types -^^^^^^^^^^^^^^^^^^^^^ +### Access to Netty types This component uses the `org.apache.camel.component.netty4.http.NettyHttpMessage` as the message @@ -287,9 +279,7 @@ accessible at all times. io.netty.handler.codec.http.HttpRequest request = exchange.getIn(NettyHttpMessage.class).getHttpRequest(); ---------------------------------------------------------------------------------------------------------- -[[Netty4HTTP-Examples]] -Examples -^^^^^^^^ +### Examples In the route below we use Netty4 HTTP as a HTTP server, which returns back a hardcoded "Bye World" message. @@ -311,9 +301,7 @@ link:producertemplate.html[ProducerTemplate] as shown below: And we get back "Bye World" as the output. -[[Netty4HTTP-HowdoIletNettymatchwildcards]] -How do I let Netty match wildcards -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### How do I let Netty match wildcards By default Netty4 HTTP will only match on exact uri's. But you can instruct Netty to match prefixes. For example @@ -344,9 +332,7 @@ To match *any* endpoint you can do: from("netty4-http:http://0.0.0.0:8123?matchOnUriPrefix=true";).to("mock:foo"); ----------------------------------------------------------------------------- -[[Netty4HTTP-Usingmultiplerouteswithsameport]] -Using multiple routes with same port -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using multiple routes with same port In the same link:camelcontext.html[CamelContext] you can have multiple routes from Netty4 HTTP that shares the same port (eg a @@ -399,9 +385,7 @@ from("netty4-http:http://0.0.0.0:{{port}}/bar?ssl=true";) .transform().constant("Bye Camel"); -------------------------------------------------------------------------------------- -[[Netty4HTTP-Reusingsameserverbootstrapconfigurationwithmultipleroutes]] -Reusing same server bootstrap configuration with multiple routes -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reusing same server bootstrap configuration with multiple routes By configuring the common server bootstrap option in an single instance of a @@ -438,16 +422,12 @@ And in the routes you refer to this option as shown below </route> ---------------------------------------------------------------------------------------------------------- -[[Netty4HTTP-ReusingsameserverbootstrapconfigurationwithmultipleroutesacrossmultiplebundlesinOSGicontainer]] -Reusing same server bootstrap configuration with multiple routes across multiple bundles in OSGi container -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Reusing same server bootstrap configuration with multiple routes across multiple bundles in OSGi container See the link:netty-http-server-example.html[Netty HTTP Server Example] for more details and example how to do that. -[[Netty4HTTP-UsingHTTPBasicAuthentication]] -Using HTTP Basic Authentication -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Using HTTP Basic Authentication The Netty HTTP consumer supports HTTP basic authentication by specifying the security realm name to use, as shown below @@ -469,9 +449,7 @@ End user of Apache Karaf / ServiceMix has a karaf realm out of the box, and hence why the example above would work out of the box in these containers. -[[Netty4HTTP-SpecifyingACLonwebresources]] -Specifying ACL on web resources -+++++++++++++++++++++++++++++++ +#### Specifying ACL on web resources The `org.apache.camel.component.netty4.http.SecurityConstraint` allows to define constrains on web resources. And the @@ -523,9 +501,7 @@ below: </route> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -[[Netty4HTTP-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -534,5 +510,4 @@ See Also * link:netty.html[Netty] * link:netty-http-server-example.html[Netty HTTP Server Example] -* link:jetty.html[Jetty] - +* link:jetty.html[Jetty] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-netty4/src/main/docs/netty4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc index d03e858..5b8da98 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -1,4 +1,4 @@ -# Netty4 Component +## Netty4 Component *Available as of Camel 2.14* @@ -30,9 +30,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Netty4-URIformat]] -URI format -^^^^^^^^^^ +### URI format The URI scheme for a netty component is as follows @@ -48,9 +46,7 @@ UDP. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Netty4-Options]] -Options -^^^^^^^ +### Options @@ -173,9 +169,7 @@ The Netty4 component supports 74 endpoint options which are listed below: -[[Netty4-RegistrybasedOptions]] -Registry based Options -^^^^^^^^^^^^^^^^^^^^^^ +### Registry based Options Codec Handlers and SSL Keystores can be enlisted in the link:registry.html[Registry], such as in the Spring XML file. @@ -231,9 +225,7 @@ so Camel knows it should lookup. *Important:* Read below about using non shareable encoders/decoders. -[[Netty4-Usingnonshareableencodersordecoders]] -Using non shareable encoders or decoders -++++++++++++++++++++++++++++++++++++++++ +#### Using non shareable encoders or decoders If your encoders or decoders is not shareable (eg they have the @Shareable class annotation), then your encoder/decoder must implement @@ -247,13 +239,9 @@ The Netty component offers a `org.apache.camel.component.netty.ChannelHandlerFactories` factory class, that has a number of commonly used methods. -[[Netty4-SendingMessagestofromaNettyendpoint]] -Sending Messages to/from a Netty endpoint -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending Messages to/from a Netty endpoint -[[Netty4-NettyProducer]] -Netty Producer -++++++++++++++ +#### Netty Producer In Producer mode, the component provides the ability to send payloads to a socket endpoint + @@ -262,9 +250,7 @@ a socket endpoint + The producer mode supports both one-way and request-response based operations. -[[Netty4-NettyConsumer]] -Netty Consumer -++++++++++++++ +#### Netty Consumer In Consumer mode, the component provides the ability to: @@ -277,13 +263,9 @@ object based payloads and The consumer mode supports both one-way and request-response based operations. -[[Netty4-UsageSamples]] -Usage Samples -^^^^^^^^^^^^^ +### Usage Samples -[[Netty4-AUDPNettyendpointusingRequest-Replyandserializedobjectpayload]] -A UDP Netty endpoint using Request-Reply and serialized object payload -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### A UDP Netty endpoint using Request-Reply and serialized object payload [source,java] ------------------------------------------------------------------ @@ -301,9 +283,7 @@ RouteBuilder builder = new RouteBuilder() { }; ------------------------------------------------------------------ -[[Netty4-ATCPbasedNettyconsumerendpointusingOne-waycommunication]] -A TCP based Netty consumer endpoint using One-way communication -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### A TCP based Netty consumer endpoint using One-way communication [source,java] ------------------------------------------- @@ -315,9 +295,7 @@ RouteBuilder builder = new RouteBuilder() { }; ------------------------------------------- -[[Netty4-AnSSLTCPbasedNettyconsumerendpointusingRequest-Replycommunication]] -An SSL/TCP based Netty consumer endpoint using Request-Reply communication -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### An SSL/TCP based Netty consumer endpoint using Request-Reply communication [[Netty4-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility @@ -429,9 +407,7 @@ enriches the Camel link:message.html[Message] with headers having details about the client certificate. For example the subject name is readily available in the header `CamelNettySSLClientCertSubjectName`. -[[Netty4-UsingMultipleCodecs]] -Using Multiple Codecs -+++++++++++++++++++++ +#### Using Multiple Codecs In certain cases it may be necessary to add chains of encoders and decoders to the netty pipeline. To add multpile codecs to a camel netty @@ -538,9 +514,7 @@ or via spring. </camelContext> ------------------------------------------------------------------------------------------------------------- -[[Netty4-ClosingChannelWhenComplete]] -Closing Channel When Complete -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Closing Channel When Complete When acting as a server you sometimes want to close the channel when, for example, a client conversion is finished. + @@ -570,8 +544,7 @@ written the bye message back to the client: [[Netty4-Addingcustomchannelpipelinefactoriestogaincompletecontroloveracreatedpipeline]] Adding custom channel pipeline factories to gain complete control over a -created pipeline -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### created pipeline Custom channel pipelines provide complete control to the user over the handler/interceptor chain by inserting custom handler(s), encoder(s) & @@ -641,9 +614,7 @@ context.addRoutes(new RouteBuilder() { }); ---------------------------------------------------------------------- -[[Netty4-ReusingNettybossandworkerthreadpools]] -Reusing Netty boss and worker thread pools -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Reusing Netty boss and worker thread pools *Available as of Camel 2.12* @@ -702,9 +673,7 @@ And if we have another route we can refer to the shared worker pool: ... and so forth. -[[Netty4-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -712,4 +681,4 @@ See Also * link:getting-started.html[Getting Started] * link:netty-http.html[Netty HTTP] -* link:mina.html[MINA] +* link:mina.html[MINA] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-ognl/src/main/docs/ognl-language.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ognl/src/main/docs/ognl-language.adoc b/components/camel-ognl/src/main/docs/ognl-language.adoc index afaa8b8..a189a74 100644 --- a/components/camel-ognl/src/main/docs/ognl-language.adoc +++ b/components/camel-ognl/src/main/docs/ognl-language.adoc @@ -1,4 +1,4 @@ -# OGNL Language +## OGNL Language Camel allows http://commons.apache.org/proper/commons-ognl/[OGNL] to be used as an link:expression.html[Expression] or @@ -21,9 +21,7 @@ you can construct the syntax as follows: "getRequest().getBody().getFamilyName()" ---------------------------------------- -[[OGNL-Options]] -OGNL Options -^^^^^^^^^^^^ +### OGNL Options // language options: START @@ -42,9 +40,7 @@ The OGNL language supports 1 options which are listed below. -[[OGNL-Variables]] -Variables -^^^^^^^^^ +### Variables [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -71,9 +67,7 @@ Variables |property(name, type) |Type |the property by the given name as the given type |======================================================================= -[[OGNL-Samples]] -Samples -^^^^^^^ +### Samples For example you could use OGNL inside a link:message-filter.html[Message Filter] in XML @@ -96,9 +90,7 @@ And the sample using Java DSL: from("seda:foo").filter().ognl("request.headers.foo == 'bar'").to("seda:bar"); --------------------------------------------------------------------------------- -[[OGNL-Loadingscriptfromexternalresource]] -Loading script from external resource -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Loading script from external resource *Available as of Camel 2.11* @@ -112,9 +104,7 @@ eg to refer to a file on the classpath you can do: .setHeader("myHeader").ognl("resource:classpath:myognl.txt") ------------------------------------------------------------ -[[OGNL-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use OGNL in your camel routes you need to add the a dependency on *camel-ognl* which implements the OGNL language. @@ -133,4 +123,4 @@ link:download.html[the download page for the latest versions]). ------------------------------------- Otherwise, you'll also need -http://repo2.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.ognl/2.7.3_4/org.apache.servicemix.bundles.ognl-2.7.3_4.jar[OGNL] +http://repo2.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.ognl/2.7.3_4/org.apache.servicemix.bundles.ognl-2.7.3_4.jar[OGNL] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index 28a432c..50aa53a 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -1,4 +1,4 @@ -# Olingo2 Component +## Olingo2 Component *Available as of Camel 2.14* @@ -30,18 +30,14 @@ for this component: </dependency> ---------------------------------------------- -[[Olingo2-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------------------------------ olingo2://endpoint/<resource-path>?[options] ------------------------------------------------ -[[Olingo2-Olingo2Component]] -Olingo2 Options -^^^^^^^^^^^^^^^ +### Olingo2 Options @@ -93,9 +89,7 @@ The Olingo2 component supports 16 endpoint options which are listed below: // endpoint options: END -[[Olingo2-ProducerEndpoints]] -Producer Endpoints -^^^^^^^^^^^^^^^^^^ +### Producer Endpoints Producer endpoints can use endpoint names and options listed next. Producer endpoints can also use a special option *`inBody`* that @@ -139,9 +133,7 @@ org.apache.olingo.odata2.api.commons.HttpStatusCodes for other OData resources |update |data, resourcePath |PUT |org.apache.olingo.odata2.api.commons.HttpStatusCodes |======================================================================= -[[Olingo2-ODataResourceTypeMapping]] -OData Resource Type Mapping -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### OData Resource Type Mapping The result of *read* endpoint and data type of *data* option depends on the OData resource being queried, created or modified. @@ -174,9 +166,7 @@ java.util.List<java.util.Map<String, Object>> containing list of key property na |Count |<resource-uri>/$count |java.lang.Long |======================================================================= -[[Olingo2-ConsumerEndpoints]] -Consumer Endpoints -^^^^^^^^^^^^^^^^^^ +### Consumer Endpoints Only the *read* endpoint can be used as a consumer endpoint. Consumer endpoints can @@ -187,16 +177,12 @@ collection will generate one exchange per element, and their routes will be executed once for each exchange. This behavior can be disabled by setting the endpoint property *consumer.splitResult=false*. -[[Olingo2-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Any URI option can be provided in a message header for producer endpoints with a *`CamelOlingo2.`* prefix. -[[Olingo2-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body All result message bodies utilize objects provided by the underlying http://olingo.apache.org/javadoc/odata2/index.html[Apache Olingo 2.0 @@ -206,9 +192,7 @@ parameter. For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages, unless *consumer.splitResult* is set to *false*. -[[Olingo2-Usecases]] -Use cases -^^^^^^^^^ +### Use cases The following route reads top 5 entries from the Manufacturer feed ordered by ascending Name property. @@ -265,5 +249,4 @@ consumer endpoint will produce an *ODataFeed* value the first time, and --------------------------------------------------------------------------------------------------------- from("olingo2://read/Manufacturers?queryParams=#paramsBean&consumer.timeUnit=SECONDS&consumer.delay=30") .to("bean:blah"); ---------------------------------------------------------------------------------------------------------- - +--------------------------------------------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openshift/src/main/docs/openshift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc index d68834a..6d36b61 100644 --- a/components/camel-openshift/src/main/docs/openshift-component.adoc +++ b/components/camel-openshift/src/main/docs/openshift-component.adoc @@ -1,4 +1,4 @@ -# OpenShift Component +## OpenShift Component *Available as of Camel 2.14* @@ -18,9 +18,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Openshift-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------- @@ -30,9 +28,7 @@ openshift:clientId[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Openshift-Options]] -Options -^^^^^^^ +### Options @@ -95,13 +91,9 @@ The OpenShift component supports 27 endpoint options which are listed below: // endpoint options: END -[[Openshift-Examples]] -Examples -^^^^^^^^ +### Examples -[[Openshift-Listingallapplications]] -Listing all applications -++++++++++++++++++++++++ +#### Listing all applications [source,java] -------------------------------------------------------------------------- @@ -114,9 +106,7 @@ from("direct:apps") In this case the information about all the applications is returned as pojo. If you want a json response, then set mode=json. -[[Openshift-Stoppinganapplication]] -Stopping an application -+++++++++++++++++++++++ +#### Stopping an application [source,java] --------------------------------------------------------------------------------------------- @@ -160,12 +150,9 @@ following headers is included. |CamelOpenShiftEventNewState |No |The new state, for any of the event types |======================================================================= -[[Openshift-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index 53d008d..f21dcc6 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -1,12 +1,10 @@ -# OpenStack Cinder Component +## OpenStack Cinder Component *Available as of Camel 2.19* The openstack-cinder component allows messages to be sent to an OpenStack block storage services. -[[openstack-cinder-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -24,9 +22,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-cinder-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -36,9 +32,7 @@ openstack-cinder://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-cinder-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Cinder component has no options. @@ -66,17 +60,12 @@ The OpenStack Cinder component supports 10 endpoint options which are listed bel // endpoint options: END -[[openstack-cinder-Usage]] -Usage -^^^^^ +### Usage You can use following settings for each subsystem: -volumes -~~~~~~~ +### volumes -[[openstack-cinder-OperationsYouCanPerformWiththeVolumeProducer]] -Operations you can perform with the Volume producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Volume producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -94,9 +83,7 @@ Operations you can perform with the Volume producer |`delete` | Delete the volume. |========================================================================= -[[openstack-cinder-MessageheadersevaluatedbytheVolumeProducer]] -Message headers evaluated by the Volume producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Volume producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -123,12 +110,9 @@ Message headers evaluated by the Volume producer If you need more precise volume settings you can create new object of the type *org.openstack4j.model.storage.block.Volume* and send in the message body. -snapshots -~~~~~~~~~ +### snapshots -[[openstack-cinder-OperationsYouCanPerformWiththeSnapshotProducer]] -Operations you can perform with the Snapshot producer -+++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Snapshot producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -145,9 +129,7 @@ Operations you can perform with the Snapshot producer |========================================================================= -[[openstack-cinder-MessageheadersevaluatedbytheSnapshotProducer]] -Message headers evaluated by the Snapshot producer -++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Snapshot producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -169,14 +151,11 @@ Message headers evaluated by the Snapshot producer If you need more precise server settings you can create new object of the type *org.openstack4j.model.storage.block.VolumeSnapshot* and send in the message body. -[[CamelOpenstack-cinder-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-glance-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 168e4f8..db76a0c 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -1,12 +1,10 @@ -# OpenStack Glance Component +## OpenStack Glance Component *Available as of Camel 2.19* The openstack-glance component allows messages to be sent to an OpenStack image services. -[[openstack-glance-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -24,9 +22,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-glance-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -36,9 +32,7 @@ openstack-glance://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-glance-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Glance component has no options. @@ -65,9 +59,7 @@ The OpenStack Glance component supports 9 endpoint options which are listed belo // endpoint options: END -[[openstack-glance-Usage]] -Usage -^^^^^ +### Usage [width="100%",cols="20%,80%",options="header",] |========================================================================= @@ -88,9 +80,7 @@ Usage |`delete` | Delete the image. |========================================================================= -[[openstack-glance-MessageheadersevaluatedbytheGlanceProducer]] -Message headers evaluated by the Glance producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Glance producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -121,14 +111,11 @@ Message headers evaluated by the Glance producer |`properties` | `Map` | Image properties. |========================================================================= -[[CamelOpenstack-glance-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc index 4460243..6e1b10f 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -1,4 +1,4 @@ -# OpenStack Keystone Component +## OpenStack Keystone Component *Available as of Camel 2.19* @@ -6,9 +6,7 @@ The openstack-keystone component allows messages to be sent to an OpenStack iden *The openstack-keystone component supports only Identity API v3!* -[[openstack-keystone-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -26,9 +24,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-keystone-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -38,9 +34,7 @@ openstack-keystone://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-keystone-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Keystone component has no options. @@ -67,17 +61,12 @@ The OpenStack Keystone component supports 9 endpoint options which are listed be // endpoint options: END -[[openstack-keystone-Usage]] -Usage -^^^^^ +### Usage You can use following settings for each subsystem: -domains -~~~~~~~ +### domains -[[openstack-keystone-OperationsYouCanPerformWithDomainProducer]] -Operations you can perform with the Domain producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Domain producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -93,9 +82,7 @@ Operations you can perform with the Domain producer |`delete` | Delete the domain. |========================================================================= -[[openstack-keystone-MessageHeadersEvaluatedByTheDomainProducer]] -Message headers evaluated by the Domain producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Domain producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -112,12 +99,9 @@ Message headers evaluated by the Domain producer If you need more precise domain settings you can create new object of the type *org.openstack4j.model.identity.v3.Domain* and send in the message body. -groups -~~~~~~ +### groups -[[openstack-keystone-OperationsYouCanPerformWithGroupProducer]] -Operations you can perform with the Group producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Group producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -139,9 +123,7 @@ Operations you can perform with the Group producer |`removeUserFromGroup` | Remove the user from the group. |========================================================================= -[[openstack-keystone-MessageHeadersEvaluatedByTheGroupProducer]] -Message headers evaluated by the Group producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Group producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -162,12 +144,9 @@ Message headers evaluated by the Group producer If you need more precise group settings you can create new object of the type *org.openstack4j.model.identity.v3.Group* and send in the message body. -projects -~~~~~~~~ +### projects -[[openstack-keystone-OperationsYouCanPerformWithProjectProducer]] -Operations you can perform with the Project producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Project producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -183,9 +162,7 @@ Operations you can perform with the Project producer |`delete` | Delete the project. |========================================================================= -[[openstack-keystone-MessageHeadersEvaluatedByTheProjectProducer]] -Message headers evaluated by the Project producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Project producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -206,12 +183,9 @@ Message headers evaluated by the Project producer If you need more precise project settings you can create new object of the type *org.openstack4j.model.identity.v3.Project* and send in the message body. -regions -~~~~~~~ +### regions -[[openstack-keystone-OperationsYouCanPerformWithRegionProducer]] -Operations you can perform with the Region producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Region producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -227,9 +201,7 @@ Operations you can perform with the Region producer |`delete` | Delete the region. |========================================================================= -[[openstack-keystone-MessageHeadersEvaluatedByTheRegionProducer]] -Message headers evaluated by the Region producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Region producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -244,12 +216,9 @@ Message headers evaluated by the Region producer If you need more precise region settings you can create new object of the type *org.openstack4j.model.identity.v3.Region* and send in the message body. -users -~~~~~ +### users -[[openstack-keystone-OperationsYouCanPerformWithUserProducer]] -Operations you can perform with the User producer -+++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the User producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -265,9 +234,7 @@ Operations you can perform with the User producer |`delete` | Delete the user. |========================================================================= -[[openstack-keystone-MessageHeadersEvaluatedByTheUserProducer]] -Message headers evaluated by the User producer -++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the User producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -290,14 +257,11 @@ Message headers evaluated by the User producer If you need more precise user settings you can create new object of the type *org.openstack4j.model.identity.v3.User* and send in the message body. -[[CamelOpenstack-keystone-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc index 90e9ccd..61f0661 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -1,12 +1,10 @@ -# OpenStack Neutron Component +## OpenStack Neutron Component *Available as of Camel 2.19* The openstack-neutron component allows messages to be sent to an OpenStack network services. -[[openstack-neutron-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -24,9 +22,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-neutron-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -36,9 +32,7 @@ openstack-neutron://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-neutron-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Neutron component has no options. @@ -66,17 +60,12 @@ The OpenStack Neutron component supports 10 endpoint options which are listed be // endpoint options: END -[[openstack-neutron-Usage]] -Usage -^^^^^ +### Usage You can use following settings for each subsystem: -networks -~~~~~~~~ +### networks -[[openstack-neutron-OperationsYouCanPerformWiththeNetworkProducer]] -Operations you can perform with the Network producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Network producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -90,9 +79,7 @@ Operations you can perform with the Network producer |`delete` | Delete the network. |========================================================================= -[[openstack-neutron-MessageheadersevaluatedbytheNetworkProducer]] -Message headers evaluated by the Network producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Network producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -121,12 +108,9 @@ Message headers evaluated by the Network producer If you need more precise network settings you can create new object of the type *org.openstack4j.model.network.Network* and send in the message body. -subnets -~~~~~~~ +### subnets -[[openstack-neutron-OperationsYouCanPerformWiththeSubnetProducer]] -Operations you can perform with the Subnet producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Subnet producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -142,9 +126,7 @@ Operations you can perform with the Subnet producer |`action` | Perform an action on the subnet. |========================================================================= -[[openstack-neutron-MessageheadersevaluatedbytheSubnetProducer]] -Message headers evaluated by the Subnet producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Subnet producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -165,12 +147,9 @@ Message headers evaluated by the Subnet producer If you need more precise subnet settings you can create new object of the type *org.openstack4j.model.network.Subnet* and send in the message body. -ports -~~~~~ +### ports -[[openstack-neutron-OperationsYouCanPerformWiththePortProducer]] -Operations you can perform with the Port producer -+++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Port producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -187,9 +166,7 @@ Operations you can perform with the Port producer |========================================================================= -[[openstack-neutron-MessageheadersevaluatedbythePortProducer]] -Message headers evaluated by the Port producer -++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Port producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -208,12 +185,9 @@ Message headers evaluated by the Port producer |`macAddress` | `String` | MAC address. |========================================================================= -routers -~~~~~~~ +### routers -[[openstack-neutron-OperationsYouCanPerformWiththeRouterProducer]] -Operations you can perform with the Router producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Router producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -234,9 +208,7 @@ Operations you can perform with the Router producer |========================================================================= -[[openstack-neutron-MessageheadersevaluatedbytheRouterProducer]] -Message headers evaluated by the Port producer -++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Port producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -258,14 +230,11 @@ Message headers evaluated by the Port producer |========================================================================= -[[CamelOpenstack-neutron-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-nova-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc index f37d49c..743f328 100644 --- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc @@ -1,12 +1,10 @@ -# OpenStack Nova Component +## OpenStack Nova Component *Available as of Camel 2.19* The openstack-nova component allows messages to be sent to an OpenStack compute services. -[[openstack-nova-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -24,9 +22,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-nova-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -36,9 +32,7 @@ openstack-nova://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-nova-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Nova component has no options. @@ -66,17 +60,12 @@ The OpenStack Nova component supports 10 endpoint options which are listed below // endpoint options: END -[[openstack-nova-Usage]] -Usage -^^^^^ +### Usage You can use following settings for each subsystem: -flavors -~~~~~~~ +### flavors -[[openstack-nova-OperationsYouCanPerformWiththeFlavorProducer]] -Operations you can perform with the Flavor producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Flavor producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -90,9 +79,7 @@ Operations you can perform with the Flavor producer |`delete` | Delete the flavor. |========================================================================= -[[openstack-nova-MessageheadersevaluatedbytheFlavorProducer]] -Message headers evaluated by the Flavor producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Flavor producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -117,12 +104,9 @@ Message headers evaluated by the Flavor producer If you need more precise flavor settings you can create new object of the type *org.openstack4j.model.compute.Flavor* and send in the message body. -servers -~~~~~~~ +### servers -[[openstack-nova-OperationsYouCanPerformWiththeServerProducer]] -Operations you can perform with the Server producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Server producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -140,9 +124,7 @@ Operations you can perform with the Server producer |`action` | Perform an action on the server. |========================================================================= -[[openstack-nova-MessageheadersevaluatedbytheServerProducer]] -Message headers evaluated by the Server producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Server producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -169,12 +151,9 @@ Message headers evaluated by the Server producer If you need more precise server settings you can create new object of the type *org.openstack4j.model.compute.ServerCreate* and send in the message body. -keypairs -~~~~~~~~ +### keypairs -[[openstack-nova-OperationsYouCanPerformWiththeKeypairProducer]] -Operations you can perform with the Keypair producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Keypair producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -189,9 +168,7 @@ Operations you can perform with the Keypair producer |========================================================================= -[[openstack-nova-MessageheadersevaluatedbytheKeypairProducer]] -Message headers evaluated by the Keypair producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Keypair producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -203,14 +180,11 @@ Message headers evaluated by the Keypair producer |========================================================================= -[[CamelOpenstack-nova-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-openstack/src/main/docs/openstack-swift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc index e7581a0..f19769f 100644 --- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc @@ -1,12 +1,10 @@ -# OpenStack Swift Component +## OpenStack Swift Component *Available as of Camel 2.19* The openstack-swift component allows messages to be sent to an OpenStack object storage services. -[[openstack-swift-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users will need to add the following dependency to their pom.xml. @@ -24,9 +22,7 @@ Maven users will need to add the following dependency to their pom.xml. where `${camel-version`} must be replaced by the actual version of Camel. -[[openstack-swift-URIFormat]] -URI Format -^^^^^^^^^^ +### URI Format [source,java] ---------------------------- @@ -36,9 +32,7 @@ openstack-swift://hosturl[?options] You can append query options to the URI in the following format `?options=value&option2=value&...` -[[openstack-swift-URIOptions]] -URI Options -^^^^^^^^^^^ +### URI Options // component options: START The OpenStack Swift component has no options. @@ -66,17 +60,12 @@ The OpenStack Swift component supports 10 endpoint options which are listed belo // endpoint options: END -[[openstack-swift-Usage]] -Usage -^^^^^ +### Usage You can use following settings for each subsystem: -containers -~~~~~~~~~~ +### containers -[[openstack-swift-OperationsYouCanPerformWiththeContainerProducer]] -Operations you can perform with the Container producer -++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Container producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -98,9 +87,7 @@ Operations you can perform with the Container producer |`deleteMetadata` | Delete metadata. |========================================================================= -[[openstack-swift-MessageheadersevaluatedbytheVolumeProducer]] -Message headers evaluated by the Volume producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Volume producer [width="100%",cols="20%,10%,70%",options="header",] |========================================================================= @@ -133,12 +120,9 @@ Message headers evaluated by the Volume producer If you need more precise container settings you can create new object of the type *org.openstack4j.model.storage.object.options.CreateUpdateContainerOptions* (in case of create or update operation) or *org.openstack4j.model.storage.object.options.ContainerListOptions* for listing containers and send in the message body. -objects -~~~~~~~ +### objects -[[openstack-swift-OperationsYouCanPerformWiththeObjectsProducer]] -Operations you can perform with the Object producer -+++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Operations you can perform with the Object producer [width="100%",cols="20%,80%",options="header",] |========================================================================= |Operation | Description @@ -159,9 +143,7 @@ Operations you can perform with the Object producer |========================================================================= -[[openstack-swift-MessageheadersevaluatedbytheObjectProducer]] -Message headers evaluated by the Object producer -++++++++++++++++++++++++++++++++++++++++++++++++ +#### Message headers evaluated by the Object producer [width="100%",cols="10%,10%,80%",options="header",] |========================================================================= @@ -175,14 +157,11 @@ Message headers evaluated by the Object producer |========================================================================= -[[CamelOpenstack-swift-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] -* link:openstack.html[openstack Component] - +* link:openstack.html[openstack Component] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc index e1ffa11..eb72003 100644 --- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc @@ -1,4 +1,4 @@ -# OptaPlanner Component +## OptaPlanner Component *Available as of Camel 2.13* @@ -22,9 +22,7 @@ for this component: </dependency> ------------------------------------------------------------------------------------ -[[OptaPlanner-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ---------------------------------- @@ -37,9 +35,7 @@ example `/org/foo/barSolverConfig.xml`. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[OptaPlanner-URIOptions]] -OptaPlanner Options -^^^^^^^^^^^ +### OptaPlanner Options // component options: START @@ -68,9 +64,7 @@ The OptaPlanner component supports 8 endpoint options which are listed below: // endpoint options: END -[[OptaPlanner-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers [width="100%",cols="10%,10%,10%,10%,60%",options="header",] |======================================================================= @@ -82,9 +76,7 @@ Message Headers rather than blocking the current thread. |======================================================================= -[[OptaPlanner-MessageBody]] -Message Body -^^^^^^^^^^^^ +### Message Body Camel takes the planning problem for the IN body, solves it and returns it on the OUT body. (since v 2.16) The IN body object supports the following use cases: @@ -98,9 +90,7 @@ wait till isEveryProblemFactChangeProcessed before returning result. * If the body is none of the above types, then the producer will return the best result from the solver identified by solverId -[[OptaPlanner-Termination]] -Termination -^^^^^^^^^^^ +### Termination The solving will take as long as specified in the `solverConfig`. @@ -120,9 +110,7 @@ The solving will take as long as specified in the `solverConfig`.  -[[OptaPlanner-Samples]] -Samples -+++++++ +#### Samples Solve an planning problem that's on the ActiveMQ queue with OptaPlanner: @@ -140,12 +128,9 @@ from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer") .to("optaplanner:/org/foo/barSolverConfig.xml"); ------------------------------------------------------- -[[OptaPlanner-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-paho/src/main/docs/paho-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc index 1dda450..c1c4a55 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -1,4 +1,4 @@ -# Paho Component +## Paho Component INFO: Available as of Camel 2.16 @@ -7,9 +7,7 @@ the https://eclipse.org/paho/[Eclipse Paho] library. Paho is one of the most popular MQTT libraries, so if you would like to integrate it with your Java project - Camel Paho connector is a way to go. -[[Paho-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] ------------------------ @@ -47,9 +45,7 @@ from("paho:some/queue?brokerUrl=tcp://iot.eclipse.org:1883").  -[[Paho-Addingthecomponenttotheproject]] -Adding the component to the project -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Adding the component to the project Maven users will need to add the following dependency to their `pom.xml` for this component: @@ -80,9 +76,7 @@ you need to add Eclipse Paho repository to your POM xml file: </repositories> -------------------------------------------------------------------------- -[[Paho-Defaultpayloadtype]] -Default payload type -^^^^^^^^^^^^^^^^^^^^ +### Default payload type  @@ -118,9 +112,7 @@ String payload = "message"; producerTemplate.sendBody("paho:topic", payload); -------------------------------------------------------------------------- -[[Paho-URIOptions]] -Paho Options -^^^^^^^^^^^^ +### Paho Options @@ -167,9 +159,7 @@ The Paho component supports 12 endpoint options which are listed below: // endpoint options: END -[[Paho-Headers]] -Headers -^^^^^^^ +### Headers The following headers are recognized by the Paho component: @@ -187,12 +177,9 @@ stored as a header but on the |=======================================================================  -[[Paho-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc index 2a6320f..024d3b2 100644 --- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc +++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc @@ -1,4 +1,4 @@ -# OSGi PAX Logging Component +## OSGi PAX Logging Component *Available in Camel 2.6* @@ -6,9 +6,7 @@ The `paxlogging` component can be used in an OSGi environment to receive http://wiki.ops4j.org/display/paxlogging/Pax+Logging[PaxLogging] events and process them. -[[Pax-Logging-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies Maven users need to add the following dependency to their `pom.xml` @@ -24,9 +22,7 @@ Maven users need to add the following dependency to their `pom.xml` where `${camel-version`} must be replaced by the actual version of Camel (2.6.0 or higher). -[[Pax-Logging-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,xml] ----------------------------- @@ -36,9 +32,7 @@ paxlogging:appender[?options] where `appender` is the name of the pax appender that need to be configured in the PaxLogging service configuration. -[[Pax-Logging-URIoptions]] -URI options -^^^^^^^^^^^ +### URI options @@ -76,15 +70,11 @@ The OSGi PAX Logging component supports 5 endpoint options which are listed belo // endpoint options: END -[[Pax-Logging-Messagebody]] -Message body -^^^^^^^^^^^^ +### Message body The `in` message body will be set to the received PaxLoggingEvent. -[[Pax-Logging-Exampleusage]] -Example usage -^^^^^^^^^^^^^ +### Example usage [source,xml] ---------------------------------- @@ -99,4 +89,4 @@ Configuration: [source,java] ---------------------------------------------------------- log4j.rootLogger=INFO, out, osgi:VmLogAppender, osgi:camel ----------------------------------------------------------- +---------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-pdf/src/main/docs/pdf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc index 052f899..6723202 100644 --- a/components/camel-pdf/src/main/docs/pdf-component.adoc +++ b/components/camel-pdf/src/main/docs/pdf-component.adoc @@ -1,4 +1,4 @@ -# PDF Component +## PDF Component **Available as of Camel 2.16.0** @@ -22,9 +22,7 @@ following dependency to their `pom.xml`: </dependency> ------------------------------------------------------------ -[[PDF-URIformat]] -URI format -^^^^^^^^^^ +### URI format The PDF component only supports producer endpoints. @@ -33,9 +31,7 @@ The PDF component only supports producer endpoints. pdf:operation[?options] ----------------------- -[[PDF-Options]] -Options -^^^^^^^ +### Options // component options: START The PDF component has no options. @@ -65,9 +61,7 @@ The PDF component supports 10 endpoint options which are listed below: // endpoint options: END -[[PDF-Headers]] -Headers -^^^^^^^ +### Headers [width="100%",cols="10%,90%",options="header",] |======================================================================= |Header |Description @@ -86,9 +80,7 @@ ishttps://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/encryp *Mandatory* header if PDF document is encrypted. |======================================================================= -[[PDF-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -97,4 +89,4 @@ See Also -  -- +- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-pgevent/src/main/docs/pgevent-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc index de2ef0b..6faaec4 100644 --- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc +++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc @@ -1,4 +1,4 @@ -# PostgresSQL Event Component +## PostgresSQL Event Component This is a component for Apache Camel which allows for Producing/Consuming PostgreSQL events related to the LISTEN/NOTIFY @@ -31,9 +31,7 @@ pgevent://host:port/database/channel[?parameters] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[PGEvent-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -65,12 +63,9 @@ The PostgresSQL Event component supports 11 endpoint options which are listed be // endpoint options: END -[[PGEvent-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - +* link:getting-started.html[Getting Started] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-printer/src/main/docs/lpr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc index 8b07696..ecaf9b7 100644 --- a/components/camel-printer/src/main/docs/lpr-component.adoc +++ b/components/camel-printer/src/main/docs/lpr-component.adoc @@ -1,4 +1,4 @@ -# Printer Component +## Printer Component *Available as of Camel 2.1* @@ -27,9 +27,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Printer-URIformat]] -URI format -^^^^^^^^^^ +### URI format Since the URI scheme for a printer has not been standardized (the nearest thing to a standard being the IETF print standard) and therefore @@ -44,9 +42,7 @@ lpr://remotehost:port/path/to/printer[?options] You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Printer-Options]] -Options -^^^^^^^ +### Options // component options: START @@ -81,25 +77,17 @@ The Printer component supports 14 endpoint options which are listed below: // endpoint options: END -[[Printer-SendingMessagestoaPrinter]] -Sending Messages to a Printer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Sending Messages to a Printer -[[Printer-PrinterProducer]] -Printer Producer -++++++++++++++++ +#### Printer Producer Sending data to the printer is very straightforward and involves creating a producer endpoint that can be sent message exchanges on in route. -[[Printer-UsageSamples]] -Usage Samples -^^^^^^^^^^^^^ +### Usage Samples -[[Printer-Example1:PrintingtextbasedpayloadsonaDefaultprinterusingletterstationaryandone-sidedmode]] -Example 1: Printing text based payloads on a Default printer using letter stationary and one-sided mode -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Example 1: Printing text based payloads on a Default printer using letter stationary and one-sided mode [source,java] ----------------------------------------------- @@ -114,9 +102,7 @@ RouteBuilder builder = new RouteBuilder() { }}; ----------------------------------------------- -[[Printer-Example2:PrintingGIFbasedpayloadsonaRemoteprinterusingA4stationaryandone-sidedmode]] -Example 2: Printing GIF based payloads on a Remote printer using A4 stationary and one-sided mode -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Example 2: Printing GIF based payloads on a Remote printer using A4 stationary and one-sided mode [source,java] -------------------------------------------------- @@ -130,9 +116,7 @@ RouteBuilder builder = new RouteBuilder() { }}; -------------------------------------------------- -[[Printer-Example3:PrintingJPEGbasedpayloadsonaRemoteprinterusingJapanesePostcardstationaryandone-sidedmode]] -Example 3: Printing JPEG based payloads on a Remote printer using Japanese Postcard stationary and one-sided mode -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +#### Example 3: Printing JPEG based payloads on a Remote printer using Japanese Postcard stationary and one-sided mode [source,java] -------------------------------------------------- @@ -145,4 +129,4 @@ RouteBuilder builder = new RouteBuilder() { "&mediaSize=JAPANESE_POSTCARD" + "&flavor=DocFlavor.INPUT_STREAM") }}; --------------------------------------------------- +-------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc index f6610e4..abc66f6 100644 --- a/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc +++ b/components/camel-protobuf/src/main/docs/protobuf-dataformat.adoc @@ -1,4 +1,4 @@ -# Protobuf DataFormat +## Protobuf DataFormat [[Protobuf-Protobuf-ProtocolBuffers]] Protobuf - Protocol Buffers --------------------------- @@ -21,9 +21,7 @@ http://code.google.com/apis/protocolbuffers/[API Site] + http://code.google.com/apis/protocolbuffers/docs/javatutorial.html[Protobuf Java Tutorial] -[[Protobuf-Options]] -Protobuf Options -^^^^^^^^^^^^^^^^ +### Protobuf Options // dataformat options: START The Protobuf dataformat supports 2 options which are listed below. @@ -40,17 +38,13 @@ The Protobuf dataformat supports 2 options which are listed below. {% endraw %} // dataformat options: END -[[Protobuf-Protobufoverview]] -Protobuf overview -~~~~~~~~~~~~~~~~~ +### Protobuf overview This quick overview of how to use Protobuf. For more detail see the http://code.google.com/apis/protocolbuffers/docs/javatutorial.html[complete tutorial] -[[Protobuf-Definingtheprotoformat]] -Defining the proto format -^^^^^^^^^^^^^^^^^^^^^^^^^ +### Defining the proto format The first step is to define the format for the body of your exchange. This is defined in a .proto file as so: @@ -89,9 +83,7 @@ message AddressBook { } ------------------------------------------------------------ -[[Protobuf-GeneratingJavaclasses]] -Generating Java classes -^^^^^^^^^^^^^^^^^^^^^^^ +### Generating Java classes The Protobuf SDK provides a compiler which will generate the Java classes for the format we defined in our .proto file. You can run the @@ -110,9 +102,7 @@ to use a class that does not implement com.google.protobuf.Message. Use the generated builders to translate the data from any of your existing domain classes. -[[Protobuf-JavaDSL]] -Java DSL -~~~~~~~~ +### Java DSL You can use create the ProtobufDataFormat instance and pass it to Camel DataFormat marshal and unmarsha API like this. @@ -139,9 +129,7 @@ default instance class name like this. from("direct:unmarshalB").unmarshal().protobuf(Person.getDefaultInstance()).to("mock:reverse"); -------------------------------------------------------------------------------------------------- -[[Protobuf-SpringDSL]] -Spring DSL -~~~~~~~~~~ +### Spring DSL The following example shows how to use Castor to unmarshal using Spring configuring the protobuf data type @@ -159,9 +147,7 @@ configuring the protobuf data type </camelContext> ---------------------------------------------------------------------------------------------------------- -[[Protobuf-Dependencies]] -Dependencies -^^^^^^^^^^^^ +### Dependencies To use Protobuf in your camel routes you need to add the a dependency on *camel-protobuf* which implements this data format. @@ -177,4 +163,4 @@ link:download.html[the download page for the latest versions]). <artifactId>camel-protobuf</artifactId> <version>2.2.0</version> </dependency> ------------------------------------------ +----------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/28429681/components/camel-quartz/src/main/docs/quartz-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc index a2c0df2..55ef207 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -1,4 +1,4 @@ -# Quartz Component +## Quartz Component The *quartz:* component provides a scheduled delivery of messages using the http://www.quartz-scheduler.org/[Quartz Scheduler 1.x]. + @@ -21,9 +21,7 @@ for this component: </dependency> ------------------------------------------------------------ -[[Quartz-URIformat]] -URI format -^^^^^^^^^^ +### URI format [source,java] -------------------------------------------- @@ -41,9 +39,7 @@ name. You can append query options to the URI in the following format, `?option=value&option=value&...` -[[Quartz-Options]] -Options -^^^^^^^ +### Options @@ -115,9 +111,7 @@ required by the `QuartzScheduler` in the OSGi container. If you do not set any `id` on <camelContext> then + a unique id is auto assigned, and there is no problem. -[[Quartz-Configuringquartz.propertiesfile]] -Configuring quartz.properties file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Configuring quartz.properties file By default Quartz will look for a `quartz.properties` file in the `org/quartz` directory of the classpath. If you are using WAR @@ -145,9 +139,7 @@ To do this you can configure this in Spring XML as follows </bean> ------------------------------------------------------------------------------- -[[Quartz-EnablingQuartzschedulerinJMX]] -Enabling Quartz scheduler in JMX -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Enabling Quartz scheduler in JMX You need to configure the quartz scheduler properties to enable JMX. + That is typically setting the option @@ -157,9 +149,7 @@ configuration file. From Camel 2.13 onwards Camel will automatic set this option to true, unless explicit disabled. -[[Quartz-StartingtheQuartzscheduler]] -Starting the Quartz scheduler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +### Starting the Quartz scheduler This is an example: @@ -170,9 +160,7 @@ This is an example: </bean> ---------------------------------------------------------------------------- -[[Quartz-Clustering]] -Clustering -^^^^^^^^^^ +### Clustering *Available as of Camel 2.4* @@ -184,9 +172,7 @@ allows the trigger to keep running on the other nodes in the cluster. *Note*: When running in clustered node no checking is done to ensure unique job name/group for endpoints. -[[Quartz-MessageHeaders]] -Message Headers -^^^^^^^^^^^^^^^ +### Message Headers Camel adds the getters from the Quartz Execution Context as header values. The following headers are added: + @@ -198,9 +184,7 @@ values. The following headers are added: + The `fireTime` header contains the `java.util.Date` of when the exchange was fired. -[[Quartz-UsingCronTriggers]] -Using Cron Triggers -^^^^^^^^^^^^^^^^^^^ +### Using Cron Triggers Quartz supports http://www.quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/crontrigger[Cron-like @@ -235,9 +219,7 @@ valid URI syntax: |`+` | _Space_ |======================================================================= -[[Quartz-Specifyingtimezone]] -Specifying time zone -^^^^^^^^^^^^^^^^^^^^ +### Specifying time zone *Available as of Camel 2.8.1* + The Quartz Scheduler allows you to configure time zone per trigger. For @@ -256,9 +238,7 @@ Converter] to be able configure this from the endpoint uri. + From Camel 2.8.1 onwards we have included such a link:type-converter.html[Type Converter] in the camel-core. -[[Quartz-SeeAlso]] -See Also -^^^^^^^^ +### See Also * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] @@ -266,5 +246,4 @@ See Also * link:getting-started.html[Getting Started] * link:quartz2.html[Quartz2] -* link:timer.html[Timer] - +* link:timer.html[Timer] \ No newline at end of file
