You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2021/01/28 05:25:56 UTC

[camel] branch master updated: Regen for commit eac293ae4e8f5472f4aea0d29994d6e65aa2fde0

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 f47aee3  Regen for commit eac293ae4e8f5472f4aea0d29994d6e65aa2fde0
f47aee3 is described below

commit f47aee3ae5ddec4b2498c0b937ce8b5247a77fc4
Author: WillemJiang <Wi...@users.noreply.github.com>
AuthorDate: Thu Jan 28 01:13:21 2021 +0000

    Regen for commit eac293ae4e8f5472f4aea0d29994d6e65aa2fde0
    
    Signed-off-by: GitHub <no...@github.com>
---
 .../org/apache/camel/catalog/docs.properties       |   1 +
 .../camel/catalog/docs/hwcloud-component.adoc      | 148 ++++++++++++++++++++
 .../org/apache/camel/catalog/others.properties     |   1 -
 .../camel/catalog/others/flight-recorder.json      |  15 ---
 docs/components/modules/ROOT/nav.adoc              |   1 +
 .../modules/ROOT/pages/hwcloud-component.adoc      | 150 +++++++++++++++++++++
 6 files changed, 300 insertions(+), 16 deletions(-)

diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
index 1c7cf4c..f47f7e4 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties
@@ -226,6 +226,7 @@ headersmap
 hl7-dataformat
 hl7terser-language
 http-component
