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 a2ee34085b64 CAMEL-23832: camel-alibaba-kms - improve option
descriptions (#30139)
a2ee34085b64 is described below
commit a2ee34085b6484fde755e7d3ef1c748dda872a33
Author: Saravanakumar Selvaraj <[email protected]>
AuthorDate: Mon Nov 16 21:56:10 2026 +0000
CAMEL-23832: camel-alibaba-kms - improve option descriptions (#30139)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/components/alibaba-kms.json | 36 +++---
.../camel/component/alibaba/kms/alibaba-kms.json | 36 +++---
.../camel/component/alibaba/kms/KMSEndpoint.java | 72 +++++++++---
.../alibaba/kms/constants/KMSHeaders.java | 35 +++++-
.../builder/endpoint/StaticEndpointBuilders.java | 10 +-
.../endpoint/dsl/KMSEndpointBuilderFactory.java | 123 +++++++++++++++++----
tasks/component-descriptions.md | 2 +-
7 files changed, 229 insertions(+), 85 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-kms.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-kms.json
index ea2a6a8b33b1..010ab88c1fb1 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-kms.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-kms.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": {
- "CamelAlibabaKmsKeyId": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "KMS key id override", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#KEY_ID" },
- "CamelAlibabaKmsPlaintext": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Plaintext to encrypt", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#PLAINTEXT" },
- "CamelAlibabaKmsCiphertextBlob": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Ciphertext blob to decrypt", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#CIPHERTEXT_BLOB" },
- "CamelAlibabaKmsKeySpec": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Key spec for generateDataKey", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#KEY_SPEC" },
- "CamelAlibabaKmsNumberOfBytes": { "index": 4, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "Number of bytes for generateDataKey", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#NUMBER_OF_BYTES" },
- "CamelAlibabaKmsRequestId": { "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.kms.constants.KMSHeaders#REQUEST_ID" }
+ "CamelAlibabaKmsKeyId": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The ID, alias or ARN of the KMS key for encrypt and
generateDataKey. This header replaces the keyId option. If this header is not
set, an exchange property of the same name replaces the keyId option.",
"constantName": "org.apache.camel.component.alibaba.km [...]
+ "CamelAlibabaKmsPlaintext": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The plaintext for encrypt. The producer encodes it in UTF-8 and
sends it to KMS in Base64. This header replaces the plaintext option. If this
header is not set, an exchange property of the same name replaces the plaintext
option.", "constantName": "org [...]
+ "CamelAlibabaKmsCiphertextBlob": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The ciphertext blob for decrypt, for example from the response
to encrypt or generateDataKey. This header replaces the ciphertextBlob option.
If this header is not set, an exchange property of the same name replaces the
ciphertextBlob option.", "c [...]
+ "CamelAlibabaKmsKeySpec": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The key spec of the data key for generateDataKey. The value
must be AES_256 or AES_128. KMS does not use it when the number of bytes is set
as well. This header replaces the keySpec option. If this header is not set, an
exchange property of the same name [...]
+ "CamelAlibabaKmsNumberOfBytes": { "index": 4, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "The number of bytes of the data key for generateDataKey.
The value must be from 1 to 1024. This header replaces the numberOfBytes
option. If this header is not set, an exchange property of the same name
replaces the numberOfBytes option.", "consta [...]
+ "CamelAlibabaKmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that KMS returns in the response to the
operation. The producer sets it, unless the exchange fails.", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#REQUEST_ID" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "encrypt", "carriers": [ "text", "bytes", "stream",
"file" ] }, { "option": "operation", "value": "decrypt", "carriers": [ "text" ]
} ], "description": "encrypt encrypts the body unless the plaintext option or
header is set: text in UTF-8, bytes as they are, and a stream or a file as its
bytes, so binary data is kept. A Map or a POJO fails, as it does not convert to
bytes, so marshal it first. decr [...]
"producerOut": { "carriers": [ "map" ], "javaType": "java.util.Map",
"description": "A Map with the statusCode and the fields of the response: the
ciphertextBlob and keyId of encrypt, the plaintext of decrypt, which is Base64
when this component encrypted it, and the plaintext and ciphertextBlob of
generateDataKey. The request id is in the CamelAlibabaKmsRequestId header too" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "encrypt", "decrypt",
"generateDataKey" ], "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": "KMS endpoint URL. Carries higher precedence
than region based client initialization" },
- "keyId": { "index": 2, "kind": "parameter", "displayName": "Key Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "KMS key id" },
- "keySpec": { "index": 3, "kind": "parameter", "displayName": "Key Spec",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Key spec for generateDataKey" },
- "numberOfBytes": { "index": 4, "kind": "parameter", "displayName": "Number
Of Bytes", "group": "producer", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "Number of bytes for generateDataKey" },
- "region": { "index": 5, "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" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "encrypt", "decrypt",
"generateDataKey" ], "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. The
CamelAlibabaKmsOperation header replaces this option for a request that the
producer sends. If that header is not set, an exchange prope [...]
+ "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 KMS, 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 kmsClient o [...]
+ "keyId": { "index": 2, "kind": "parameter", "displayName": "Key Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The ID, alias or ARN of the KMS key for
encrypt and generateDataKey. The CamelAlibabaKmsKeyId 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 op [...]
+ "keySpec": { "index": 3, "kind": "parameter", "displayName": "Key Spec",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The key spec of the data key for
generateDataKey. The value must be AES_256 or AES_128. KMS does not use it when
the number of bytes is set as well. The CamelAlibabaKmsKeySpec header replaces
this option for a request that the producer se [...]
+ "numberOfBytes": { "index": 4, "kind": "parameter", "displayName": "Number
Of Bytes", "group": "producer", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The number of bytes of the data key for
generateDataKey. The value must be from 1 to 1024. The
CamelAlibabaKmsNumberOfBytes header replaces this option for a request that the
producer sends. If that header is not set, an ex [...]
+ "region": { "index": 5, "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 KMS, for example cn-hangzhou.
Only used when the endpoint option is not set, to build the endpoint of KMS.
Not used when the kmsClient option is set or autowired." },
"lazyStartProducer": { "index": 6, "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 [...]
- "kmsClient": { "index": 7, "kind": "parameter", "displayName": "KMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.kms20160120.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing KMS
client instance" },
- "accessKey": { "index": 8, "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" },
- "ciphertextBlob": { "index": 9, "kind": "parameter", "displayName":
"Ciphertext Blob", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Ciphertext blob to decrypt" },
- "plaintext": { "index": 10, "kind": "parameter", "displayName":
"Plaintext", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Plaintext to encrypt" },
- "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" }
+ "kmsClient": { "index": 7, "kind": "parameter", "displayName": "KMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.kms20160120.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.kms20160120.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 [...]
+ "accessKey": { "index": 8, "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 KMS. If not
set, the accessKey of the serviceKeys option is used, and one of the two is
required. Not used when the kmsCli [...]
+ "ciphertextBlob": { "index": 9, "kind": "parameter", "displayName":
"Ciphertext Blob", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
ciphertext blob for decrypt, for example from the response to encrypt or
generateDataKey. The CamelAlibabaKmsCiphertextBlob header replaces this option
for a request that the producer sends. [...]
+ "plaintext": { "index": 10, "kind": "parameter", "displayName":
"Plaintext", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
plaintext for encrypt. The producer encodes it in UTF-8 and sends it to KMS in
Base64. The CamelAlibabaKmsPlaintext header replaces this option for a request
that the producer sends. If that header is [...]
+ "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 KMS.
If not set, the secretKey of the serviceKeys option is used, and one of the two
is required. Not used when the k [...]
+ "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-kms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/kms/alibaba-kms.json
b/components/camel-alibaba/camel-alibaba-kms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/kms/alibaba-kms.json
index ea2a6a8b33b1..010ab88c1fb1 100644
---
a/components/camel-alibaba/camel-alibaba-kms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/kms/alibaba-kms.json
+++
b/components/camel-alibaba/camel-alibaba-kms/src/generated/resources/META-INF/org/apache/camel/component/alibaba/kms/alibaba-kms.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": {
- "CamelAlibabaKmsKeyId": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "KMS key id override", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#KEY_ID" },
- "CamelAlibabaKmsPlaintext": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Plaintext to encrypt", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#PLAINTEXT" },
- "CamelAlibabaKmsCiphertextBlob": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Ciphertext blob to decrypt", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#CIPHERTEXT_BLOB" },
- "CamelAlibabaKmsKeySpec": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Key spec for generateDataKey", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#KEY_SPEC" },
- "CamelAlibabaKmsNumberOfBytes": { "index": 4, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "Number of bytes for generateDataKey", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#NUMBER_OF_BYTES" },
- "CamelAlibabaKmsRequestId": { "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.kms.constants.KMSHeaders#REQUEST_ID" }
+ "CamelAlibabaKmsKeyId": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The ID, alias or ARN of the KMS key for encrypt and
generateDataKey. This header replaces the keyId option. If this header is not
set, an exchange property of the same name replaces the keyId option.",
"constantName": "org.apache.camel.component.alibaba.km [...]
+ "CamelAlibabaKmsPlaintext": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The plaintext for encrypt. The producer encodes it in UTF-8 and
sends it to KMS in Base64. This header replaces the plaintext option. If this
header is not set, an exchange property of the same name replaces the plaintext
option.", "constantName": "org [...]
+ "CamelAlibabaKmsCiphertextBlob": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The ciphertext blob for decrypt, for example from the response
to encrypt or generateDataKey. This header replaces the ciphertextBlob option.
If this header is not set, an exchange property of the same name replaces the
ciphertextBlob option.", "c [...]
+ "CamelAlibabaKmsKeySpec": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The key spec of the data key for generateDataKey. The value
must be AES_256 or AES_128. KMS does not use it when the number of bytes is set
as well. This header replaces the keySpec option. If this header is not set, an
exchange property of the same name [...]
+ "CamelAlibabaKmsNumberOfBytes": { "index": 4, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "The number of bytes of the data key for generateDataKey.
The value must be from 1 to 1024. This header replaces the numberOfBytes
option. If this header is not set, an exchange property of the same name
replaces the numberOfBytes option.", "consta [...]
+ "CamelAlibabaKmsRequestId": { "index": 5, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that KMS returns in the response to the
operation. The producer sets it, unless the exchange fails.", "constantName":
"org.apache.camel.component.alibaba.kms.constants.KMSHeaders#REQUEST_ID" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "encrypt", "carriers": [ "text", "bytes", "stream",
"file" ] }, { "option": "operation", "value": "decrypt", "carriers": [ "text" ]
} ], "description": "encrypt encrypts the body unless the plaintext option or
header is set: text in UTF-8, bytes as they are, and a stream or a file as its
bytes, so binary data is kept. A Map or a POJO fails, as it does not convert to
bytes, so marshal it first. decr [...]
"producerOut": { "carriers": [ "map" ], "javaType": "java.util.Map",
"description": "A Map with the statusCode and the fields of the response: the
ciphertextBlob and keyId of encrypt, the plaintext of decrypt, which is Base64
when this component encrypted it, and the plaintext and ciphertextBlob of
generateDataKey. The request id is in the CamelAlibabaKmsRequestId header too" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "encrypt", "decrypt",
"generateDataKey" ], "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": "KMS endpoint URL. Carries higher precedence
than region based client initialization" },
- "keyId": { "index": 2, "kind": "parameter", "displayName": "Key Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "KMS key id" },
- "keySpec": { "index": 3, "kind": "parameter", "displayName": "Key Spec",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Key spec for generateDataKey" },
- "numberOfBytes": { "index": 4, "kind": "parameter", "displayName": "Number
Of Bytes", "group": "producer", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "Number of bytes for generateDataKey" },
- "region": { "index": 5, "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" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "encrypt", "decrypt",
"generateDataKey" ], "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. The
CamelAlibabaKmsOperation header replaces this option for a request that the
producer sends. If that header is not set, an exchange prope [...]
+ "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 KMS, 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 kmsClient o [...]
+ "keyId": { "index": 2, "kind": "parameter", "displayName": "Key Id",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The ID, alias or ARN of the KMS key for
encrypt and generateDataKey. The CamelAlibabaKmsKeyId 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 op [...]
+ "keySpec": { "index": 3, "kind": "parameter", "displayName": "Key Spec",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The key spec of the data key for
generateDataKey. The value must be AES_256 or AES_128. KMS does not use it when
the number of bytes is set as well. The CamelAlibabaKmsKeySpec header replaces
this option for a request that the producer se [...]
+ "numberOfBytes": { "index": 4, "kind": "parameter", "displayName": "Number
Of Bytes", "group": "producer", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The number of bytes of the data key for
generateDataKey. The value must be from 1 to 1024. The
CamelAlibabaKmsNumberOfBytes header replaces this option for a request that the
producer sends. If that header is not set, an ex [...]
+ "region": { "index": 5, "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 KMS, for example cn-hangzhou.
Only used when the endpoint option is not set, to build the endpoint of KMS.
Not used when the kmsClient option is set or autowired." },
"lazyStartProducer": { "index": 6, "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 [...]
- "kmsClient": { "index": 7, "kind": "parameter", "displayName": "KMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.kms20160120.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing KMS
client instance" },
- "accessKey": { "index": 8, "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" },
- "ciphertextBlob": { "index": 9, "kind": "parameter", "displayName":
"Ciphertext Blob", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Ciphertext blob to decrypt" },
- "plaintext": { "index": 10, "kind": "parameter", "displayName":
"Plaintext", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Plaintext to encrypt" },
- "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" }
+ "kmsClient": { "index": 7, "kind": "parameter", "displayName": "KMS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.kms20160120.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.kms20160120.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 [...]
+ "accessKey": { "index": 8, "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 KMS. If not
set, the accessKey of the serviceKeys option is used, and one of the two is
required. Not used when the kmsCli [...]
+ "ciphertextBlob": { "index": 9, "kind": "parameter", "displayName":
"Ciphertext Blob", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
ciphertext blob for decrypt, for example from the response to encrypt or
generateDataKey. The CamelAlibabaKmsCiphertextBlob header replaces this option
for a request that the producer sends. [...]
+ "plaintext": { "index": 10, "kind": "parameter", "displayName":
"Plaintext", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
plaintext for encrypt. The producer encodes it in UTF-8 and sends it to KMS in
Base64. The CamelAlibabaKmsPlaintext header replaces this option for a request
that the producer sends. If that header is [...]
+ "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 KMS.
If not set, the secretKey of the serviceKeys option is used, and one of the two
is required. Not used when the k [...]
+ "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-kms/src/main/java/org/apache/camel/component/alibaba/kms/KMSEndpoint.java
b/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/KMSEndpoint.java
index bd1eec8b44ad..05ec0ed9a5db 100644
---
a/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/KMSEndpoint.java
+++
b/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/KMSEndpoint.java
@@ -58,48 +58,86 @@ import org.apache.camel.support.DefaultEndpoint;
+ " too"))
public class KMSEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "encrypt,decrypt,generateDataKey")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaKmsOperation 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 =
"encrypt,decrypt,generateDataKey")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Alibaba Cloud region", displayName = "Region")
+ @UriParam(description = "The region ID of KMS, for example cn-hangzhou.
Only used when the endpoint option is not set, to"
+ + " build the endpoint of KMS. Not used when the
kmsClient option is set or autowired.",
+ displayName = "Region")
@Metadata(required = true)
private String region;
- @UriParam(description = "KMS endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of KMS, 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 kmsClient 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 KMS. If not"
+ + " set, the accessKey of the serviceKeys option
is used, and one of the two is required. Not used"
+ + " when the kmsClient 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 KMS. If not"
+ + " set, the secretKey of the serviceKeys option
is used, and one of the two is required. Not used"
+ + " when the kmsClient 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 kmsClient option is set or"
+ + " autowired.",
+ displayName = "Service Keys", security = "secret", label =
"security")
private ServiceKeys serviceKeys;
- @UriParam(description = "KMS key id", displayName = "Key Id")
+ @UriParam(description = "The ID, alias or ARN of the KMS key for encrypt
and generateDataKey. The CamelAlibabaKmsKeyId"
+ + " 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 for"
+ + " encrypt and generateDataKey.",
+ displayName = "Key Id")
private String keyId;
- @UriParam(description = "Plaintext to encrypt", displayName = "Plaintext",
security = "secret", label = "security")
+ @UriParam(description = "The plaintext for encrypt. The producer encodes
it in UTF-8 and sends it to KMS in Base64. The"
+ + " CamelAlibabaKmsPlaintext 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 takes the
plaintext from the message body.",
+ displayName = "Plaintext", security = "secret", label =
"security")
private String plaintext;
- @UriParam(description = "Ciphertext blob to decrypt", displayName =
"Ciphertext Blob", security = "secret",
- label = "security")
+ @UriParam(description = "The ciphertext blob for decrypt, for example from
the response to encrypt or generateDataKey. The"
+ + " CamelAlibabaKmsCiphertextBlob 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
takes the ciphertext blob from the message body as"
+ + " text.",
+ displayName = "Ciphertext Blob", security = "secret", label =
"security")
private String ciphertextBlob;
- @UriParam(description = "Key spec for generateDataKey", displayName = "Key
Spec")
+ @UriParam(description = "The key spec of the data key for generateDataKey.
The value must be AES_256 or AES_128. KMS does"
+ + " not use it when the number of bytes is set as
well. The CamelAlibabaKmsKeySpec 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 key spec to the request.",
+ displayName = "Key Spec")
private String keySpec;
- @UriParam(description = "Number of bytes for generateDataKey", displayName
= "Number Of Bytes")
+ @UriParam(description = "The number of bytes of the data key for
generateDataKey. The value must be from 1 to 1024. The"
+ + " CamelAlibabaKmsNumberOfBytes 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
number of bytes to the request.",
+ displayName = "Number Of Bytes")
private Integer numberOfBytes;
- @UriParam(description = "Autowire an existing KMS client instance",
displayName = "KMS Client", label = "advanced")
+ @UriParam(description = "To use a custom com.aliyun.kms20160120.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 = "KMS Client", label = "advanced")
@Metadata(autowired = true)
private Client kmsClient;
diff --git
a/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/constants/KMSHeaders.java
b/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/constants/KMSHeaders.java
index 1c9a6f285127..5d21773295cb 100644
---
a/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/constants/KMSHeaders.java
+++
b/components/camel-alibaba/camel-alibaba-kms/src/main/java/org/apache/camel/component/alibaba/kms/constants/KMSHeaders.java
@@ -20,22 +20,45 @@ import org.apache.camel.spi.Metadata;
public final class KMSHeaders {
- @Metadata(label = "producer", description = "KMS key id override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The ID, alias or ARN of the KMS key for encrypt
and generateDataKey. This header replaces the"
+ + " keyId option. If this header is not set, an
exchange property of the same name replaces the"
+ + " keyId option.",
+ javaType = "String")
public static final String KEY_ID = KMSProperties.KEY_ID;
- @Metadata(label = "producer", description = "Plaintext to encrypt",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The plaintext for encrypt. The producer encodes
it in UTF-8 and sends it to KMS in Base64. This"
+ + " header replaces the plaintext option. If this
header is not set, an exchange property of the"
+ + " same name replaces the plaintext option.",
+ javaType = "String")
public static final String PLAINTEXT = KMSProperties.PLAINTEXT;
- @Metadata(label = "producer", description = "Ciphertext blob to decrypt",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The ciphertext blob for decrypt, for example from
the response to encrypt or generateDataKey. This"
+ + " header replaces the ciphertextBlob option. If
this header is not set, an exchange property of"
+ + " the same name replaces the ciphertextBlob
option.",
+ javaType = "String")
public static final String CIPHERTEXT_BLOB = KMSProperties.CIPHERTEXT_BLOB;
- @Metadata(label = "producer", description = "Key spec for
generateDataKey", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The key spec of the data key for generateDataKey.
The value must be AES_256 or AES_128. KMS does"
+ + " not use it when the number of bytes is set as
well. This header replaces the keySpec option. If"
+ + " this header is not set, an exchange property
of the same name replaces the keySpec option.",
+ javaType = "String")
public static final String KEY_SPEC = KMSProperties.KEY_SPEC;
- @Metadata(label = "producer", description = "Number of bytes for
generateDataKey", javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The number of bytes of the data key for
generateDataKey. The value must be from 1 to 1024. This"
+ + " header replaces the numberOfBytes option. If
this header is not set, an exchange property of"
+ + " the same name replaces the numberOfBytes
option.",
+ javaType = "Integer")
public static final String NUMBER_OF_BYTES = KMSProperties.NUMBER_OF_BYTES;
- @Metadata(label = "producer", description = "Alibaba Cloud request id",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The request ID that KMS returns in the response
to the operation. The producer sets it, unless the"
+ + " exchange fails.",
+ javaType = "String")
public static final String REQUEST_ID = KMSProperties.REQUEST_ID;
private KMSHeaders() {
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 565a30dbce2c..f3c54f237b9c 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
@@ -412,7 +412,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-kms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaKmsOperation
+ * 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 3 enums and the value can be one of: encrypt, decrypt,
* generateDataKey
*
@@ -434,7 +437,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-kms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaKmsOperation
+ * 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 3 enums and the value can be one of: encrypt, decrypt,
* generateDataKey
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/KMSEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/KMSEndpointBuilderFactory.java
index f6702b187828..2d7fe17b96d9 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/KMSEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/KMSEndpointBuilderFactory.java
@@ -45,8 +45,10 @@ public interface KMSEndpointBuilderFactory {
}
/**
- * KMS endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of KMS, 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 kmsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -60,7 +62,11 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * KMS key id.
+ * The ID, alias or ARN of the KMS key for encrypt and generateDataKey.
+ * The CamelAlibabaKmsKeyId 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 for encrypt and generateDataKey.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -74,7 +80,12 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Key spec for generateDataKey.
+ * The key spec of the data key for generateDataKey. The value must be
+ * AES_256 or AES_128. KMS does not use it when the number of bytes is
+ * set as well. The CamelAlibabaKmsKeySpec 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 key spec to the request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -88,7 +99,12 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Number of bytes for generateDataKey.
+ * The number of bytes of the data key for generateDataKey. The value
+ * must be from 1 to 1024. The CamelAlibabaKmsNumberOfBytes 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
number
+ * of bytes to the request.
*
* The option is a: <code>java.lang.Integer</code> type.
*
@@ -102,7 +118,12 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Number of bytes for generateDataKey.
+ * The number of bytes of the data key for generateDataKey. The value
+ * must be from 1 to 1024. The CamelAlibabaKmsNumberOfBytes 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
number
+ * of bytes to the request.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
@@ -117,7 +138,9 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Alibaba Cloud region.
+ * The region ID of KMS, for example cn-hangzhou. Only used when the
+ * endpoint option is not set, to build the endpoint of KMS. Not used
+ * when the kmsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -132,7 +155,10 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for the requests that the
+ * producer sends to KMS. If not set, the accessKey of the serviceKeys
+ * option is used, and one of the two is required. Not used when the
+ * kmsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -146,7 +172,12 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Ciphertext blob to decrypt.
+ * The ciphertext blob for decrypt, for example from the response to
+ * encrypt or generateDataKey. The CamelAlibabaKmsCiphertextBlob 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 takes the
+ * ciphertext blob from the message body as text.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -160,7 +191,12 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Plaintext to encrypt.
+ * The plaintext for encrypt. The producer encodes it in UTF-8 and
sends
+ * it to KMS in Base64. The CamelAlibabaKmsPlaintext 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 takes the plaintext from
+ * the message body.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -174,7 +210,10 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for the requests that the
+ * producer sends to KMS. If not set, the secretKey of the serviceKeys
+ * option is used, and one of the two is required. Not used when the
+ * kmsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -188,7 +227,11 @@ public interface KMSEndpointBuilderFactory {
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 kmsClient option is set or autowired.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -203,7 +246,11 @@ public interface KMSEndpointBuilderFactory {
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 kmsClient option is set or autowired.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -276,7 +323,11 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing KMS client instance.
+ * To use a custom com.aliyun.kms20160120.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.kms20160120.Client</code> type.
*
@@ -290,7 +341,11 @@ public interface KMSEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing KMS client instance.
+ * To use a custom com.aliyun.kms20160120.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.kms20160120.Client</code> type.
@@ -333,7 +388,10 @@ public interface KMSEndpointBuilderFactory {
* Syntax: <code>alibaba-kms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaKmsOperation 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 3 enums and the value can be one of: encrypt, decrypt,
* generateDataKey
*
@@ -355,7 +413,10 @@ public interface KMSEndpointBuilderFactory {
* Syntax: <code>alibaba-kms:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaKmsOperation 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 3 enums and the value can be one of: encrypt, decrypt,
* generateDataKey
*
@@ -380,7 +441,9 @@ public interface KMSEndpointBuilderFactory {
public static final KMSHeaderNameBuilder INSTANCE = new
KMSHeaderNameBuilder();
/**
- * KMS key id override.
+ * The ID, alias or ARN of the KMS key for encrypt and generateDataKey.
+ * This header replaces the keyId option. If this header is not set, an
+ * exchange property of the same name replaces the keyId option.
*
* The option is a: {@code String} type.
*
@@ -392,7 +455,10 @@ public interface KMSEndpointBuilderFactory {
return "CamelAlibabaKmsKeyId";
}
/**
- * Plaintext to encrypt.
+ * The plaintext for encrypt. The producer encodes it in UTF-8 and
sends
+ * it to KMS in Base64. This header replaces the plaintext option. If
+ * this header is not set, an exchange property of the same name
+ * replaces the plaintext option.
*
* The option is a: {@code String} type.
*
@@ -404,7 +470,10 @@ public interface KMSEndpointBuilderFactory {
return "CamelAlibabaKmsPlaintext";
}
/**
- * Ciphertext blob to decrypt.
+ * The ciphertext blob for decrypt, for example from the response to
+ * encrypt or generateDataKey. This header replaces the ciphertextBlob
+ * option. If this header is not set, an exchange property of the same
+ * name replaces the ciphertextBlob option.
*
* The option is a: {@code String} type.
*
@@ -416,7 +485,11 @@ public interface KMSEndpointBuilderFactory {
return "CamelAlibabaKmsCiphertextBlob";
}
/**
- * Key spec for generateDataKey.
+ * The key spec of the data key for generateDataKey. The value must be
+ * AES_256 or AES_128. KMS does not use it when the number of bytes is
+ * set as well. This header replaces the keySpec option. If this header
+ * is not set, an exchange property of the same name replaces the
+ * keySpec option.
*
* The option is a: {@code String} type.
*
@@ -428,7 +501,10 @@ public interface KMSEndpointBuilderFactory {
return "CamelAlibabaKmsKeySpec";
}
/**
- * Number of bytes for generateDataKey.
+ * The number of bytes of the data key for generateDataKey. The value
+ * must be from 1 to 1024. This header replaces the numberOfBytes
+ * option. If this header is not set, an exchange property of the same
+ * name replaces the numberOfBytes option.
*
* The option is a: {@code Integer} type.
*
@@ -440,7 +516,8 @@ public interface KMSEndpointBuilderFactory {
return "CamelAlibabaKmsNumberOfBytes";
}
/**
- * Alibaba Cloud request id.
+ * The request ID that KMS 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 72064fb11c09..dc8fab3a8882 100644
--- a/tasks/component-descriptions.md
+++ b/tasks/component-descriptions.md
@@ -60,7 +60,7 @@ or removes its row.
| camel-ai-tool | ai-tool | |
| camel-alibaba-eventbridge | alibaba-eventbridge | yes |
| camel-alibaba-fc | alibaba-fc | yes |
-| camel-alibaba-kms | alibaba-kms | |
+| camel-alibaba-kms | alibaba-kms | yes |
| camel-alibaba-mns | alibaba-mns | |
| camel-alibaba-oss | alibaba-oss | |
| camel-alibaba-ots | alibaba-ots | yes |