This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 30315a9b102a919a28b57b2c5708402e3da18145 Author: Claus Ibsen <[email protected]> AuthorDate: Thu Jul 1 06:40:37 2021 +0200 Regen --- .../camel/catalog/docs/hwcloud-obs-component.adoc | 146 +++++++++++++++++++++ .../org/apache/camel/component/hwcloud-obs | 1 - 2 files changed, 146 insertions(+), 1 deletion(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-obs-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-obs-component.adoc new file mode 100644 index 0000000..2c3fe8a --- /dev/null +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-obs-component.adoc @@ -0,0 +1,146 @@ +[[hwcloud-obs-component]] += Huawei Object Storage Service (OBS) Component +:docTitle: Huawei Object Storage Service (OBS) +:artifactId: camel-huaweicloud-obs +:description: To provide stable, secure, efficient, and easy-to-use cloud storage service on Huawei Cloud +:since: 3.12 +:supportLevel: Preview +:component-header: Both producer and consumer are supported +include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/hwcloud-obs.adoc[opts=optional] +//Manually maintained attributes +:group: Huawei Cloud + +*Since Camel {since}* + +*{component-header}* + +Huawei Cloud Object Storage Service (OBS) component allows you to integrate with https://www.huaweicloud.com/intl/en-us/product/obs.html[OBS] provided by Huawei Cloud. + +Maven users will need to add the following dependency to their `pom.xml` for this component: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-huaweicloud-obs</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + +== URI Format + +[source,text] +---- +hwcloud-obs:operation[?options] +---- + +== URI Options + +// component options: START +The Huawei Object Storage Service (OBS) component supports 3 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *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 +| *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 [...] +| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean +|=== +// component options: END + +// endpoint options: START +The Huawei Object Storage Service (OBS) endpoint is configured using URI syntax: + +---- +hwcloud-obs:operation +---- + +with the following path and query parameters: + +=== Path Parameters (1 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *operation* | *Required* Operation to be performed | | String +|=== + + +=== Query Parameters (16 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *authenticationKey* (common) | *Required* Authentication key for the cloud user | | String +| *bucketLocation* (common) | Location of bucket when creating a new bucket | | String +| *bucketName* (common) | Name of bucket to perform operation on | | String +| *endpoint* (common) | OBS url. Carries higher precedence than region parameter based client initialization | | String +| *ignoreSslVerification* (common) | Ignore SSL verification | false | boolean +| *proxyHost* (common) | Proxy server ip/hostname | | String +| *proxyPassword* (common) | Proxy authentication password | | String +| *proxyPort* (common) | Proxy server port | | int +| *proxyUser* (common) | Proxy authentication user | | String +| *region* (common) | *Required* OBS service region. This is lower precedence than endpoint based configuration | | String +| *secretKey* (common) | *Required* Secret key for the cloud user | | String +| *serviceKeys* (common) | Configuration object for cloud service authentication | | ServiceKeys +| *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 option 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. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern +| *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 [...] +|=== +// endpoint options: END + + +== Usage + +=== Message properties evaluated by the OBS producer + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelHwCloudObsOperation` |`String` | Name of operation to invoke + +|`CamelHwCloudObsBucketName` |`String` | Bucket name to invoke operation on + +|`CamelHwCloudObsBucketLocation` |`String` | Bucket location when creating a new bucket + +|======================================================================= + +If any of the above properties are set, they will override their corresponding query parameter. + +== List of Supported OBS Operations + +- listBuckets +- createBucket - `bucketName` parameter is *required*, `bucketLocation` parameter is optional +- deleteBucket - `bucketName` parameter is *required* + + +== Using ServiceKey Configuration Bean + +Authentication key and secret keys are required to authenticate against the OBS cloud. You can avoid having them being exposed +and scattered over in your endpoint uri by wrapping them inside a bean of class `org.apache.camel.component.huaweicloud.obs.models.ServiceKeys`. +Add it to the registry and let Camel look it up by referring the object via endpoint query parameter `serviceKeys`. + +Check the following code snippets: + +[source,xml] +---- +<bean id="myServiceKeyConfig" class="org.apache.camel.component.huaweicloud.obs.models.ServiceKeys"> + <property name="authenticationKey" value="your_authentication_key" /> + <property name="secretKey" value="your_secret_key" /> +</bean> +---- +[source,java] +---- +from("direct:triggerRoute") + .setProperty(OBSPropeties.OPERATION, constant("createBucket")) + .setProperty(OBSPropeties.BUCKET_NAME ,constant("your_bucket_name")) + .setProperty(OBSPropeties.BUCKET_LOCATION, constant("your_bucket_location)) + .to("hwcloud-obs:createBucket?region=cn-north-4&serviceKeys=#myServiceKeyConfig") +---- diff --git a/components/camel-huawei/camel-huaweicloud-obs/src/main/resources/META-INF/services/org/apache/camel/component/hwcloud-obs b/components/camel-huawei/camel-huaweicloud-obs/src/main/resources/META-INF/services/org/apache/camel/component/hwcloud-obs deleted file mode 100644 index f9c0f1a..0000000 --- a/components/camel-huawei/camel-huaweicloud-obs/src/main/resources/META-INF/services/org/apache/camel/component/hwcloud-obs +++ /dev/null @@ -1 +0,0 @@ -class=org.apache.camel.component.huaweicloud.obs.OBSComponent