+hwcloud-component
 hystrix
 hystrix-eip
 hystrixConfiguration-eip
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-component.adoc
new file mode 100644
index 0000000..7a4c19a
--- /dev/null
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/hwcloud-component.adoc
@@ -0,0 +1,148 @@
+[[hwcloud-smn-component]]
+= Huawei Cloud Smn Component
+:docTitle: Huawei Cloud SMN (Simple notification services)
+:artifactId: camel-huaweicloud-smn
+:description: Send message to simple notification services
+:since: 3.8.0
+:supportLevel: Stable
+:component-header: Only producer is supported
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/hwcloud-smn.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+Huawei Cloud SMN component allowes you to integrate with Simple notification services[https://www.huaweicloud.com/en-us/product/smn.html] 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-smn</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+== URI format
+
+To send a notification.
+
+[source,java]
+------------------------
+hwcloud-smn:service[?options]
+------------------------
+
+
+== Options
+
+// component options: START
+The SMN component supports 4 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *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 SMN endpoint is configured using URI syntax:
+
+----
+hwcloud-smn:service
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *service* | *Required* name of the available services in SMN |  | String
+|===
+
+
+=== Query Parameters (28 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *operation* (producer) | *Required* The actual operation to invoke under the mentioned service |  | String
+| *serviceKeys* (advanced) | Configuration object of class org.apache.camel.component.huaweicloud.smn.models.ServiceKeys containing connectivity parameters like AK, SK, ProjectID and region | null | ServiceKeys
+| *authKey* | *Required* Authentication Key (AK) can be generated from your cloud account user settings | null | String
+| *secretKey* | *Required* Secret Key (AK) can be generated from your cloud account user settings |  | String
+| *projectId* | *Required* Project ID for your specific region. Refer your cloud account settings |  | String
+| *proxyHost* | *Optional* IP/Hostname of the proxy server to access the public cloud from your deployment landscape |  | String
+| *proxyPort* | *Optional* Port number of the proxy service on proxy host |  | String
+| *proxyUser* | *Optional* Proxy user id (if applicable) |  | String
+| *proxyPassword* | *Optional* Proxy user password (if applicable)  |  | String
+| *region*| *Required* Region where your SMN service is hosted |  | String
+| *messageTtl* | *Optional* Time-to-live parameter for each message published to the topic. The subcriptions which are added to the topic within this timeout value will receive the notification | 3600 | String
+| *ignoreSslVerification* | *Optional* whether to ignore SSL verification while connecting to huawei cloud services. It's not recommended in production environment  | false | Boolean
+|===
+// endpoint options: END
+
+== Usage
+
+=== Message properties evaluated by the SMN producer
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Header |Type |Description
+
+|`CamelHwCloudSmnSubject` |`String` |Subject tag for the outgoing notification
+
+|`CamelHwCloudSmnTopic` |`String` |Smn topic into which the message is to be posted
+
+|`CamelHwCloudSmnMessageTtl` |`Integer` | Validity of the posted notification message
+
+|`CamelHwCloudSmnTemplateTags` |`Map<String, String>` | Contains K,V pairs of tags and values when using operation `publishAsTemplatedMessage`
+
+|`CamelHwCloudSmnTemplateName` |`String` |Name of the template to use while using operation `publishAsTemplatedMessage`
+
+
+|=======================================================================
+
+=== Message properties set by the SMN producer
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Header |Type |Description
+
+|`CamelHwCloudSmnMesssageId` |`String` | Unique message id returned by simple message notification server after processing the request
+
+|`CamelHwCloudSmnRequestId` |`String` | Unique request id returned by simple message notification server after processing the request
+
+|=======================================================================
+
+== Supported smn services
+
+- publishMessageService
+
+
+== Supported smn operations
+
+- publishAsTextMessage
+- publishAsTemplatedMessage
+
+
+[source,java]
+--------------------------------------------------------------------------------
+from("direct:triggerRoute")
+.setProperty("CamelHwCloudSmnSubject", constant("This is my subjectline"))
+.setProperty("CamelHwCloudSmnTopic", constant("reji-test"))
+.setProperty("CamelHwCloudSmnMessageTtl", constant(60))
+.setProperty("CamelHwCloudSmnTemplateTags", constant(tags))
+.setProperty("CamelHwCloudSmnTemplateName", constant("hello-template"))
+.to("hwcloud-smn:publishMessageService?operation=publishAsTextMessage&authKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4")
+--------------------------------------------------------------------------------
\ No newline at end of file
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
index 4879b22..4a38753 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
@@ -6,7 +6,6 @@ csimple-joor
 cxf-transport
 elytron
 etcd3
-flight-recorder
 headersmap
 hystrix
 jasypt
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/flight-recorder.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/flight-recorder.json
deleted file mode 100644
index 8552d44..0000000
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/flight-recorder.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
-  "other": {
-    "kind": "other",
-    "name": "flight-recorder",
-    "title": "Java Flight Recorder",
-    "description": "Diagnose Camel with Java Flight Recorder",
-    "deprecated": false,
-    "firstVersion": "3.8.0",
-    "label": "monitoring",
-    "supportLevel": "Preview",
-    "groupId": "org.apache.camel",
-    "artifactId": "camel-flight-recorder",
-    "version": "3.8.0-SNAPSHOT"
-  }
-}
diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc
index c06ee59..d83071e 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -167,6 +167,7 @@
 ** xref:hbase-component.adoc[HBase]
 ** xref:hdfs-component.adoc[HDFS]
 ** xref:http-component.adoc[HTTP]
+** xref:hwcloud-component.adoc[Huawei Cloud SMN (Simple notification services)]
 ** xref:iec60870-client-component.adoc[IEC 60870 Client]
 ** xref:iec60870-server-component.adoc[IEC 60870 Server]
 ** xref:ignite-summary.adoc[Ignite]
diff --git a/docs/components/modules/ROOT/pages/hwcloud-component.adoc b/docs/components/modules/ROOT/pages/hwcloud-component.adoc
new file mode 100644
index 0000000..677cfcd
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/hwcloud-component.adoc
@@ -0,0 +1,150 @@
+[[hwcloud-smn-component]]
+= Huawei Cloud Smn Component
+//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
+:page-source: components/camel-huaweicloud-smn/src/main/docs/hwcloud-component.adoc
+:docTitle: Huawei Cloud SMN (Simple notification services)
+:artifactId: camel-huaweicloud-smn
+:description: Send message to simple notification services
+:since: 3.8.0
+:supportLevel: Stable
+:component-header: Only producer is supported
+include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/hwcloud-smn.adoc[opts=optional]
+
+*Since Camel {since}*
+
+*{component-header}*
+
+Huawei Cloud SMN component allowes you to integrate with Simple notification services[https://www.huaweicloud.com/en-us/product/smn.html] 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-smn</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+== URI format
+
+To send a notification.
+
+[source,java]
+------------------------
+hwcloud-smn:service[?options]
+------------------------
+
+
+== Options
+
+// component options: START
+The SMN component supports 4 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *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 SMN endpoint is configured using URI syntax:
+
+----
+hwcloud-smn:service
+----
+
+with the following path and query parameters:
+
+=== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *service* | *Required* name of the available services in SMN |  | String
+|===
+
+
+=== Query Parameters (28 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *operation* (producer) | *Required* The actual operation to invoke under the mentioned service |  | String
+| *serviceKeys* (advanced) | Configuration object of class org.apache.camel.component.huaweicloud.smn.models.ServiceKeys containing connectivity parameters like AK, SK, ProjectID and region | null | ServiceKeys
+| *authKey* | *Required* Authentication Key (AK) can be generated from your cloud account user settings | null | String
+| *secretKey* | *Required* Secret Key (AK) can be generated from your cloud account user settings |  | String
+| *projectId* | *Required* Project ID for your specific region. Refer your cloud account settings |  | String
+| *proxyHost* | *Optional* IP/Hostname of the proxy server to access the public cloud from your deployment landscape |  | String
+| *proxyPort* | *Optional* Port number of the proxy service on proxy host |  | String
+| *proxyUser* | *Optional* Proxy user id (if applicable) |  | String
+| *proxyPassword* | *Optional* Proxy user password (if applicable)  |  | String
+| *region*| *Required* Region where your SMN service is hosted |  | String
+| *messageTtl* | *Optional* Time-to-live parameter for each message published to the topic. The subcriptions which are added to the topic within this timeout value will receive the notification | 3600 | String
+| *ignoreSslVerification* | *Optional* whether to ignore SSL verification while connecting to huawei cloud services. It's not recommended in production environment  | false | Boolean
+|===
+// endpoint options: END
+
+== Usage
+
+=== Message properties evaluated by the SMN producer
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Header |Type |Description
+
+|`CamelHwCloudSmnSubject` |`String` |Subject tag for the outgoing notification
+
+|`CamelHwCloudSmnTopic` |`String` |Smn topic into which the message is to be posted
+
+|`CamelHwCloudSmnMessageTtl` |`Integer` | Validity of the posted notification message
+
+|`CamelHwCloudSmnTemplateTags` |`Map<String, String>` | Contains K,V pairs of tags and values when using operation `publishAsTemplatedMessage`
+
+|`CamelHwCloudSmnTemplateName` |`String` |Name of the template to use while using operation `publishAsTemplatedMessage`
+
+
+|=======================================================================
+
+=== Message properties set by the SMN producer
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Header |Type |Description
+
+|`CamelHwCloudSmnMesssageId` |`String` | Unique message id returned by simple message notification server after processing the request
+
+|`CamelHwCloudSmnRequestId` |`String` | Unique request id returned by simple message notification server after processing the request
+
+|=======================================================================
+
+== Supported smn services
+
+- publishMessageService
+
+
+== Supported smn operations
+
+- publishAsTextMessage
+- publishAsTemplatedMessage
+
+
+[source,java]
+--------------------------------------------------------------------------------
+from("direct:triggerRoute")
+.setProperty("CamelHwCloudSmnSubject", constant("This is my subjectline"))
+.setProperty("CamelHwCloudSmnTopic", constant("reji-test"))
+.setProperty("CamelHwCloudSmnMessageTtl", constant(60))
+.setProperty("CamelHwCloudSmnTemplateTags", constant(tags))
+.setProperty("CamelHwCloudSmnTemplateName", constant("hello-template"))
+.to("hwcloud-smn:publishMessageService?operation=publishAsTextMessage&authKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4")
+--------------------------------------------------------------------------------
\ No newline at end of file