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
commit 5dafbc9dee7380ed862cc5251ebb38d75ae87913 Author: Andrea Cosentino <[email protected]> AuthorDate: Fri Jan 31 16:37:49 2020 +0100 CAMEL-14463 - Create an AWS-MQ component based on SDK v2, docs --- ...ws-mq-component.adoc => aws2-mq-component.adoc} | 67 +++++----------------- 1 file changed, 13 insertions(+), 54 deletions(-) diff --git a/components/camel-aws2-mq/src/main/docs/aws-mq-component.adoc b/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc similarity index 62% rename from components/camel-aws2-mq/src/main/docs/aws-mq-component.adoc rename to components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc index ee7eb8c..961fd20 100644 --- a/components/camel-aws2-mq/src/main/docs/aws-mq-component.adoc +++ b/components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc @@ -1,7 +1,4 @@ -[[aws-mq-component]] -= AWS MQ Component - -*Since Camel 2.21* += AWS 2 MQ Component // HEADER START *Only producer is supported* @@ -20,7 +17,7 @@ https://aws.amazon.com/amazon-mq/[Amazon MQ]. [source,java] ------------------------- -aws-mq://label[?options] +aws2-mq://label[?options] ------------------------- You can append query options to the URI in the following format, @@ -30,14 +27,14 @@ You can append query options to the URI in the following format, // component options: START -The AWS MQ component supports 6 options, which are listed below. +The AWS 2 MQ component supports 6 options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *configuration* (advanced) | The AWS MQ default configuration | | MQConfiguration +| *configuration* (advanced) | The AWS MQ default configuration | | MQ2Configuration | *accessKey* (producer) | Amazon AWS Access Key | | String | *secretKey* (producer) | Amazon AWS Secret Key | | String | *region* (producer) | The region in which MQ client needs to work | | String @@ -50,10 +47,10 @@ The AWS MQ component supports 6 options, which are listed below. // endpoint options: START -The AWS MQ endpoint is configured using URI syntax: +The AWS 2 MQ endpoint is configured using URI syntax: ---- -aws-mq:label +aws2-mq:label ---- with the following path and query parameters: @@ -75,9 +72,9 @@ with the following path and query parameters: |=== | Name | Description | Default | Type | *accessKey* (producer) | Amazon AWS Access Key | | String -| *amazonMqClient* (producer) | To use a existing configured AmazonMQClient as client | | AmazonMQ +| *amazonMqClient* (producer) | To use a existing configured AmazonMQClient as client | | MqClient | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *operation* (producer) | *Required* The operation to perform. It can be listBrokers,createBroker,deleteBroker | | MQOperations +| *operation* (producer) | *Required* The operation to perform. It can be listBrokers,createBroker,deleteBroker | | MQ2Operations | *proxyHost* (producer) | To define a proxy host when instantiating the MQ client | | String | *proxyPort* (producer) | To define a proxy port when instantiating the MQ client | | Integer | *proxyProtocol* (producer) | To define a proxy protocol when instantiating the MQ client | HTTPS | Protocol @@ -87,45 +84,8 @@ with the following path and query parameters: | *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 -// spring-boot-auto-configure options: START -== Spring Boot Auto-Configuration - -When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration: - -[source,xml] ----- -<dependency> - <groupId>org.apache.camel.springboot</groupId> - <artifactId>camel-aws-mq-starter</artifactId> - <version>x.x.x</version> - <!-- use the same version as your Camel core version --> -</dependency> ----- - -The component supports 15 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *camel.component.aws-mq.access-key* | Amazon AWS Access Key | | String -| *camel.component.aws-mq.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean -| *camel.component.aws-mq.bridge-error-handler* | 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 -| *camel.component.aws-mq.configuration.access-key* | Amazon AWS Access Key | | String -| *camel.component.aws-mq.configuration.amazon-mq-client* | To use a existing configured AmazonMQClient as client | | AmazonMQ -| *camel.component.aws-mq.configuration.operation* | The operation to perform. It can be listBrokers,createBroker,deleteBroker | | MQOperations -| *camel.component.aws-mq.configuration.proxy-host* | To define a proxy host when instantiating the MQ client | | String -| *camel.component.aws-mq.configuration.proxy-port* | To define a proxy port when instantiating the MQ client | | Integer -| *camel.component.aws-mq.configuration.proxy-protocol* | To define a proxy protocol when instantiating the MQ client | | Protocol -| *camel.component.aws-mq.configuration.region* | The region in which MQ client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *camel.component.aws-mq.configuration.secret-key* | Amazon AWS Secret Key | | String -| *camel.component.aws-mq.enabled* | Whether to enable auto configuration of the aws-mq component. This is enabled by default. | | Boolean -| *camel.component.aws-mq.lazy-start-producer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed the [...] -| *camel.component.aws-mq.region* | The region in which MQ client needs to work | | String -| *camel.component.aws-mq.secret-key* | Amazon AWS Secret Key | | String -|=== +// spring-boot-auto-configure options: START // spring-boot-auto-configure options: END @@ -184,12 +144,12 @@ Camel-AWS MQ component provides the following operation on the producer side: [source,java] -------------------------------------------------------------------------------- from("direct:listBrokers") - .to("aws-mq://test?amazonMqClient=#amazonMqClient&operation=listBrokers") + .to("aws2-mq://test?amazonMqClient=#amazonMqClient&operation=listBrokers") -------------------------------------------------------------------------------- -== Automatic detection of AmazonMQ client in registry +== Automatic detection of MqClient client in registry -The component is capable of detecting the presence of an AmazonMQ bean into the registry. +The component is capable of detecting the presence of an MqClient bean into the registry. If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. This may be really useful for smarter configuration of the endpoint. @@ -203,10 +163,9 @@ Maven users will need to add the following dependency to their pom.xml. --------------------------------------- <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-mq</artifactId> + <artifactId>camel-aws2-mq</artifactId> <version>${camel-version}</version> </dependency> --------------------------------------- where `$\{camel-version\}` must be replaced by the actual version of Camel. -
