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
The following commit(s) were added to refs/heads/main by this push:
new a61829d83029 CAMEL-23832: camel-alibaba-sms - improve option
descriptions (#30144)
a61829d83029 is described below
commit a61829d830293cccc7cc4831d02df9101038bd94
Author: Saravanakumar Selvaraj <[email protected]>
AuthorDate: Mon Nov 16 21:56:21 2026 +0000
CAMEL-23832: camel-alibaba-sms - improve option descriptions (#30144)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/components/alibaba-sms.json | 36 +++----
.../camel/component/alibaba/sms/alibaba-sms.json | 36 +++----
.../camel/component/alibaba/sms/SMSEndpoint.java | 72 ++++++++++---
.../alibaba/sms/constants/SMSHeaders.java | 34 ++++--
.../builder/endpoint/StaticEndpointBuilders.java | 10 +-
.../endpoint/dsl/SMSEndpointBuilderFactory.java | 119 +++++++++++++++++----
tasks/component-descriptions.md | 2 +-
7 files changed, 226 insertions(+), 83 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sms.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sms.json
index 0ac24d3be302..d1ad2606e4f6 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sms.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sms.json
@@ -30,30 +30,30 @@
"healthCheckProducerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
"headers": {
- "CamelAlibabaSmsPhoneNumbers": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Phone numbers to send SMS to", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#PHONE_NUMBERS" },
- "CamelAlibabaSmsSignName": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS sign name", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#SIGN_NAME" },
- "CamelAlibabaSmsTemplateCode": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS template code", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#TEMPLATE_CODE" },
- "CamelAlibabaSmsTemplateParam": { "index": 3, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS template parameters as JSON", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#TEMPLATE_PARAM" },
- "CamelAlibabaSmsOutId": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Out id for the SMS", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#OUT_ID" },
- "CamelAlibabaSmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Alibaba Cloud request id", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#REQUEST_ID" }
+ "CamelAlibabaSmsPhoneNumbers": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The phone numbers of the recipients, which are separated by
commas. Short Message Service accepts at most 1000 phone numbers. This header
replaces the phoneNumbers option. If this header is not set, an exchange
property of the same name replaces the [...]
+ "CamelAlibabaSmsSignName": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The sign name of the SMS message. The value must be an approved
sign name. This header replaces the signName option. If this header is not set,
an exchange property of the same name replaces the signName option.",
"constantName": "org.apache.camel.compo [...]
+ "CamelAlibabaSmsTemplateCode": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The template code of the SMS message. The value must be the
code of an approved template. This header replaces the templateCode option. If
this header is not set, an exchange property of the same name replaces the
templateCode option.", "constantNam [...]
+ "CamelAlibabaSmsTemplateParam": { "index": 3, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The template parameters of the SMS message as a JSON string.
The JSON string must provide a value for each variable of the template. This
header replaces the templateParam option. If this header is not set, an
exchange property of the same name rep [...]
+ "CamelAlibabaSmsOutId": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The external transaction ID of the SMS message. This header
replaces the outId option. If this header is not set, an exchange property of
the same name replaces the outId option.", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeader [...]
+ "CamelAlibabaSmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Short Message Service returns in the
response to the operation. The producer sets it, unless the exchange fails.",
"constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#REQUEST_ID" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "description": "Not used: sendSms
takes the phone numbers, sign name, template code and template parameters from
options or headers, such as CamelAlibabaSmsTemplateParam" },
"producerOut": { "carriers": [ "map" ], "description": "A Map of the
response: the statusCode, and the code, message, bizId and requestId the
service returns" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "sendSms" ], "deprecated": false,
"autowired": false, "secret": false, "description": "Operation to perform" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SMS endpoint URL. Carries higher precedence
than region based client initialization" },
- "outId": { "index": 2, "kind": "parameter", "displayName": "Out Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Out id for the SMS" },
- "phoneNumbers": { "index": 3, "kind": "parameter", "displayName": "Phone
Numbers", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Phone numbers to send SMS to" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
- "signName": { "index": 5, "kind": "parameter", "displayName": "Sign Name",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SMS sign name" },
- "templateCode": { "index": 6, "kind": "parameter", "displayName":
"Template Code", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SMS template code" },
- "templateParam": { "index": 7, "kind": "parameter", "displayName":
"Template Param", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SMS template parameters as JSON" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "sendSms" ], "deprecated": false,
"autowired": false, "secret": false, "description": "The operation that the
producer performs. The CamelAlibabaSmsOperation header replaces this option for
a request that the producer sends. If that header is not set, an exchange
property of the same name replaces [...]
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Short Message Service, which
is a host name without http:\/\/ or https:\/\/. The producer sends requests to
it over HTTPS. If not set, the region option determines the endpoint, and one
of the two is required. Not used wh [...]
+ "outId": { "index": 2, "kind": "parameter", "displayName": "Out Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The external transaction ID of the SMS
message. The CamelAlibabaSmsOutId header replaces this option for a request
that the producer sends. If that header is not set, an exchange property of the
same name replaces this option. If none of the [...]
+ "phoneNumbers": { "index": 3, "kind": "parameter", "displayName": "Phone
Numbers", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The phone numbers of the recipients,
which are separated by commas. Short Message Service accepts at most 1000 phone
numbers. The CamelAlibabaSmsPhoneNumbers header replaces this option for a
request that the producer sends. If [...]
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Short Message Service, for
example cn-hangzhou. Only used when the endpoint option is not set, to
determine the endpoint of Short Message Service. Not used when the smsClient
option is set or autowired." },
+ "signName": { "index": 5, "kind": "parameter", "displayName": "Sign Name",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The sign name of the SMS message. The value
must be an approved sign name. The CamelAlibabaSmsSignName header replaces this
option for a request that the producer sends. If that header is not set, an
exchange property of the same name r [...]
+ "templateCode": { "index": 6, "kind": "parameter", "displayName":
"Template Code", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The template code of the SMS message.
The value must be the code of an approved template. The
CamelAlibabaSmsTemplateCode header replaces this option for a request that the
producer sends. If that header is not set, an exchange [...]
+ "templateParam": { "index": 7, "kind": "parameter", "displayName":
"Template Param", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The template parameters of the SMS
message as a JSON string. The JSON string must provide a value for each
variable of the template. The CamelAlibabaSmsTemplateParam header replaces this
option for a request that the producer [...]
"lazyStartProducer": { "index": 8, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "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 produc [...]
- "smsClient": { "index": 9, "kind": "parameter", "displayName": "SMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.dysmsapi20170525.Client", "deprecated":
false, "autowired": true, "secret": false, "description": "Autowire an existing
SMS client instance" },
- "accessKey": { "index": 10, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Access key for the
cloud user" },
- "secretKey": { "index": 11, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Secret key for the
cloud user" },
- "serviceKeys": { "index": 12, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"Configuration object for cloud service authentication" }
+ "smsClient": { "index": 9, "kind": "parameter", "displayName": "SMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.dysmsapi20170525.Client", "deprecated":
false, "autowired": true, "secret": false, "description": "To use a custom
com.aliyun.dysmsapi20170525.Client. The producer sends its requests with this
client, and the region, endpoint, accessKey, secretKey and serviceKeys options
are not used. If no client is set or [...]
+ "accessKey": { "index": 10, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey ID
of the AccessKey pair for the requests that the producer sends to Short Message
Service. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not u [...]
+ "secretKey": { "index": 11, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey
secret of the AccessKey pair for the requests that the producer sends to Short
Message Service. If not set, the secretKey of the serviceKeys option is used,
and one of the two is required. N [...]
+ "serviceKeys": { "index": 12, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its accessKey is
the AccessKey ID and its secretKey is the AccessKey [...]
}
}
diff --git
a/components/camel-alibaba/camel-alibaba-sms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sms/alibaba-sms.json
b/components/camel-alibaba/camel-alibaba-sms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sms/alibaba-sms.json
index 0ac24d3be302..d1ad2606e4f6 100644
---
a/components/camel-alibaba/camel-alibaba-sms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sms/alibaba-sms.json
+++
b/components/camel-alibaba/camel-alibaba-sms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sms/alibaba-sms.json
@@ -30,30 +30,30 @@
"healthCheckProducerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
"headers": {
- "CamelAlibabaSmsPhoneNumbers": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Phone numbers to send SMS to", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#PHONE_NUMBERS" },
- "CamelAlibabaSmsSignName": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS sign name", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#SIGN_NAME" },
- "CamelAlibabaSmsTemplateCode": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS template code", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#TEMPLATE_CODE" },
- "CamelAlibabaSmsTemplateParam": { "index": 3, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SMS template parameters as JSON", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#TEMPLATE_PARAM" },
- "CamelAlibabaSmsOutId": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Out id for the SMS", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#OUT_ID" },
- "CamelAlibabaSmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Alibaba Cloud request id", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#REQUEST_ID" }
+ "CamelAlibabaSmsPhoneNumbers": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The phone numbers of the recipients, which are separated by
commas. Short Message Service accepts at most 1000 phone numbers. This header
replaces the phoneNumbers option. If this header is not set, an exchange
property of the same name replaces the [...]
+ "CamelAlibabaSmsSignName": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The sign name of the SMS message. The value must be an approved
sign name. This header replaces the signName option. If this header is not set,
an exchange property of the same name replaces the signName option.",
"constantName": "org.apache.camel.compo [...]
+ "CamelAlibabaSmsTemplateCode": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The template code of the SMS message. The value must be the
code of an approved template. This header replaces the templateCode option. If
this header is not set, an exchange property of the same name replaces the
templateCode option.", "constantNam [...]
+ "CamelAlibabaSmsTemplateParam": { "index": 3, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The template parameters of the SMS message as a JSON string.
The JSON string must provide a value for each variable of the template. This
header replaces the templateParam option. If this header is not set, an
exchange property of the same name rep [...]
+ "CamelAlibabaSmsOutId": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The external transaction ID of the SMS message. This header
replaces the outId option. If this header is not set, an exchange property of
the same name replaces the outId option.", "constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeader [...]
+ "CamelAlibabaSmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Short Message Service returns in the
response to the operation. The producer sets it, unless the exchange fails.",
"constantName":
"org.apache.camel.component.alibaba.sms.constants.SMSHeaders#REQUEST_ID" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "description": "Not used: sendSms
takes the phone numbers, sign name, template code and template parameters from
options or headers, such as CamelAlibabaSmsTemplateParam" },
"producerOut": { "carriers": [ "map" ], "description": "A Map of the
response: the statusCode, and the code, message, bizId and requestId the
service returns" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "sendSms" ], "deprecated": false,
"autowired": false, "secret": false, "description": "Operation to perform" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SMS endpoint URL. Carries higher precedence
than region based client initialization" },
- "outId": { "index": 2, "kind": "parameter", "displayName": "Out Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Out id for the SMS" },
- "phoneNumbers": { "index": 3, "kind": "parameter", "displayName": "Phone
Numbers", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Phone numbers to send SMS to" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
- "signName": { "index": 5, "kind": "parameter", "displayName": "Sign Name",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SMS sign name" },
- "templateCode": { "index": 6, "kind": "parameter", "displayName":
"Template Code", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SMS template code" },
- "templateParam": { "index": 7, "kind": "parameter", "displayName":
"Template Param", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SMS template parameters as JSON" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "sendSms" ], "deprecated": false,
"autowired": false, "secret": false, "description": "The operation that the
producer performs. The CamelAlibabaSmsOperation header replaces this option for
a request that the producer sends. If that header is not set, an exchange
property of the same name replaces [...]
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Short Message Service, which
is a host name without http:\/\/ or https:\/\/. The producer sends requests to
it over HTTPS. If not set, the region option determines the endpoint, and one
of the two is required. Not used wh [...]
+ "outId": { "index": 2, "kind": "parameter", "displayName": "Out Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The external transaction ID of the SMS
message. The CamelAlibabaSmsOutId header replaces this option for a request
that the producer sends. If that header is not set, an exchange property of the
same name replaces this option. If none of the [...]
+ "phoneNumbers": { "index": 3, "kind": "parameter", "displayName": "Phone
Numbers", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The phone numbers of the recipients,
which are separated by commas. Short Message Service accepts at most 1000 phone
numbers. The CamelAlibabaSmsPhoneNumbers header replaces this option for a
request that the producer sends. If [...]
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Short Message Service, for
example cn-hangzhou. Only used when the endpoint option is not set, to
determine the endpoint of Short Message Service. Not used when the smsClient
option is set or autowired." },
+ "signName": { "index": 5, "kind": "parameter", "displayName": "Sign Name",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The sign name of the SMS message. The value
must be an approved sign name. The CamelAlibabaSmsSignName header replaces this
option for a request that the producer sends. If that header is not set, an
exchange property of the same name r [...]
+ "templateCode": { "index": 6, "kind": "parameter", "displayName":
"Template Code", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The template code of the SMS message.
The value must be the code of an approved template. The
CamelAlibabaSmsTemplateCode header replaces this option for a request that the
producer sends. If that header is not set, an exchange [...]
+ "templateParam": { "index": 7, "kind": "parameter", "displayName":
"Template Param", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The template parameters of the SMS
message as a JSON string. The JSON string must provide a value for each
variable of the template. The CamelAlibabaSmsTemplateParam header replaces this
option for a request that the producer [...]
"lazyStartProducer": { "index": 8, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "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 produc [...]
- "smsClient": { "index": 9, "kind": "parameter", "displayName": "SMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.dysmsapi20170525.Client", "deprecated":
false, "autowired": true, "secret": false, "description": "Autowire an existing
SMS client instance" },
- "accessKey": { "index": 10, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Access key for the
cloud user" },
- "secretKey": { "index": 11, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Secret key for the
cloud user" },
- "serviceKeys": { "index": 12, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"Configuration object for cloud service authentication" }
+ "smsClient": { "index": 9, "kind": "parameter", "displayName": "SMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.dysmsapi20170525.Client", "deprecated":
false, "autowired": true, "secret": false, "description": "To use a custom
com.aliyun.dysmsapi20170525.Client. The producer sends its requests with this
client, and the region, endpoint, accessKey, secretKey and serviceKeys options
are not used. If no client is set or [...]
+ "accessKey": { "index": 10, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey ID
of the AccessKey pair for the requests that the producer sends to Short Message
Service. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not u [...]
+ "secretKey": { "index": 11, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey
secret of the AccessKey pair for the requests that the producer sends to Short
Message Service. If not set, the secretKey of the serviceKeys option is used,
and one of the two is required. N [...]
+ "serviceKeys": { "index": 12, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its accessKey is
the AccessKey ID and its secretKey is the AccessKey [...]
}
}
diff --git
a/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/SMSEndpoint.java
b/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/SMSEndpoint.java
index 0f845f6b005b..81b5b15d2079 100644
---
a/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/SMSEndpoint.java
+++
b/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/SMSEndpoint.java
@@ -47,47 +47,87 @@ import org.apache.camel.support.DefaultEndpoint;
+ " requestId the service
returns"))
public class SMSEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "sendSms")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaSmsOperation header replaces this option"
+ + " for a request that the producer sends. If that
header is not set, an exchange property of the"
+ + " same name replaces this option.",
+ displayName = "Operation", label = "producer", enums = "sendSms")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Alibaba Cloud region", displayName = "Region")
+ @UriParam(description = "The region ID of Short Message Service, for
example cn-hangzhou. Only used when the endpoint"
+ + " option is not set, to determine the endpoint
of Short Message Service. Not used when the"
+ + " smsClient option is set or autowired.",
+ displayName = "Region")
@Metadata(required = true)
private String region;
- @UriParam(description = "SMS endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Short Message Service, which is a
host name without http:// or https://. The"
+ + " producer sends requests to it over HTTPS. If
not set, the region option determines the"
+ + " endpoint, and one of the two is required. Not
used when the smsClient option is set or"
+ + " autowired.",
displayName = "Endpoint")
private String endpoint;
- @UriParam(description = "Access key for the cloud user", displayName =
"Access Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for the
requests that the producer sends to Short Message"
+ + " Service. If not set, the accessKey of the
serviceKeys option is used, and one of the two is"
+ + " required. Not used when the smsClient option
is set or autowired.",
+ displayName = "Access Key", security = "secret", label =
"security")
private String accessKey;
- @UriParam(description = "Secret key for the cloud user", displayName =
"Secret Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
the requests that the producer sends to Short"
+ + " Message Service. If not set, the secretKey of
the serviceKeys option is used, and one of the"
+ + " two is required. Not used when the smsClient
option is set or autowired.",
+ displayName = "Secret Key", security = "secret", label =
"security")
private String secretKey;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Keys",
- security = "secret", label = "security")
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its"
+ + " accessKey is the AccessKey ID and its
secretKey is the AccessKey secret. Each of the two is"
+ + " used when the option of the same name is not
set. Not used when the smsClient option is set or"
+ + " autowired.",
+ displayName = "Service Keys", security = "secret", label =
"security")
private ServiceKeys serviceKeys;
- @UriParam(description = "Phone numbers to send SMS to", displayName =
"Phone Numbers")
+ @UriParam(description = "The phone numbers of the recipients, which are
separated by commas. Short Message Service accepts"
+ + " at most 1000 phone numbers. The
CamelAlibabaSmsPhoneNumbers header replaces this option for a"
+ + " request that the producer sends. If that
header is not set, an exchange property of the same"
+ + " name replaces this option. One of the three is
required.",
+ displayName = "Phone Numbers")
private String phoneNumbers;
- @UriParam(description = "SMS sign name", displayName = "Sign Name")
+ @UriParam(description = "The sign name of the SMS message. The value must
be an approved sign name. The"
+ + " CamelAlibabaSmsSignName header replaces this
option for a request that the producer sends. If"
+ + " that header is not set, an exchange property
of the same name replaces this option. One of the"
+ + " three is required.",
+ displayName = "Sign Name")
private String signName;
- @UriParam(description = "SMS template code", displayName = "Template Code")
+ @UriParam(description = "The template code of the SMS message. The value
must be the code of an approved template. The"
+ + " CamelAlibabaSmsTemplateCode header replaces
this option for a request that the producer sends."
+ + " If that header is not set, an exchange
property of the same name replaces this option. One of"
+ + " the three is required.",
+ displayName = "Template Code")
private String templateCode;
- @UriParam(description = "SMS template parameters as JSON", displayName =
"Template Param")
+ @UriParam(description = "The template parameters of the SMS message as a
JSON string. The JSON string must provide a value"
+ + " for each variable of the template. The
CamelAlibabaSmsTemplateParam header replaces this option"
+ + " for a request that the producer sends. If that
header is not set, an exchange property of the"
+ + " same name replaces this option. If none of the
three is set, the producer adds no template"
+ + " parameters to the request.",
+ displayName = "Template Param")
private String templateParam;
- @UriParam(description = "Out id for the SMS", displayName = "Out Id")
+ @UriParam(description = "The external transaction ID of the SMS message.
The CamelAlibabaSmsOutId header replaces this"
+ + " option for a request that the producer sends.
If that header is not set, an exchange property"
+ + " of the same name replaces this option. If none
of the three is set, the producer adds no"
+ + " external transaction ID to the request.",
+ displayName = "Out Id")
private String outId;
- @UriParam(description = "Autowire an existing SMS client instance",
displayName = "SMS Client", label = "advanced")
+ @UriParam(description = "To use a custom
com.aliyun.dysmsapi20170525.Client. The producer sends its requests with this"
+ + " client, and the region, endpoint, accessKey,
secretKey and serviceKeys options are not used. If"
+ + " no client is set or autowired, the Camel
endpoint creates a client from these options. It"
+ + " creates this client when the producer
processes its first message.",
+ displayName = "SMS Client", label = "advanced")
@Metadata(autowired = true)
private Client smsClient;
diff --git
a/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/constants/SMSHeaders.java
b/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/constants/SMSHeaders.java
index f36c48352194..3b338f4d1bc2 100644
---
a/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/constants/SMSHeaders.java
+++
b/components/camel-alibaba/camel-alibaba-sms/src/main/java/org/apache/camel/component/alibaba/sms/constants/SMSHeaders.java
@@ -20,22 +20,44 @@ import org.apache.camel.spi.Metadata;
public final class SMSHeaders {
- @Metadata(label = "producer", description = "Phone numbers to send SMS
to", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The phone numbers of the recipients, which are
separated by commas. Short Message Service accepts"
+ + " at most 1000 phone numbers. This header
replaces the phoneNumbers option. If this header is not"
+ + " set, an exchange property of the same name
replaces the phoneNumbers option.",
+ javaType = "String")
public static final String PHONE_NUMBERS = SMSProperties.PHONE_NUMBERS;
- @Metadata(label = "producer", description = "SMS sign name", javaType =
"String")
+ @Metadata(label = "producer",
+ description = "The sign name of the SMS message. The value must
be an approved sign name. This header replaces"
+ + " the signName option. If this header is not
set, an exchange property of the same name replaces"
+ + " the signName option.",
+ javaType = "String")
public static final String SIGN_NAME = SMSProperties.SIGN_NAME;
- @Metadata(label = "producer", description = "SMS template code", javaType
= "String")
+ @Metadata(label = "producer",
+ description = "The template code of the SMS message. The value
must be the code of an approved template. This"
+ + " header replaces the templateCode option. If
this header is not set, an exchange property of the"
+ + " same name replaces the templateCode option.",
+ javaType = "String")
public static final String TEMPLATE_CODE = SMSProperties.TEMPLATE_CODE;
- @Metadata(label = "producer", description = "SMS template parameters as
JSON", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The template parameters of the SMS message as a
JSON string. The JSON string must provide a value"
+ + " for each variable of the template. This header
replaces the templateParam option. If this"
+ + " header is not set, an exchange property of the
same name replaces the templateParam option.",
+ javaType = "String")
public static final String TEMPLATE_PARAM = SMSProperties.TEMPLATE_PARAM;
- @Metadata(label = "producer", description = "Out id for the SMS", javaType
= "String")
+ @Metadata(label = "producer",
+ description = "The external transaction ID of the SMS message.
This header replaces the outId option. If this"
+ + " header is not set, an exchange property of the
same name replaces the outId option.",
+ javaType = "String")
public static final String OUT_ID = SMSProperties.OUT_ID;
- @Metadata(label = "producer", description = "Alibaba Cloud request id",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The request ID that Short Message Service returns
in the response to the operation. The producer"
+ + " sets it, unless the exchange fails.",
+ javaType = "String")
public static final String REQUEST_ID = SMSProperties.REQUEST_ID;
private SMSHeaders() {
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index f3c54f237b9c..8958caaee384 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -637,7 +637,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-sms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaSmsOperation
+ * header replaces this option for a request that the producer sends. If
+ * that header is not set, an exchange property of the same name replaces
+ * this option.
* There are 1 enums and the value can be one of: sendSms
*
* @param path operation
@@ -657,7 +660,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-sms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaSmsOperation
+ * header replaces this option for a request that the producer sends. If
+ * that header is not set, an exchange property of the same name replaces
+ * this option.
* There are 1 enums and the value can be one of: sendSms
*
* @param componentName to use a custom component name for the endpoint
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SMSEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SMSEndpointBuilderFactory.java
index f92ed3de62c3..297d3f62f8a7 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SMSEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SMSEndpointBuilderFactory.java
@@ -45,8 +45,11 @@ public interface SMSEndpointBuilderFactory {
}
/**
- * SMS endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of Short Message Service, which is a host name without
+ * http:// or https://. The producer sends requests to it over HTTPS.
If
+ * not set, the region option determines the endpoint, and one of the
+ * two is required. Not used when the smsClient option is set or
+ * autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -60,7 +63,11 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Out id for the SMS.
+ * The external transaction ID of the SMS message. The
+ * CamelAlibabaSmsOutId header replaces this option for a request that
+ * the producer sends. If that header is not set, an exchange property
+ * of the same name replaces this option. If none of the three is set,
+ * the producer adds no external transaction ID to the request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -74,7 +81,12 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Phone numbers to send SMS to.
+ * The phone numbers of the recipients, which are separated by commas.
+ * Short Message Service accepts at most 1000 phone numbers. The
+ * CamelAlibabaSmsPhoneNumbers header replaces this option for a
request
+ * that the producer sends. If that header is not set, an exchange
+ * property of the same name replaces this option. One of the three is
+ * required.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -88,7 +100,10 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Alibaba Cloud region.
+ * The region ID of Short Message Service, for example cn-hangzhou.
Only
+ * used when the endpoint option is not set, to determine the endpoint
+ * of Short Message Service. Not used when the smsClient option is set
+ * or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -103,7 +118,11 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * SMS sign name.
+ * The sign name of the SMS message. The value must be an approved sign
+ * name. The CamelAlibabaSmsSignName header replaces this option for a
+ * request that the producer sends. If that header is not set, an
+ * exchange property of the same name replaces this option. One of the
+ * three is required.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -117,7 +136,11 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * SMS template code.
+ * The template code of the SMS message. The value must be the code of
+ * an approved template. The CamelAlibabaSmsTemplateCode header
replaces
+ * this option for a request that the producer sends. If that header is
+ * not set, an exchange property of the same name replaces this option.
+ * One of the three is required.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -131,7 +154,13 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * SMS template parameters as JSON.
+ * The template parameters of the SMS message as a JSON string. The
JSON
+ * string must provide a value for each variable of the template. The
+ * CamelAlibabaSmsTemplateParam header replaces this option for a
+ * request that the producer sends. If that header is not set, an
+ * exchange property of the same name replaces this option. If none of
+ * the three is set, the producer adds no template parameters to the
+ * request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -145,7 +174,10 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for the requests that the
+ * producer sends to Short Message Service. If not set, the accessKey
of
+ * the serviceKeys option is used, and one of the two is required. Not
+ * used when the smsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -159,7 +191,10 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for the requests that the
+ * producer sends to Short Message Service. If not set, the secretKey
of
+ * the serviceKeys option is used, and one of the two is required. Not
+ * used when the smsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -173,7 +208,11 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey is the AccessKey ID and its secretKey is the AccessKey
+ * secret. Each of the two is used when the option of the same name is
+ * not set. Not used when the smsClient option is set or autowired.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -188,7 +227,11 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey is the AccessKey ID and its secretKey is the AccessKey
+ * secret. Each of the two is used when the option of the same name is
+ * not set. Not used when the smsClient option is set or autowired.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -261,7 +304,12 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing SMS client instance.
+ * To use a custom com.aliyun.dysmsapi20170525.Client. The producer
+ * sends its requests with this client, and the region, endpoint,
+ * accessKey, secretKey and serviceKeys options are not used. If no
+ * client is set or autowired, the Camel endpoint creates a client from
+ * these options. It creates this client when the producer processes
its
+ * first message.
*
* The option is a: <code>com.aliyun.dysmsapi20170525.Client</code>
* type.
@@ -276,7 +324,12 @@ public interface SMSEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing SMS client instance.
+ * To use a custom com.aliyun.dysmsapi20170525.Client. The producer
+ * sends its requests with this client, and the region, endpoint,
+ * accessKey, secretKey and serviceKeys options are not used. If no
+ * client is set or autowired, the Camel endpoint creates a client from
+ * these options. It creates this client when the producer processes
its
+ * first message.
*
* The option will be converted to a
* <code>com.aliyun.dysmsapi20170525.Client</code> type.
@@ -317,7 +370,10 @@ public interface SMSEndpointBuilderFactory {
* Syntax: <code>alibaba-sms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaSmsOperation header replaces this option for a request
+ * that the producer sends. If that header is not set, an exchange
+ * property of the same name replaces this option.
* There are 1 enums and the value can be one of: sendSms
*
* @param path operation
@@ -337,7 +393,10 @@ public interface SMSEndpointBuilderFactory {
* Syntax: <code>alibaba-sms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaSmsOperation header replaces this option for a request
+ * that the producer sends. If that header is not set, an exchange
+ * property of the same name replaces this option.
* There are 1 enums and the value can be one of: sendSms
*
* @param componentName to use a custom component name for the endpoint
@@ -361,7 +420,10 @@ public interface SMSEndpointBuilderFactory {
public static final SMSHeaderNameBuilder INSTANCE = new
SMSHeaderNameBuilder();
/**
- * Phone numbers to send SMS to.
+ * The phone numbers of the recipients, which are separated by commas.
+ * Short Message Service accepts at most 1000 phone numbers. This
header
+ * replaces the phoneNumbers option. If this header is not set, an
+ * exchange property of the same name replaces the phoneNumbers option.
*
* The option is a: {@code String} type.
*
@@ -373,7 +435,10 @@ public interface SMSEndpointBuilderFactory {
return "CamelAlibabaSmsPhoneNumbers";
}
/**
- * SMS sign name.
+ * The sign name of the SMS message. The value must be an approved sign
+ * name. This header replaces the signName option. If this header is
not
+ * set, an exchange property of the same name replaces the signName
+ * option.
*
* The option is a: {@code String} type.
*
@@ -385,7 +450,10 @@ public interface SMSEndpointBuilderFactory {
return "CamelAlibabaSmsSignName";
}
/**
- * SMS template code.
+ * The template code of the SMS message. The value must be the code of
+ * an approved template. This header replaces the templateCode option.
+ * If this header is not set, an exchange property of the same name
+ * replaces the templateCode option.
*
* The option is a: {@code String} type.
*
@@ -397,7 +465,11 @@ public interface SMSEndpointBuilderFactory {
return "CamelAlibabaSmsTemplateCode";
}
/**
- * SMS template parameters as JSON.
+ * The template parameters of the SMS message as a JSON string. The
JSON
+ * string must provide a value for each variable of the template. This
+ * header replaces the templateParam option. If this header is not set,
+ * an exchange property of the same name replaces the templateParam
+ * option.
*
* The option is a: {@code String} type.
*
@@ -409,7 +481,9 @@ public interface SMSEndpointBuilderFactory {
return "CamelAlibabaSmsTemplateParam";
}
/**
- * Out id for the SMS.
+ * The external transaction ID of the SMS message. This header replaces
+ * the outId option. If this header is not set, an exchange property of
+ * the same name replaces the outId option.
*
* The option is a: {@code String} type.
*
@@ -421,7 +495,8 @@ public interface SMSEndpointBuilderFactory {
return "CamelAlibabaSmsOutId";
}
/**
- * Alibaba Cloud request id.
+ * The request ID that Short Message Service returns in the response to
+ * the operation. The producer sets it, unless the exchange fails.
*
* The option is a: {@code String} type.
*
diff --git a/tasks/component-descriptions.md b/tasks/component-descriptions.md
index dc8fab3a8882..96e07a2cd506 100644
--- a/tasks/component-descriptions.md
+++ b/tasks/component-descriptions.md
@@ -65,7 +65,7 @@ or removes its row.
| camel-alibaba-oss | alibaba-oss | |
| camel-alibaba-ots | alibaba-ots | yes |
| camel-alibaba-sls | alibaba-sls | |
-| camel-alibaba-sms | alibaba-sms | |
+| camel-alibaba-sms | alibaba-sms | yes |
| camel-amqp | amqp | |
| camel-apicurio-registry | apicurio-registry | |
| camel-arangodb | arangodb | |