Repository: camel Updated Branches: refs/heads/master 2c11b4e4f -> 456928d97
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/456928d9 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/456928d9 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/456928d9 Branch: refs/heads/master Commit: 456928d97e4bcd36aec3bf6e4e3949baf07e0b14 Parents: 2c11b4e Author: Claus Ibsen <davscl...@apache.org> Authored: Wed Jan 27 11:32:32 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Wed Jan 27 11:32:32 2016 +0100 ---------------------------------------------------------------------- components/camel-ahc/src/main/docs/ahc.adoc | 30 +++++++++++--------- .../maven/packaging/ReadmeComponentMojo.java | 7 +++++ .../src/main/resources/endpoint-options.mvel | 6 ++-- 3 files changed, 26 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/456928d9/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 07a2b4e..5cc500f 100644 --- a/components/camel-ahc/src/main/docs/ahc.adoc +++ b/components/camel-ahc/src/main/docs/ahc.adoc @@ -46,24 +46,25 @@ AhcEndpoint Options + // endpoint options: START The AHC component supports 12 endpoint options which are listed below: -[width="100%",cols="2s,1,1,1m,1m,4",options="header",] +[width="100%",cols="2s,1,1m,1m,5",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 | | | Map | 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 | Default | Java Type | Description +| httpUri | producer | | URI | *Required* 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 | | Map | 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 @@ -71,6 +72,7 @@ The AHC component supports 12 endpoint options which are listed below: + [[AHC-AhcComponentOptions]] AhcComponent Options ^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/456928d9/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java index f4eca6a..1276cf4 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ReadmeComponentMojo.java @@ -213,6 +213,13 @@ public class ReadmeComponentMojo extends AbstractMojo { option.setDeprecated(getSafeValue("deprecated", row)); option.setDefaultValue(getSafeValue("defaultValue", row)); option.setDescription(getSafeValue("description", row)); + + // lets put required in the description + if ("true".equals(option.getRequired())) { + String desc = "*Required* " + option.getDescription(); + option.setDescription(desc); + } + endpointOptions.add(option); } component.setEndpointOptions(endpointOptions); http://git-wip-us.apache.org/repos/asf/camel/blob/456928d9/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 59fb1e3..0454f69 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 @@ -1,7 +1,7 @@ The @{title} component supports @{endpointOptions.size()} endpoint options which are listed below: -[width="100%",cols="2s,1,1,1m,1m,4",options="header",] +[width="100%",cols="2s,1,1m,1m,5",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 | Default | Java Type | Description +@foreach{row : endpointOptions}| @{row.name} | @{row.group} | @{row.defaultValue} | @{row.shortJavaType} | @{row.description} @end{}|=======================================================================
