Repository: camel Updated Branches: refs/heads/master c2614eee5 -> 54de91816
First cut of mvn goal to generate/update component readme.md file. Make the plugin update the existing adoc file to keep the endpoint options up to date. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/54de9181 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/54de9181 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/54de9181 Branch: refs/heads/master Commit: 54de91816d11e8995b31aa04da327b5305894d65 Parents: c2614ee Author: Claus Ibsen <davscl...@apache.org> Authored: Wed Jan 27 10:55:09 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Wed Jan 27 10:55:09 2016 +0100 ---------------------------------------------------------------------- components/camel-ahc/src/main/docs/ahc.adoc | 27 ++++++++++---------- .../src/main/resources/endpoint-options.mvel | 4 +-- 2 files changed, 16 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/54de9181/components/camel-ahc/src/main/docs/ahc.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ahc/src/main/docs/ahc.adoc b/components/camel-ahc/src/main/docs/ahc.adoc index 1ed462a..e39ca87 100644 --- a/components/camel-ahc/src/main/docs/ahc.adoc +++ b/components/camel-ahc/src/main/docs/ahc.adoc @@ -48,24 +48,25 @@ The AHC component supports 12 endpoint options which are listed below: [width="100%",cols="10%,5%,5%,10%,5%,65%",options="header",] |======================================================================= -| Name | Group | Required | Default | Java Type | Description | -| `httpUri` | `producer` | `true` | `` | `URI` | The URI to use such as http://hostname:port/path | -| `binding` | `producer` | `` | `` | `AhcBinding` | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | -| `bridgeEndpoint` | `producer` | `` | `false` | `boolean` | If the option is true then the Exchange.HTTP_URI header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. | -| `bufferSize` | `producer` | `` | `4096` | `int` | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | -| `headerFilterStrategy` | `producer` | `` | `` | `HeaderFilterStrategy` | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | -| `throwExceptionOnFailure` | `producer` | `` | `true` | `boolean` | Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | -| `transferException` | `producer` | `` | `false` | `boolean` | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | -| `clientConfig` | `advanced` | `` | `` | `AsyncHttpClientConfig` | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | -| `clientConfigOptions` | `advanced` | `` | `` | `Object>` | To configure the AsyncHttpClientConfig using the key/values from the Map. | -| `exchangePattern` | `advanced` | `` | `InOnly` | `ExchangePattern` | Sets the default exchange pattern when creating an exchange | -| `synchronous` | `advanced` | `` | `false` | `boolean` | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | -| `sslContextParameters` | `security` | `` | `` | `SSLContextParameters` | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. | +| Name | Group | Required | Default | Java Type | Description +| `httpUri` | `producer` | `true` | `` | `URI` | The URI to use such as http://hostname:port/path +| `binding` | `producer` | `` | `` | `AhcBinding` | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. +| `bridgeEndpoint` | `producer` | `` | `false` | `boolean` | If the option is true then the Exchange.HTTP_URI header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back. +| `bufferSize` | `producer` | `` | `4096` | `int` | The initial in-memory buffer size used when transferring data between Camel and AHC Client. +| `headerFilterStrategy` | `producer` | `` | `` | `HeaderFilterStrategy` | To use a custom HeaderFilterStrategy to filter header to and from Camel message. +| `throwExceptionOnFailure` | `producer` | `` | `true` | `boolean` | Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. +| `transferException` | `producer` | `` | `false` | `boolean` | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. +| `clientConfig` | `advanced` | `` | `` | `AsyncHttpClientConfig` | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. +| `clientConfigOptions` | `advanced` | `` | `` | `Object>` | To configure the AsyncHttpClientConfig using the key/values from the Map. +| `exchangePattern` | `advanced` | `` | `InOnly` | `ExchangePattern` | Sets the default exchange pattern when creating an exchange +| `synchronous` | `advanced` | `` | `false` | `boolean` | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| `sslContextParameters` | `security` | `` | `` | `SSLContextParameters` | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. |=======================================================================//// endpoint options: END + [[AHC-AhcComponentOptions]] AhcComponent Options ^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/54de9181/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 4cc4b9b..fb28773 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -2,6 +2,6 @@ The @{title} component supports @{endpointOptions.size()} endpoint options which [width="100%",cols="10%,5%,5%,10%,5%,65%",options="header",] |======================================================================= -| Name | Group | Required | Default | Java Type | Description | -@foreach{row : endpointOptions}| `@{row.name}` | `@{row.group}` | `@{row.required}` | `@{row.defaultValue}` | `@{row.shortJavaType}` | @{row.description} | +| Name | Group | Required | Default | Java Type | Description +@foreach{row : endpointOptions}| `@{row.name}` | `@{row.group}` | `@{row.required}` | `@{row.defaultValue}` | `@{row.shortJavaType}` | @{row.description} @end{}|=======================================================================
