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 43c6d3feaaa8 CAMEL-23832: camel-alibaba-oss - improve the component
and option descriptions (#30602)
43c6d3feaaa8 is described below
commit 43c6d3feaaa89a452b88fed3c8e26720caf5d5a7
Author: Saravanakumar Selvaraj <[email protected]>
AuthorDate: Sun Nov 22 20:40:47 2026 +0000
CAMEL-23832: camel-alibaba-oss - improve the component and option
descriptions (#30602)
This commit rewrites the component description and the texts of 13 endpoint
options and 3 headers of alibaba-oss. The
new texts say what each value is and, where it matters, which side reads it
and what replaces it. They also give the
limits of Object Storage Service and the options that ossClient replaces.
The old ETag text called every ETag an MD5
digest, which holds only for objects that PutObject created.
Documentation only, no behavior change. The component JSON, the catalog
copy, the doc page header and the DSL are
regenerated. camel-alibaba-oss is marked as done in
tasks/component-descriptions.md.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/components/alibaba-oss.json | 34 ++--
.../camel/catalog/docs/alibaba-oss-component.adoc | 2 +-
.../camel/component/alibaba/oss/alibaba-oss.json | 34 ++--
.../src/main/docs/alibaba-oss-component.adoc | 2 +-
.../camel/component/alibaba/oss/OSSEndpoint.java | 58 +++++--
.../alibaba/oss/constants/OSSHeaders.java | 12 +-
.../component/ComponentsBuilderFactory.java | 2 +-
.../dsl/AlibabaOssComponentBuilderFactory.java | 4 +-
.../builder/endpoint/EndpointHeaderBuilders.java | 2 +-
.../builder/endpoint/StaticEndpointBuilders.java | 12 +-
.../endpoint/dsl/OSSEndpointBuilderFactory.java | 175 +++++++++++++++------
tasks/component-descriptions.md | 2 +-
12 files changed, 230 insertions(+), 109 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-oss.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-oss.json
index e0ee2a5e3e2e..1eb93ac45869 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-oss.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-oss.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "alibaba-oss",
"title": "Alibaba Object Storage Service (OSS)",
- "description": "Alibaba Cloud Object Storage Service (OSS) component",
+ "description": "Store and retrieve objects in Alibaba Cloud Object Storage
Service (OSS).",
"deprecated": false,
"firstVersion": "4.23.0",
"label": "cloud",
@@ -31,15 +31,15 @@
"healthCheckProducerEnabled": { "index": 4, "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": {
- "CamelAlibabaOssBucketName": { "index": 0, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the bucket where object is contained", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#BUCKET_NAME" },
+ "CamelAlibabaOssBucketName": { "index": 0, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the bucket. The consumer sets it for a consumed
object, and the producer for getObject. An exchange property of the same name
replaces the bucketName option for the producer, and this header replaces
both.", "constantName": "org.apache.cam [...]
"CamelAlibabaOssObjectKey": { "index": 1, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The key that the object is stored under", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#OBJECT_KEY" },
"CamelAlibabaOssLastModified": { "index": 2, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The date and time that the object was last modified",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#LAST_MODIFIED" },
- "CamelAlibabaOssETag": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The 128-bit MD5 digest of the object content", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#ETAG" },
+ "CamelAlibabaOssETag": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The entity tag (ETag) of the object, which identifies its
content. It is the MD5 hash of the content only for an object created by
PutObject.", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#ETAG" },
"CamelAlibabaOssContentMD5": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The 128-bit Base64-encoded digest of the object",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_MD5" },
"CamelAlibabaOssObjectType": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Shows whether the object is a file or a folder",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#OBJECT_TYPE" },
"CamelAlibabaOssContentLength": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The size of the object body in bytes", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_LENGTH" },
"CamelAlibabaOssContentType": { "index": 7, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The type of content stored in the object", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_TYPE" },
- "CamelFileName": { "index": 8, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the object with which the operation is to be
performed", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#FILE_NAME" }
+ "CamelFileName": { "index": 8, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the object. The consumer sets it for a consumed
object, and the producer for getObject.", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#FILE_NAME" }
},
"bodyTypes": {
"consumerOut": { "carriers": [ "bytes" ], "javaType": "byte[]",
"byOption": [ { "option": "includeBody", "value": "false", "carriers": [
"stream" ] } ], "description": "The content of the object as a byte array, one
message per object, with its bucket, key and metadata in headers. With
includeBody=false the stream of the content of the object, which is closed when
the exchange is done" },
@@ -47,23 +47,23 @@
"producerOut": { "carriers": [ "map" ], "byOption": [ { "option":
"operation", "value": "getObject", "carriers": [ "bytes" ], "javaType":
"byte[]" }, { "option": "operation", "value": "listObjects", "carriers": [
"list" ], "javaType": "java.util.List<java.util.Map<String, Object>>" }, {
"option": "operation", "value": "listBuckets", "carriers": [ "list" ],
"javaType": "java.util.List<java.util.Map<String, Object>>" } ], "description":
"A Map of the result for putObject, deleteObject, [...]
},
"properties": {
- "bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Name of bucket to perform operation on" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint
url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "OSS endpoint URL. Carries higher precedence
than region based client initialization" },
- "objectName": { "index": 2, "kind": "parameter", "displayName": "Object
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Name of object to perform operation with" },
- "region": { "index": 3, "kind": "parameter", "displayName": "Service
region", "group": "common", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "OSS service region" },
- "deleteAfterRead": { "index": 4, "kind": "parameter", "displayName":
"Delete after read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Determines if objects should be deleted after they have been retrieved" },
+ "bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the bucket, or of the destination
bucket for copyObject. The CamelAlibabaOssBucketName exchange property replaces
this option for the producer, and a header of the same name replaces both." },
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint
url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Object Storage Service, for
example oss-cn-hangzhou.aliyuncs.com. If not set, the SDK builds it from the
region option." },
+ "objectName": { "index": 2, "kind": "parameter", "displayName": "Object
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the object for the producer, or of
the destination object for copyObject. The CamelAlibabaOssObjectName exchange
property replaces this option, and a header of the same name replaces both." },
+ "region": { "index": 3, "kind": "parameter", "displayName": "Service
region", "group": "common", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Object Storage Service, for
example cn-hangzhou. The SDK uses it to sign requests, and to build the
endpoint when the endpoint option is not set." },
+ "deleteAfterRead": { "index": 4, "kind": "parameter", "displayName":
"Delete after read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether to delete the object from the bucket after it is processed
successfully. If false, the consumer consumes the object again in a later
poll." },
"includeBody": { "index": 5, "kind": "parameter", "displayName": "Include
Body", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "If true, the content of
each consumed object is read into a byte array, which is the body. If false,
the body is the stream of the content of the object, which is closed when the
exchange is done. For large o [...]
- "maxMessagesPerPoll": { "index": 6, "kind": "parameter", "displayName":
"Maximum messages per poll", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 10, "description": "The
maximum number of messages to poll at each polling" },
- "prefix": { "index": 7, "kind": "parameter", "displayName": "Prefix",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The object name prefix used for filtering
objects to be listed" },
+ "maxMessagesPerPoll": { "index": 6, "kind": "parameter", "displayName":
"Maximum messages per poll", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 10, "description": "The
maximum number of objects that the consumer lists in one poll. Object Storage
Service accepts a value of at most 1000. The consumer treats a value of 0 or
less as 10." },
+ "prefix": { "index": 7, "kind": "parameter", "displayName": "Prefix",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The prefix of the names of the objects to
list, for the consumer and for listObjects. The CamelAlibabaOssPrefix exchange
property replaces this option for the producer, and a header of the same name
replaces both." },
"sendEmptyMessageWhenIdle": { "index": 8, "kind": "parameter",
"displayName": "Send Empty Message When Idle", "group": "consumer", "label":
"consumer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "If the polling consumer did not poll any files, you can
enable this option to send an empty message (no body) instead." },
"bridgeErrorHandler": { "index": 9, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
"exceptionHandler": { "index": 10, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 11, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"pollStrategy": { "index": 12, "kind": "parameter", "displayName": "Poll
Strategy", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false,
"autowired": false, "secret": false, "description": "A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the po
[...]
- "maxKeys": { "index": 13, "kind": "parameter", "displayName": "Max Keys",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The maximum number of keys returned
when listing objects" },
- "operation": { "index": 14, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "enum", "javaType": "java.lang.String", "enum": [ "listBuckets",
"listObjects", "putObject", "getObject", "deleteObject", "copyObject",
"headObject" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Operation to be performed" },
+ "maxKeys": { "index": 13, "kind": "parameter", "displayName": "Max Keys",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The maximum number of objects that the
producer returns for listObjects, or all of them if no value is set. Object
Storage Service accepts a value of at most 1000. The CamelAlibabaOssMaxKeys
exchange property replaces [...]
+ "operation": { "index": 14, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "enum", "javaType": "java.lang.String", "enum": [ "listBuckets",
"listObjects", "putObject", "getObject", "deleteObject", "copyObject",
"headObject" ], "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. The
CamelAlibabaOssOperation exchange property replaces this option, and a [...]
"lazyStartProducer": { "index": 15, "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 produ [...]
- "ossClient": { "index": 16, "kind": "parameter", "displayName": "OSS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sdk.service.oss2.OSSClient", "deprecated":
false, "autowired": true, "secret": false, "description": "An autowired OSS
client" },
+ "ossClient": { "index": 16, "kind": "parameter", "displayName": "OSS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sdk.service.oss2.OSSClient", "deprecated":
false, "autowired": true, "secret": false, "description": "To use a custom
com.aliyun.sdk.service.oss2.OSSClient. When this option is set or autowired,
the region, endpoint, accessKey, secretKey, and serviceKeys options are not
used. The Camel endpoint does not cl [...]
"backoffErrorThreshold": { "index": 17, "kind": "parameter",
"displayName": "Backoff Error Threshold", "group": "scheduler", "label":
"consumer,scheduler", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "description": "The
number of subsequent error polls (failed due some error) that should happen
before the backoffMultipler should kick-in." },
"backoffIdleThreshold": { "index": 18, "kind": "parameter", "displayName":
"Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "description": "The number of subsequent
idle polls that should happen before the backoffMultipler should kick-in." },
"backoffMultiplier": { "index": 19, "kind": "parameter", "displayName":
"Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "description": "To let the scheduled
polling consumer backoff if there has been a number of subsequent idles\/errors
in a row. The multiplier is then the number of polls that will be skipped
before the next actual attempt is h [...]
@@ -79,8 +79,8 @@
"startScheduler": { "index": 29, "kind": "parameter", "displayName":
"Start Scheduler", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Whether the scheduler should be auto started." },
"timeUnit": { "index": 30, "kind": "parameter", "displayName": "Time
Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false,
"type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [
"NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS",
"DAYS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and
delay options." },
"useFixedDelay": { "index": 31, "kind": "parameter", "displayName": "Use
Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in
JDK for details." },
- "accessKey": { "index": 32, "kind": "parameter", "displayName": "API
access key (AK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Access key for the cloud user" },
- "secretKey": { "index": 33, "kind": "parameter", "displayName": "API
secret key (SK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Secret key for the cloud user" },
- "serviceKeys": { "index": 34, "kind": "parameter", "displayName": "Service
Configuration", "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" }
+ "accessKey": { "index": 32, "kind": "parameter", "displayName": "API
access key (AK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
AccessKey ID of the AccessKey pair for Object Storage Service. If not set, the
accessKey of the serviceKeys option is used." },
+ "secretKey": { "index": 33, "kind": "parameter", "displayName": "API
secret key (SK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
AccessKey secret of the AccessKey pair for Object Storage Service. If not set,
the secretKey of the serviceKeys option is used." },
+ "serviceKeys": { "index": 34, "kind": "parameter", "displayName": "Service
Configuration", "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 and
its secretKey are each used when the optio [...]
}
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-oss-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-oss-component.adoc
index bb8b45190f5d..38c0dee6d8d9 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-oss-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-oss-component.adoc
@@ -2,7 +2,7 @@
:doctitle: Alibaba Object Storage Service (OSS)
:shortname: alibaba-oss
:artifactid: camel-alibaba-oss
-:description: Alibaba Cloud Object Storage Service (OSS) component
+:description: Store and retrieve objects in Alibaba Cloud Object Storage
Service (OSS).
:since: 4.23
:supportlevel: Preview
:tabs-sync-option:
diff --git
a/components/camel-alibaba/camel-alibaba-oss/src/generated/resources/META-INF/org/apache/camel/component/alibaba/oss/alibaba-oss.json
b/components/camel-alibaba/camel-alibaba-oss/src/generated/resources/META-INF/org/apache/camel/component/alibaba/oss/alibaba-oss.json
index e0ee2a5e3e2e..1eb93ac45869 100644
---
a/components/camel-alibaba/camel-alibaba-oss/src/generated/resources/META-INF/org/apache/camel/component/alibaba/oss/alibaba-oss.json
+++
b/components/camel-alibaba/camel-alibaba-oss/src/generated/resources/META-INF/org/apache/camel/component/alibaba/oss/alibaba-oss.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "alibaba-oss",
"title": "Alibaba Object Storage Service (OSS)",
- "description": "Alibaba Cloud Object Storage Service (OSS) component",
+ "description": "Store and retrieve objects in Alibaba Cloud Object Storage
Service (OSS).",
"deprecated": false,
"firstVersion": "4.23.0",
"label": "cloud",
@@ -31,15 +31,15 @@
"healthCheckProducerEnabled": { "index": 4, "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": {
- "CamelAlibabaOssBucketName": { "index": 0, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the bucket where object is contained", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#BUCKET_NAME" },
+ "CamelAlibabaOssBucketName": { "index": 0, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the bucket. The consumer sets it for a consumed
object, and the producer for getObject. An exchange property of the same name
replaces the bucketName option for the producer, and this header replaces
both.", "constantName": "org.apache.cam [...]
"CamelAlibabaOssObjectKey": { "index": 1, "kind": "header", "displayName":
"", "group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The key that the object is stored under", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#OBJECT_KEY" },
"CamelAlibabaOssLastModified": { "index": 2, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The date and time that the object was last modified",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#LAST_MODIFIED" },
- "CamelAlibabaOssETag": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The 128-bit MD5 digest of the object content", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#ETAG" },
+ "CamelAlibabaOssETag": { "index": 3, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The entity tag (ETag) of the object, which identifies its
content. It is the MD5 hash of the content only for an object created by
PutObject.", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#ETAG" },
"CamelAlibabaOssContentMD5": { "index": 4, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The 128-bit Base64-encoded digest of the object",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_MD5" },
"CamelAlibabaOssObjectType": { "index": 5, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Shows whether the object is a file or a folder",
"constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#OBJECT_TYPE" },
"CamelAlibabaOssContentLength": { "index": 6, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The size of the object body in bytes", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_LENGTH" },
"CamelAlibabaOssContentType": { "index": 7, "kind": "header",
"displayName": "", "group": "consumer", "label": "consumer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The type of content stored in the object", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#CONTENT_TYPE" },
- "CamelFileName": { "index": 8, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the object with which the operation is to be
performed", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#FILE_NAME" }
+ "CamelFileName": { "index": 8, "kind": "header", "displayName": "",
"group": "consumer", "label": "consumer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the object. The consumer sets it for a consumed
object, and the producer for getObject.", "constantName":
"org.apache.camel.component.alibaba.oss.constants.OSSHeaders#FILE_NAME" }
},
"bodyTypes": {
"consumerOut": { "carriers": [ "bytes" ], "javaType": "byte[]",
"byOption": [ { "option": "includeBody", "value": "false", "carriers": [
"stream" ] } ], "description": "The content of the object as a byte array, one
message per object, with its bucket, key and metadata in headers. With
includeBody=false the stream of the content of the object, which is closed when
the exchange is done" },
@@ -47,23 +47,23 @@
"producerOut": { "carriers": [ "map" ], "byOption": [ { "option":
"operation", "value": "getObject", "carriers": [ "bytes" ], "javaType":
"byte[]" }, { "option": "operation", "value": "listObjects", "carriers": [
"list" ], "javaType": "java.util.List<java.util.Map<String, Object>>" }, {
"option": "operation", "value": "listBuckets", "carriers": [ "list" ],
"javaType": "java.util.List<java.util.Map<String, Object>>" } ], "description":
"A Map of the result for putObject, deleteObject, [...]
},
"properties": {
- "bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Name of bucket to perform operation on" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint
url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "OSS endpoint URL. Carries higher precedence
than region based client initialization" },
- "objectName": { "index": 2, "kind": "parameter", "displayName": "Object
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Name of object to perform operation with" },
- "region": { "index": 3, "kind": "parameter", "displayName": "Service
region", "group": "common", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "OSS service region" },
- "deleteAfterRead": { "index": 4, "kind": "parameter", "displayName":
"Delete after read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Determines if objects should be deleted after they have been retrieved" },
+ "bucketName": { "index": 0, "kind": "path", "displayName": "Bucket Name",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the bucket, or of the destination
bucket for copyObject. The CamelAlibabaOssBucketName exchange property replaces
this option for the producer, and a header of the same name replaces both." },
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint
url", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Object Storage Service, for
example oss-cn-hangzhou.aliyuncs.com. If not set, the SDK builds it from the
region option." },
+ "objectName": { "index": 2, "kind": "parameter", "displayName": "Object
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the object for the producer, or of
the destination object for copyObject. The CamelAlibabaOssObjectName exchange
property replaces this option, and a header of the same name replaces both." },
+ "region": { "index": 3, "kind": "parameter", "displayName": "Service
region", "group": "common", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Object Storage Service, for
example cn-hangzhou. The SDK uses it to sign requests, and to build the
endpoint when the endpoint option is not set." },
+ "deleteAfterRead": { "index": 4, "kind": "parameter", "displayName":
"Delete after read", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether to delete the object from the bucket after it is processed
successfully. If false, the consumer consumes the object again in a later
poll." },
"includeBody": { "index": 5, "kind": "parameter", "displayName": "Include
Body", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "If true, the content of
each consumed object is read into a byte array, which is the body. If false,
the body is the stream of the content of the object, which is closed when the
exchange is done. For large o [...]
- "maxMessagesPerPoll": { "index": 6, "kind": "parameter", "displayName":
"Maximum messages per poll", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 10, "description": "The
maximum number of messages to poll at each polling" },
- "prefix": { "index": 7, "kind": "parameter", "displayName": "Prefix",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The object name prefix used for filtering
objects to be listed" },
+ "maxMessagesPerPoll": { "index": 6, "kind": "parameter", "displayName":
"Maximum messages per poll", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 10, "description": "The
maximum number of objects that the consumer lists in one poll. Object Storage
Service accepts a value of at most 1000. The consumer treats a value of 0 or
less as 10." },
+ "prefix": { "index": 7, "kind": "parameter", "displayName": "Prefix",
"group": "consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The prefix of the names of the objects to
list, for the consumer and for listObjects. The CamelAlibabaOssPrefix exchange
property replaces this option for the producer, and a header of the same name
replaces both." },
"sendEmptyMessageWhenIdle": { "index": 8, "kind": "parameter",
"displayName": "Send Empty Message When Idle", "group": "consumer", "label":
"consumer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "If the polling consumer did not poll any files, you can
enable this option to send an empty message (no body) instead." },
"bridgeErrorHandler": { "index": 9, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
"exceptionHandler": { "index": 10, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 11, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "enum", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
"pollStrategy": { "index": 12, "kind": "parameter", "displayName": "Poll
Strategy", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false,
"autowired": false, "secret": false, "description": "A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the po
[...]
- "maxKeys": { "index": 13, "kind": "parameter", "displayName": "Max Keys",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The maximum number of keys returned
when listing objects" },
- "operation": { "index": 14, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "enum", "javaType": "java.lang.String", "enum": [ "listBuckets",
"listObjects", "putObject", "getObject", "deleteObject", "copyObject",
"headObject" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Operation to be performed" },
+ "maxKeys": { "index": 13, "kind": "parameter", "displayName": "Max Keys",
"group": "producer", "label": "consumer,producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "description": "The maximum number of objects that the
producer returns for listObjects, or all of them if no value is set. Object
Storage Service accepts a value of at most 1000. The CamelAlibabaOssMaxKeys
exchange property replaces [...]
+ "operation": { "index": 14, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "producer", "required": false,
"type": "enum", "javaType": "java.lang.String", "enum": [ "listBuckets",
"listObjects", "putObject", "getObject", "deleteObject", "copyObject",
"headObject" ], "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. The
CamelAlibabaOssOperation exchange property replaces this option, and a [...]
"lazyStartProducer": { "index": 15, "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 produ [...]
- "ossClient": { "index": 16, "kind": "parameter", "displayName": "OSS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sdk.service.oss2.OSSClient", "deprecated":
false, "autowired": true, "secret": false, "description": "An autowired OSS
client" },
+ "ossClient": { "index": 16, "kind": "parameter", "displayName": "OSS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sdk.service.oss2.OSSClient", "deprecated":
false, "autowired": true, "secret": false, "description": "To use a custom
com.aliyun.sdk.service.oss2.OSSClient. When this option is set or autowired,
the region, endpoint, accessKey, secretKey, and serviceKeys options are not
used. The Camel endpoint does not cl [...]
"backoffErrorThreshold": { "index": 17, "kind": "parameter",
"displayName": "Backoff Error Threshold", "group": "scheduler", "label":
"consumer,scheduler", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "description": "The
number of subsequent error polls (failed due some error) that should happen
before the backoffMultipler should kick-in." },
"backoffIdleThreshold": { "index": 18, "kind": "parameter", "displayName":
"Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "description": "The number of subsequent
idle polls that should happen before the backoffMultipler should kick-in." },
"backoffMultiplier": { "index": 19, "kind": "parameter", "displayName":
"Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "description": "To let the scheduled
polling consumer backoff if there has been a number of subsequent idles\/errors
in a row. The multiplier is then the number of polls that will be skipped
before the next actual attempt is h [...]
@@ -79,8 +79,8 @@
"startScheduler": { "index": 29, "kind": "parameter", "displayName":
"Start Scheduler", "group": "scheduler", "label": "consumer,scheduler",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Whether the scheduler should be auto started." },
"timeUnit": { "index": 30, "kind": "parameter", "displayName": "Time
Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false,
"type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [
"NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS",
"DAYS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and
delay options." },
"useFixedDelay": { "index": 31, "kind": "parameter", "displayName": "Use
Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in
JDK for details." },
- "accessKey": { "index": 32, "kind": "parameter", "displayName": "API
access key (AK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Access key for the cloud user" },
- "secretKey": { "index": 33, "kind": "parameter", "displayName": "API
secret key (SK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description":
"Secret key for the cloud user" },
- "serviceKeys": { "index": 34, "kind": "parameter", "displayName": "Service
Configuration", "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" }
+ "accessKey": { "index": 32, "kind": "parameter", "displayName": "API
access key (AK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
AccessKey ID of the AccessKey pair for Object Storage Service. If not set, the
accessKey of the serviceKeys option is used." },
+ "secretKey": { "index": 33, "kind": "parameter", "displayName": "API
secret key (SK)", "group": "security", "label": "security", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "description": "The
AccessKey secret of the AccessKey pair for Object Storage Service. If not set,
the secretKey of the serviceKeys option is used." },
+ "serviceKeys": { "index": 34, "kind": "parameter", "displayName": "Service
Configuration", "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 and
its secretKey are each used when the optio [...]
}
}
diff --git
a/components/camel-alibaba/camel-alibaba-oss/src/main/docs/alibaba-oss-component.adoc
b/components/camel-alibaba/camel-alibaba-oss/src/main/docs/alibaba-oss-component.adoc
index bb8b45190f5d..38c0dee6d8d9 100644
---
a/components/camel-alibaba/camel-alibaba-oss/src/main/docs/alibaba-oss-component.adoc
+++
b/components/camel-alibaba/camel-alibaba-oss/src/main/docs/alibaba-oss-component.adoc
@@ -2,7 +2,7 @@
:doctitle: Alibaba Object Storage Service (OSS)
:shortname: alibaba-oss
:artifactid: camel-alibaba-oss
-:description: Alibaba Cloud Object Storage Service (OSS) component
+:description: Store and retrieve objects in Alibaba Cloud Object Storage
Service (OSS).
:since: 4.23
:supportlevel: Preview
:tabs-sync-option:
diff --git
a/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java
b/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java
index be887500c500..d4beaf1fe5a3 100644
---
a/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java
+++
b/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java
@@ -33,7 +33,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.support.ScheduledPollEndpoint;
/**
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service (OSS).
*/
@UriEndpoint(firstVersion = "4.23.0", scheme = "alibaba-oss", title = "Alibaba
Object Storage Service (OSS)",
syntax = "alibaba-oss:bucketName",
@@ -68,51 +68,78 @@ import org.apache.camel.support.ScheduledPollEndpoint;
+ " listObjects and
listBuckets a List of a Map per object or bucket"))
public class OSSEndpoint extends ScheduledPollEndpoint {
- @UriPath(description = "Name of bucket to perform operation on",
displayName = "Bucket Name")
+ @UriPath(description = "The name of the bucket, or of the destination
bucket for copyObject. The CamelAlibabaOssBucketName"
+ + " exchange property replaces this option for the
producer, and a header of the same name replaces"
+ + " both.",
+ displayName = "Bucket Name")
private String bucketName;
- @UriParam(description = "Operation to be performed", displayName =
"Operation", label = "producer",
+ @UriParam(description = "The operation that the producer performs. The
CamelAlibabaOssOperation exchange property replaces"
+ + " this option, and a header of the same name
replaces both.",
+ displayName = "Operation", label = "producer",
enums =
"listBuckets,listObjects,putObject,getObject,deleteObject,copyObject,headObject")
private String operation;
- @UriParam(description = "OSS service region", displayName = "Service
region")
+ @UriParam(description = "The region ID of Object Storage Service, for
example cn-hangzhou. The SDK uses it to sign"
+ + " requests, and to build the endpoint when the
endpoint option is not set.",
+ displayName = "Service region")
@Metadata(required = true)
private String region;
- @UriParam(description = "OSS endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Object Storage Service, for
example oss-cn-hangzhou.aliyuncs.com. If not set, the"
+ + " SDK builds it from the region option.",
displayName = "Endpoint url")
private String endpoint;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Configuration",
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its"
+ + " accessKey and its secretKey are each used when
the option of the same name is not set.",
+ displayName = "Service Configuration",
security = "secret", label = "security")
private ServiceKeys serviceKeys;
- @UriParam(description = "Access key for the cloud user", displayName =
"API access key (AK)", security = "secret",
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for Object
Storage Service. If not set, the accessKey of"
+ + " the serviceKeys option is used.",
+ displayName = "API access key (AK)", security = "secret",
label = "security")
@Metadata(required = true)
private String accessKey;
- @UriParam(description = "Secret key for the cloud user", displayName =
"API secret key (SK)", security = "secret",
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
Object Storage Service. If not set, the secretKey"
+ + " of the serviceKeys option is used.",
+ displayName = "API secret key (SK)", security = "secret",
label = "security")
@Metadata(required = true)
private String secretKey;
- @UriParam(description = "Name of object to perform operation with",
displayName = "Object Name")
+ @UriParam(description = "The name of the object for the producer, or of
the destination object for copyObject. The"
+ + " CamelAlibabaOssObjectName exchange property
replaces this option, and a header of the same name"
+ + " replaces both.",
+ displayName = "Object Name")
private String objectName;
- @UriParam(description = "The object name prefix used for filtering objects
to be listed", displayName = "Prefix",
+ @UriParam(description = "The prefix of the names of the objects to list,
for the consumer and for listObjects. The"
+ + " CamelAlibabaOssPrefix exchange property
replaces this option for the producer, and a header of"
+ + " the same name replaces both.",
+ displayName = "Prefix",
label = "consumer")
private String prefix;
- @UriParam(description = "The maximum number of keys returned when listing
objects", displayName = "Max Keys",
+ @UriParam(description = "The maximum number of objects that the producer
returns for listObjects, or all of them if no"
+ + " value is set. Object Storage Service accepts a
value of at most 1000. The"
+ + " CamelAlibabaOssMaxKeys exchange property
replaces this option, and a header of the same name"
+ + " replaces both.",
+ displayName = "Max Keys",
label = "consumer,producer")
private Integer maxKeys;
- @UriParam(description = "Determines if objects should be deleted after
they have been retrieved",
+ @UriParam(description = "Whether to delete the object from the bucket
after it is processed successfully. If false, the"
+ + " consumer consumes the object again in a later
poll.",
displayName = "Delete after read", defaultValue = "false", label
= "consumer")
private boolean deleteAfterRead;
- @UriParam(description = "The maximum number of messages to poll at each
polling", displayName = "Maximum messages per poll",
+ @UriParam(description = "The maximum number of objects that the consumer
lists in one poll. Object Storage Service accepts"
+ + " a value of at most 1000. The consumer treats a
value of 0 or less as 10.",
+ displayName = "Maximum messages per poll",
defaultValue = "10", label = "consumer")
private int maxMessagesPerPoll = 10;
@@ -123,7 +150,10 @@ public class OSSEndpoint extends ScheduledPollEndpoint {
displayName = "Include Body", defaultValue = "true", label =
"consumer")
private boolean includeBody = true;
- @UriParam(description = "An autowired OSS client", displayName = "OSS
Client", label = "advanced")
+ @UriParam(description = "To use a custom
com.aliyun.sdk.service.oss2.OSSClient. When this option is set or autowired,
the"
+ + " region, endpoint, accessKey, secretKey, and
serviceKeys options are not used. The Camel"
+ + " endpoint does not close a client that is set
or autowired.",
+ displayName = "OSS Client", label = "advanced")
@Metadata(autowired = true)
private volatile OSSClient ossClient;
diff --git
a/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/constants/OSSHeaders.java
b/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/constants/OSSHeaders.java
index ff74e1ece27c..6e2653f3b300 100644
---
a/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/constants/OSSHeaders.java
+++
b/components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/constants/OSSHeaders.java
@@ -23,13 +23,18 @@ import org.apache.camel.spi.Metadata;
* Constants for the exchange headers when consuming objects
*/
public final class OSSHeaders {
- @Metadata(label = "consumer", description = "Name of the bucket where
object is contained", javaType = "String")
+ @Metadata(label = "consumer", description = "The name of the bucket. The
consumer sets it for a consumed object, and the"
+ + " producer for getObject. An
exchange property of the same name replaces the"
+ + " bucketName option for the
producer, and this header replaces both.",
+ javaType = "String")
public static final String BUCKET_NAME = "CamelAlibabaOssBucketName";
@Metadata(label = "consumer", description = "The key that the object is
stored under", javaType = "String")
public static final String OBJECT_KEY = "CamelAlibabaOssObjectKey";
@Metadata(label = "consumer", description = "The date and time that the
object was last modified", javaType = "String")
public static final String LAST_MODIFIED = "CamelAlibabaOssLastModified";
- @Metadata(label = "consumer", description = "The 128-bit MD5 digest of the
object content", javaType = "String")
+ @Metadata(label = "consumer", description = "The entity tag (ETag) of the
object, which identifies its content. It is the"
+ + " MD5 hash of the content
only for an object created by PutObject.",
+ javaType = "String")
public static final String ETAG = "CamelAlibabaOssETag";
@Metadata(label = "consumer", description = "The 128-bit Base64-encoded
digest of the object", javaType = "String")
public static final String CONTENT_MD5 = "CamelAlibabaOssContentMD5";
@@ -39,7 +44,8 @@ public final class OSSHeaders {
public static final String CONTENT_LENGTH = "CamelAlibabaOssContentLength";
@Metadata(label = "consumer", description = "The type of content stored in
the object", javaType = "String")
public static final String CONTENT_TYPE = "CamelAlibabaOssContentType";
- @Metadata(label = "consumer", description = "Name of the object with which
the operation is to be performed",
+ @Metadata(label = "consumer", description = "The name of the object. The
consumer sets it for a consumed object, and the"
+ + " producer for getObject.",
javaType = "String")
public static final String FILE_NAME = Exchange.FILE_NAME;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index 4404df801b99..65c4b8de31b6 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -183,7 +183,7 @@ public interface ComponentsBuilderFactory {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
(OSS).
*
* Category: cloud
* Since: 4.23
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaOssComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaOssComponentBuilderFactory.java
index dbfdcc11b01b..0d74c8402f29 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaOssComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaOssComponentBuilderFactory.java
@@ -24,7 +24,7 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.component.alibaba.oss.OSSComponent;
/**
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service (OSS).
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +33,7 @@ public interface AlibabaOssComponentBuilderFactory {
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
(OSS).
*
* Category: cloud
* Since: 4.23
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
index da76859eca3c..2d9d252c0c1c 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
@@ -163,7 +163,7 @@ public class EndpointHeaderBuilders {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
(OSS).
*
* Category: cloud
* Since: 4.23
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 b5a0129b8ac8..7cfa6c2ad179 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
@@ -500,7 +500,7 @@ public class StaticEndpointBuilders {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
(OSS).
*
* Category: cloud
* Since: 4.23
@@ -509,7 +509,9 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-oss:bucketName</code>
*
* Path parameter: bucketName
- * Name of bucket to perform operation on
+ * The name of the bucket, or of the destination bucket for copyObject. The
+ * CamelAlibabaOssBucketName exchange property replaces this option for the
+ * producer, and a header of the same name replaces both.
*
* @param path bucketName
* @return the dsl builder
@@ -519,7 +521,7 @@ public class StaticEndpointBuilders {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
(OSS).
*
* Category: cloud
* Since: 4.23
@@ -528,7 +530,9 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-oss:bucketName</code>
*
* Path parameter: bucketName
- * Name of bucket to perform operation on
+ * The name of the bucket, or of the destination bucket for copyObject. The
+ * CamelAlibabaOssBucketName exchange property replaces this option for the
+ * producer, and a header of the same name replaces both.
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OSSEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OSSEndpointBuilderFactory.java
index 6ef2e101af25..b1eb28b96f26 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OSSEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/OSSEndpointBuilderFactory.java
@@ -27,7 +27,7 @@ import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
/**
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service (OSS).
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -44,8 +44,9 @@ public interface OSSEndpointBuilderFactory {
return (AdvancedOSSEndpointConsumerBuilder) this;
}
/**
- * OSS endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of Object Storage Service, for example
+ * oss-cn-hangzhou.aliyuncs.com. If not set, the SDK builds it from the
+ * region option.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -59,7 +60,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Name of object to perform operation with.
+ * The name of the object for the producer, or of the destination
object
+ * for copyObject. The CamelAlibabaOssObjectName exchange property
+ * replaces this option, and a header of the same name replaces both.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -73,7 +76,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * OSS service region.
+ * The region ID of Object Storage Service, for example cn-hangzhou.
The
+ * SDK uses it to sign requests, and to build the endpoint when the
+ * endpoint option is not set.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -88,8 +93,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Determines if objects should be deleted after they have been
- * retrieved.
+ * Whether to delete the object from the bucket after it is processed
+ * successfully. If false, the consumer consumes the object again in a
+ * later poll.
*
* The option is a: <code>boolean</code> type.
*
@@ -104,8 +110,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Determines if objects should be deleted after they have been
- * retrieved.
+ * Whether to delete the object from the bucket after it is processed
+ * successfully. If false, the consumer consumes the object again in a
+ * later poll.
*
* The option will be converted to a <code>boolean</code> type.
*
@@ -160,7 +167,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * The maximum number of messages to poll at each polling.
+ * The maximum number of objects that the consumer lists in one poll.
+ * Object Storage Service accepts a value of at most 1000. The consumer
+ * treats a value of 0 or less as 10.
*
* The option is a: <code>int</code> type.
*
@@ -175,7 +184,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * The maximum number of messages to poll at each polling.
+ * The maximum number of objects that the consumer lists in one poll.
+ * Object Storage Service accepts a value of at most 1000. The consumer
+ * treats a value of 0 or less as 10.
*
* The option will be converted to a <code>int</code> type.
*
@@ -190,7 +201,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * The object name prefix used for filtering objects to be listed.
+ * The prefix of the names of the objects to list, for the consumer and
+ * for listObjects. The CamelAlibabaOssPrefix exchange property
replaces
+ * this option for the producer, and a header of the same name replaces
+ * both.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -735,7 +749,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for Object Storage Service.
If
+ * not set, the accessKey of the serviceKeys option is used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -750,7 +765,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for Object Storage
+ * Service. If not set, the secretKey of the serviceKeys option is
used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -765,7 +781,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -780,7 +799,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -959,7 +981,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option is a: <code>com.aliyun.sdk.service.oss2.OSSClient</code>
* type.
@@ -974,7 +999,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option will be converted to a
* <code>com.aliyun.sdk.service.oss2.OSSClient</code> type.
@@ -1001,8 +1029,9 @@ public interface OSSEndpointBuilderFactory {
}
/**
- * OSS endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of Object Storage Service, for example
+ * oss-cn-hangzhou.aliyuncs.com. If not set, the SDK builds it from the
+ * region option.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1016,7 +1045,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Name of object to perform operation with.
+ * The name of the object for the producer, or of the destination
object
+ * for copyObject. The CamelAlibabaOssObjectName exchange property
+ * replaces this option, and a header of the same name replaces both.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1030,7 +1061,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * OSS service region.
+ * The region ID of Object Storage Service, for example cn-hangzhou.
The
+ * SDK uses it to sign requests, and to build the endpoint when the
+ * endpoint option is not set.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1045,7 +1078,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Operation to be performed.
+ * The operation that the producer performs. The
+ * CamelAlibabaOssOperation exchange property replaces this option, and
+ * a header of the same name replaces both.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1059,7 +1094,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for Object Storage Service.
If
+ * not set, the accessKey of the serviceKeys option is used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1074,7 +1110,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for Object Storage
+ * Service. If not set, the secretKey of the serviceKeys option is
used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1089,7 +1126,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -1104,7 +1144,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -1175,7 +1218,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option is a: <code>com.aliyun.sdk.service.oss2.OSSClient</code>
* type.
@@ -1190,7 +1236,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option will be converted to a
* <code>com.aliyun.sdk.service.oss2.OSSClient</code> type.
@@ -1218,8 +1267,9 @@ public interface OSSEndpointBuilderFactory {
}
/**
- * OSS endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of Object Storage Service, for example
+ * oss-cn-hangzhou.aliyuncs.com. If not set, the SDK builds it from the
+ * region option.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1233,7 +1283,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Name of object to perform operation with.
+ * The name of the object for the producer, or of the destination
object
+ * for copyObject. The CamelAlibabaOssObjectName exchange property
+ * replaces this option, and a header of the same name replaces both.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1247,7 +1299,9 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * OSS service region.
+ * The region ID of Object Storage Service, for example cn-hangzhou.
The
+ * SDK uses it to sign requests, and to build the endpoint when the
+ * endpoint option is not set.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1262,7 +1316,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for Object Storage Service.
If
+ * not set, the accessKey of the serviceKeys option is used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1277,7 +1332,8 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for Object Storage
+ * Service. If not set, the secretKey of the serviceKeys option is
used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1292,7 +1348,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -1307,7 +1366,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey and its secretKey are each used when the option of the
same
+ * name is not set.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -1335,7 +1397,10 @@ public interface OSSEndpointBuilderFactory {
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option is a: <code>com.aliyun.sdk.service.oss2.OSSClient</code>
* type.
@@ -1350,7 +1415,10 @@ public interface OSSEndpointBuilderFactory {
return this;
}
/**
- * An autowired OSS client.
+ * To use a custom com.aliyun.sdk.service.oss2.OSSClient. When this
+ * option is set or autowired, the region, endpoint, accessKey,
+ * secretKey, and serviceKeys options are not used. The Camel endpoint
+ * does not close a client that is set or autowired.
*
* The option will be converted to a
* <code>com.aliyun.sdk.service.oss2.OSSClient</code> type.
@@ -1369,7 +1437,8 @@ public interface OSSEndpointBuilderFactory {
public interface OSSBuilders {
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
+ * (OSS).
*
* Category: cloud
* Since: 4.23
@@ -1382,7 +1451,8 @@ public interface OSSEndpointBuilderFactory {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
+ * (OSS).
*
* Category: cloud
* Since: 4.23
@@ -1391,7 +1461,9 @@ public interface OSSEndpointBuilderFactory {
* Syntax: <code>alibaba-oss:bucketName</code>
*
* Path parameter: bucketName
- * Name of bucket to perform operation on
+ * The name of the bucket, or of the destination bucket for copyObject.
+ * The CamelAlibabaOssBucketName exchange property replaces this option
+ * for the producer, and a header of the same name replaces both.
*
* @param path bucketName
* @return the dsl builder
@@ -1401,7 +1473,8 @@ public interface OSSEndpointBuilderFactory {
}
/**
* Alibaba Object Storage Service (OSS) (camel-alibaba-oss)
- * Alibaba Cloud Object Storage Service (OSS) component
+ * Store and retrieve objects in Alibaba Cloud Object Storage Service
+ * (OSS).
*
* Category: cloud
* Since: 4.23
@@ -1410,7 +1483,9 @@ public interface OSSEndpointBuilderFactory {
* Syntax: <code>alibaba-oss:bucketName</code>
*
* Path parameter: bucketName
- * Name of bucket to perform operation on
+ * The name of the bucket, or of the destination bucket for copyObject.
+ * The CamelAlibabaOssBucketName exchange property replaces this option
+ * for the producer, and a header of the same name replaces both.
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
@@ -1433,7 +1508,10 @@ public interface OSSEndpointBuilderFactory {
public static final OSSHeaderNameBuilder INSTANCE = new
OSSHeaderNameBuilder();
/**
- * Name of the bucket where object is contained.
+ * The name of the bucket. The consumer sets it for a consumed object,
+ * and the producer for getObject. An exchange property of the same
name
+ * replaces the bucketName option for the producer, and this header
+ * replaces both.
*
* The option is a: {@code String} type.
*
@@ -1469,7 +1547,9 @@ public interface OSSEndpointBuilderFactory {
return "CamelAlibabaOssLastModified";
}
/**
- * The 128-bit MD5 digest of the object content.
+ * The entity tag (ETag) of the object, which identifies its content.
It
+ * is the MD5 hash of the content only for an object created by
+ * PutObject.
*
* The option is a: {@code String} type.
*
@@ -1529,7 +1609,8 @@ public interface OSSEndpointBuilderFactory {
return "CamelAlibabaOssContentType";
}
/**
- * Name of the object with which the operation is to be performed.
+ * The name of the object. The consumer sets it for a consumed object,
+ * and the producer for getObject.
*
* The option is a: {@code String} type.
*
diff --git a/tasks/component-descriptions.md b/tasks/component-descriptions.md
index 58d00152e9ff..9d11d365b24e 100644
--- a/tasks/component-descriptions.md
+++ b/tasks/component-descriptions.md
@@ -62,7 +62,7 @@ or removes its row.
| camel-alibaba-fc | alibaba-fc | yes |
| camel-alibaba-kms | alibaba-kms | yes |
| camel-alibaba-mns | alibaba-mns | yes |
-| camel-alibaba-oss | alibaba-oss | |
+| camel-alibaba-oss | alibaba-oss | yes |
| camel-alibaba-ots | alibaba-ots | yes |
| camel-alibaba-sls | alibaba-sls | yes |
| camel-alibaba-sms | alibaba-sms | yes |