This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push: new b318ed0 Added first skeleton of AS2 component docs b318ed0 is described below commit b318ed09897de505dc311f415ed2270167c39143 Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Thu May 3 08:38:08 2018 +0200 Added first skeleton of AS2 component docs --- .../src/main/docs/as2-component.adoc | 64 ++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc new file mode 100644 index 0000000..a391ca2 --- /dev/null +++ b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc @@ -0,0 +1,64 @@ +[[as2-component]] +== AS2 Component + +*Available as of Camel version * + +[source,xml] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-as2</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +### URI Options + + +// component options: START +The AS2 component supports 2 options which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *configuration* (common) | To use the shared configuration | | AS2Configuration +| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean +|=== +// component options: END + + +// endpoint options: START +The AS2 endpoint is configured using URI syntax: + +---- +as2:name +---- + +with the following path and query parameters: + +==== Path Parameters (1 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *name* | *Required* Some description of this option, and what it does | | String +|=== + + +==== Query Parameters (5 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean +| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean +|=== +// endpoint options: END -- To stop receiving notification emails like this one, please contact acosent...@apache.org.