http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-s3-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc new file mode 100644 index 0000000..d8bb7e2 --- /dev/null +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -0,0 +1,299 @@ +[[AWS-S3-S3Component]] +S3 Component +~~~~~~~~~~~~ + +*Available as of Camel 2.8* + +The S3 component supports storing and retrieving objetcs from/to +http://aws.amazon.com/s3[Amazon's S3] service. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon S3. More information are available at +http://aws.amazon.com/s3[Amazon S3]. + +[[AWS-S3-URIFormat]] +URI Format +^^^^^^^^^^ + +[source,java] +------------------------------ +aws-s3://bucketNameOrArn[?options] +------------------------------ + +The bucket will be created if it don't already exists. + + You can append query options to the URI in the following format, +?options=value&option2=value&... + +[[AWS-S3-URIOptions]] +URI Options +^^^^^^^^^^^ + + +// component options: START +The AWS S3 Storage Service component has no options. +// component options: END + + + + + + + + + + + +// endpoint options: START +The AWS S3 Storage Service component supports 40 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| bucketNameOrArn | common | | String | *Required* Bucket name or ARN +| accessKey | common | | String | Amazon AWS Access Key +| amazonS3Client | common | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. +| amazonS3Endpoint | common | | String | The region with which the AWS-S3 client wants to work with. +| pathStyleAccess | common | false | boolean | Whether or not the S3 client should use path style access +| policy | common | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. +| proxyHost | common | | String | Camel 2.16: To define a proxy host when instantiating the SQS client +| proxyPort | common | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. +| secretKey | common | | String | Amazon AWS Secret Key +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| deleteAfterRead | consumer | true | boolean | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. +| fileName | consumer | | String | To get the object from the bucket with the given file name +| includeBody | consumer | true | boolean | Camel 2.17: If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. +| maxMessagesPerPoll | consumer | 10 | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. +| prefix | consumer | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. +| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. +| deleteAfterWrite | producer | false | boolean | Camel 2.11.0: Delete file object after the S3 file has been uploaded +| multiPartUpload | producer | false | boolean | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize +| operation | producer | | S3Operations | Camel 2.18: The operation to do in case the user don't want to do only an upload +| partSize | producer | 26214400 | long | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M. +| region | producer | | String | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. +| serverSideEncryption | producer | | String | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. +| storageClass | producer | | String | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. +| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. +| backoffMultiplier | scheduler | | int | 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 happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. +| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. +| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. +| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. +| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component +| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. +| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. +| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. +| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +|======================================================================= +{% endraw %} +// endpoint options: END + + + + + + + + + +Required S3 component options + +You have to provide the amazonS3Client in the +link:registry.html[Registry] or your accessKey and secretKey to access +the http://aws.amazon.com/s3[Amazon's S3]. + +[[AWS-S3-BatchConsumer]] +Batch Consumer +^^^^^^^^^^^^^^ + +This component implements the link:batch-consumer.html[Batch Consumer]. + +This allows you for instance to know how many messages exists in this +batch and for instance let the link:aggregator.html[Aggregator] +aggregate this number of messages. + +[[AWS-S3-Usage]] +Usage +^^^^^ + +[[AWS-S3-MessageheadersevaluatedbytheS3producer]] +Message headers evaluated by the S3 producer +++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsS3BucketName` |`String` |The bucket Name which this object will be stored or which will be used for the current operation + +|`CamelAwsS3BucketDestinationName` |`String` |*Camel 2.18*: The bucket Destination Name which will be used for the current operation + +|`CamelAwsS3ContentLength` |`Long` |The content length of this object. + +|`CamelAwsS3ContentType` |`String` |The content type of this object. + +|`CamelAwsS3ContentControl` |`String` |*Camel 2.8.2:* The content control of this object. + +|`CamelAwsS3ContentDisposition` |`String` |*Camel 2.8.2:* The content disposition of this object. + +|`CamelAwsS3ContentEncoding` |`String` |*Camel 2.8.2:* The content encoding of this object. + +|`CamelAwsS3ContentMD5` |`String` |*Camel 2.8.2:* The md5 checksum of this object. + +|`CamelAwsS3DestinationKey` |`String` |*Camel 2.18*:The Destination key which will be used for the current operation + +|`CamelAwsS3Key` |`String` |The key under which this object will be stored or which will be used for the current operation + +|`CamelAwsS3LastModified` |`java.util.Date` |*Camel 2.8.2:* The last modified timestamp of this object. + +|`CamelAwsS3Operation` |`String` |*Camel 2.18*: The operation to perform + +|`CamelAwsS3StorageClass` |`String` |*Camel 2.8.4:* The storage class of this object. + +|`CamelAwsS3CannedAcl` |`String` |*Camel 2.11.0:* The canned acl that will be applied to the object. see +`com.amazonaws.services.s3.model.CannedAccessControlList` for allowed +values. + +|`CamelAwsS3Acl` |`com.amazonaws.services.s3.model.AccessControlList` |*Camel 2.11.0:* a well constructed Amazon S3 Access Control List object. +see `com.amazonaws.services.s3.model.AccessControlList` for more details + +|`CamelAwsS3Headers` |`Map<String,String>` |*Camel 2.15.0*: support to get or set custom objectMetadata headers. + +|`CamelAwsS3ServerSideEncryption` |String |*Camel 2.16:* Sets the server-side encryption algorithm when encrypting +the object using AWS-managed keys. For example use AES256. + +|`CamelAwsS3VersionId` |`String` |The version Id of the object to be stored or returned from the current operation +|======================================================================= + +[[AWS-S3-MessageheaderssetbytheS3producer]] +Message headers set by the S3 producer +++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description +|`CamelAwsS3ETag` |`String` |The ETag value for the newly uploaded object. + +|`CamelAwsS3VersionId` |`String` |The *optional* version ID of the newly uploaded object. + +|======================================================================= + +[[AWS-S3-MessageheaderssetbytheS3consumer]] +Message headers set by the S3 consumer +++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsS3Key` |`String` |The key under which this object is stored. + +|`CamelAwsS3BucketName` |`String` |The name of the bucket in which this object is contained. + +|`CamelAwsS3ETag` |`String` |The hex encoded 128-bit MD5 digest of the associated object according to +RFC 1864. This data is used as an integrity check to verify that the +data received by the caller is the same data that was sent by Amazon S3. + +|`CamelAwsS3LastModified` |`Date` |The value of the Last-Modified header, indicating the date and time at +which Amazon S3 last recorded a modification to the associated object. + +|`CamelAwsS3VersionId` |`String` |The version ID of the associated Amazon S3 object if available. Version +IDs are only assigned to objects when an object is uploaded to an Amazon +S3 bucket that has object versioning enabled. + +|`CamelAwsS3ContentType` |`String` |The Content-Type HTTP header, which indicates the type of content stored +in the associated object. The value of this header is a standard MIME +type. + +|`CamelAwsS3ContentMD5` |`String` |The base64 encoded 128-bit MD5 digest of the associated object (content +- not including headers) according to RFC 1864. This data is used as a +message integrity check to verify that the data received by Amazon S3 is +the same data that the caller sent. + +|`CamelAwsS3ContentLength` |`Long` |The Content-Length HTTP header indicating the size of the associated +object in bytes. + +|`CamelAwsS3ContentEncoding` |`String` |The *optional* Content-Encoding HTTP header specifying what content +encodings have been applied to the object and what decoding mechanisms +must be applied in order to obtain the media-type referenced by the +Content-Type field. + +|`CamelAwsS3ContentDisposition` |`String` |The *optional* Content-Disposition HTTP header, which specifies +presentational information such as the recommended filename for the +object to be saved as. + +|`CamelAwsS3ContentControl` |`String` |The *optional* Cache-Control HTTP header which allows the user to +specify caching behavior along the HTTP request/reply chain. + +|`CamelAwsS3ServerSideEncryption` |String |*Camel 2.16:* The server-side encryption algorithm when encrypting the +object using AWS-managed keys. +|======================================================================= + +[[AWS-S3-AdvancedAmazonS3configuration]] +Advanced AmazonS3 configuration ++++++++++++++++++++++++++++++++ + +If your Camel Application is running behind a firewall or if you need to +have more control over the `AmazonS3` instance configuration, you can +create your own instance: + +[source,java] +-------------------------------------------------------------------------------------- +AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); + +ClientConfiguration clientConfiguration = new ClientConfiguration(); +clientConfiguration.setProxyHost("http://myProxyHost";); +clientConfiguration.setProxyPort(8080); + +AmazonS3 client = new AmazonS3Client(awsCredentials, clientConfiguration); + +registry.bind("client", client); +-------------------------------------------------------------------------------------- + +and refer to it in your Camel aws-s3 component configuration: + +[source,java] +-------------------------------------------------------------------------------- +from("aws-s3://MyBucket?amazonS3Client=#client&delay=5000&maxMessagesPerPoll=5") +.to("mock:result"); +-------------------------------------------------------------------------------- + +[[AWS-S3-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `${camel-version`} must be replaced by the actual version of Camel +(2.8 or higher). + +[[AWS-S3-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:aws.html[AWS Component] +
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-s3.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-s3.adoc b/components/camel-aws/src/main/docs/aws-s3.adoc deleted file mode 100644 index d8bb7e2..0000000 --- a/components/camel-aws/src/main/docs/aws-s3.adoc +++ /dev/null @@ -1,299 +0,0 @@ -[[AWS-S3-S3Component]] -S3 Component -~~~~~~~~~~~~ - -*Available as of Camel 2.8* - -The S3 component supports storing and retrieving objetcs from/to -http://aws.amazon.com/s3[Amazon's S3] service. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon S3. More information are available at -http://aws.amazon.com/s3[Amazon S3]. - -[[AWS-S3-URIFormat]] -URI Format -^^^^^^^^^^ - -[source,java] ------------------------------- -aws-s3://bucketNameOrArn[?options] ------------------------------- - -The bucket will be created if it don't already exists. + - You can append query options to the URI in the following format, -?options=value&option2=value&... - -[[AWS-S3-URIOptions]] -URI Options -^^^^^^^^^^^ - - -// component options: START -The AWS S3 Storage Service component has no options. -// component options: END - - - - - - - - - - - -// endpoint options: START -The AWS S3 Storage Service component supports 40 endpoint options which are listed below: - -{% raw %} -[width="100%",cols="2s,1,1m,1m,5",options="header"] -|======================================================================= -| Name | Group | Default | Java Type | Description -| bucketNameOrArn | common | | String | *Required* Bucket name or ARN -| accessKey | common | | String | Amazon AWS Access Key -| amazonS3Client | common | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. -| amazonS3Endpoint | common | | String | The region with which the AWS-S3 client wants to work with. -| pathStyleAccess | common | false | boolean | Whether or not the S3 client should use path style access -| policy | common | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. -| proxyHost | common | | String | Camel 2.16: To define a proxy host when instantiating the SQS client -| proxyPort | common | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. -| secretKey | common | | String | Amazon AWS Secret Key -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. -| deleteAfterRead | consumer | true | boolean | Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs the object is not deleted. If this option is false then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. -| fileName | consumer | | String | To get the object from the bucket with the given file name -| includeBody | consumer | true | boolean | Camel 2.17: If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null. -| maxMessagesPerPoll | consumer | 10 | int | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited but use 0 or negative number to disable it as unlimited. -| prefix | consumer | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| deleteAfterWrite | producer | false | boolean | Camel 2.11.0: Delete file object after the S3 file has been uploaded -| multiPartUpload | producer | false | boolean | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize -| operation | producer | | S3Operations | Camel 2.18: The operation to do in case the user don't want to do only an upload -| partSize | producer | 26214400 | long | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M. -| region | producer | | String | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. -| serverSideEncryption | producer | | String | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. -| storageClass | producer | | String | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. -| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | int | 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 happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. -| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. -| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. -| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. -|======================================================================= -{% endraw %} -// endpoint options: END - - - - - - - - - -Required S3 component options - -You have to provide the amazonS3Client in the -link:registry.html[Registry] or your accessKey and secretKey to access -the http://aws.amazon.com/s3[Amazon's S3]. - -[[AWS-S3-BatchConsumer]] -Batch Consumer -^^^^^^^^^^^^^^ - -This component implements the link:batch-consumer.html[Batch Consumer]. - -This allows you for instance to know how many messages exists in this -batch and for instance let the link:aggregator.html[Aggregator] -aggregate this number of messages. - -[[AWS-S3-Usage]] -Usage -^^^^^ - -[[AWS-S3-MessageheadersevaluatedbytheS3producer]] -Message headers evaluated by the S3 producer -++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsS3BucketName` |`String` |The bucket Name which this object will be stored or which will be used for the current operation - -|`CamelAwsS3BucketDestinationName` |`String` |*Camel 2.18*: The bucket Destination Name which will be used for the current operation - -|`CamelAwsS3ContentLength` |`Long` |The content length of this object. - -|`CamelAwsS3ContentType` |`String` |The content type of this object. - -|`CamelAwsS3ContentControl` |`String` |*Camel 2.8.2:* The content control of this object. - -|`CamelAwsS3ContentDisposition` |`String` |*Camel 2.8.2:* The content disposition of this object. - -|`CamelAwsS3ContentEncoding` |`String` |*Camel 2.8.2:* The content encoding of this object. - -|`CamelAwsS3ContentMD5` |`String` |*Camel 2.8.2:* The md5 checksum of this object. - -|`CamelAwsS3DestinationKey` |`String` |*Camel 2.18*:The Destination key which will be used for the current operation - -|`CamelAwsS3Key` |`String` |The key under which this object will be stored or which will be used for the current operation - -|`CamelAwsS3LastModified` |`java.util.Date` |*Camel 2.8.2:* The last modified timestamp of this object. - -|`CamelAwsS3Operation` |`String` |*Camel 2.18*: The operation to perform - -|`CamelAwsS3StorageClass` |`String` |*Camel 2.8.4:* The storage class of this object. - -|`CamelAwsS3CannedAcl` |`String` |*Camel 2.11.0:* The canned acl that will be applied to the object. see -`com.amazonaws.services.s3.model.CannedAccessControlList` for allowed -values. - -|`CamelAwsS3Acl` |`com.amazonaws.services.s3.model.AccessControlList` |*Camel 2.11.0:* a well constructed Amazon S3 Access Control List object. -see `com.amazonaws.services.s3.model.AccessControlList` for more details - -|`CamelAwsS3Headers` |`Map<String,String>` |*Camel 2.15.0*: support to get or set custom objectMetadata headers. - -|`CamelAwsS3ServerSideEncryption` |String |*Camel 2.16:* Sets the server-side encryption algorithm when encrypting -the object using AWS-managed keys. For example use AES256. - -|`CamelAwsS3VersionId` |`String` |The version Id of the object to be stored or returned from the current operation -|======================================================================= - -[[AWS-S3-MessageheaderssetbytheS3producer]] -Message headers set by the S3 producer -++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description -|`CamelAwsS3ETag` |`String` |The ETag value for the newly uploaded object. - -|`CamelAwsS3VersionId` |`String` |The *optional* version ID of the newly uploaded object. - -|======================================================================= - -[[AWS-S3-MessageheaderssetbytheS3consumer]] -Message headers set by the S3 consumer -++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsS3Key` |`String` |The key under which this object is stored. - -|`CamelAwsS3BucketName` |`String` |The name of the bucket in which this object is contained. - -|`CamelAwsS3ETag` |`String` |The hex encoded 128-bit MD5 digest of the associated object according to -RFC 1864. This data is used as an integrity check to verify that the -data received by the caller is the same data that was sent by Amazon S3. - -|`CamelAwsS3LastModified` |`Date` |The value of the Last-Modified header, indicating the date and time at -which Amazon S3 last recorded a modification to the associated object. - -|`CamelAwsS3VersionId` |`String` |The version ID of the associated Amazon S3 object if available. Version -IDs are only assigned to objects when an object is uploaded to an Amazon -S3 bucket that has object versioning enabled. - -|`CamelAwsS3ContentType` |`String` |The Content-Type HTTP header, which indicates the type of content stored -in the associated object. The value of this header is a standard MIME -type. - -|`CamelAwsS3ContentMD5` |`String` |The base64 encoded 128-bit MD5 digest of the associated object (content -- not including headers) according to RFC 1864. This data is used as a -message integrity check to verify that the data received by Amazon S3 is -the same data that the caller sent. - -|`CamelAwsS3ContentLength` |`Long` |The Content-Length HTTP header indicating the size of the associated -object in bytes. - -|`CamelAwsS3ContentEncoding` |`String` |The *optional* Content-Encoding HTTP header specifying what content -encodings have been applied to the object and what decoding mechanisms -must be applied in order to obtain the media-type referenced by the -Content-Type field. - -|`CamelAwsS3ContentDisposition` |`String` |The *optional* Content-Disposition HTTP header, which specifies -presentational information such as the recommended filename for the -object to be saved as. - -|`CamelAwsS3ContentControl` |`String` |The *optional* Cache-Control HTTP header which allows the user to -specify caching behavior along the HTTP request/reply chain. - -|`CamelAwsS3ServerSideEncryption` |String |*Camel 2.16:* The server-side encryption algorithm when encrypting the -object using AWS-managed keys. -|======================================================================= - -[[AWS-S3-AdvancedAmazonS3configuration]] -Advanced AmazonS3 configuration -+++++++++++++++++++++++++++++++ - -If your Camel Application is running behind a firewall or if you need to -have more control over the `AmazonS3` instance configuration, you can -create your own instance: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); - -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonS3 client = new AmazonS3Client(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -and refer to it in your Camel aws-s3 component configuration: - -[source,java] --------------------------------------------------------------------------------- -from("aws-s3://MyBucket?amazonS3Client=#client&delay=5000&maxMessagesPerPoll=5") -.to("mock:result"); --------------------------------------------------------------------------------- - -[[AWS-S3-Dependencies]] -Dependencies -^^^^^^^^^^^^ - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `${camel-version`} must be replaced by the actual version of Camel -(2.8 or higher). - -[[AWS-S3-SeeAlso]] -See Also -^^^^^^^^ - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - -* link:aws.html[AWS Component] - http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-sdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sdb-component.adoc b/components/camel-aws/src/main/docs/aws-sdb-component.adoc new file mode 100644 index 0000000..37d6a0b --- /dev/null +++ b/components/camel-aws/src/main/docs/aws-sdb-component.adoc @@ -0,0 +1,237 @@ +[[AWS-SDB-SDBComponent]] +SDB Component +~~~~~~~~~~~~~ + +*Available as of Camel 2.8.4* + +The sdb component supports storing and retrieving data from/to +http://aws.amazon.com/sdb[Amazon's SDB] service. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon SDB. More information are available at +http://aws.amazon.com/sdb[Amazon SDB]. + +[[AWS-SDB-URIFormat]] +URI Format +^^^^^^^^^^ + +[source,java] +------------------------------ +aws-sdb://domainName[?options] +------------------------------ + +You can append query options to the URI in the following format, +?options=value&option2=value&... + +[[AWS-SDB-URIOptions]] +URI Options +^^^^^^^^^^^ + + +// component options: START +The AWS SimpleDB component has no options. +// component options: END + + + + +// endpoint options: START +The AWS SimpleDB component supports 12 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| domainName | producer | | String | *Required* The name of the domain currently worked with. +| accessKey | producer | | String | Amazon AWS Access Key +| amazonSDBClient | producer | | AmazonSimpleDB | To use the AmazonSimpleDB as the client +| amazonSdbEndpoint | producer | | String | The region with which the AWS-SDB client wants to work with. +| consistentRead | producer | false | boolean | Determines whether or not strong consistency should be enforced when data is read. +| maxNumberOfDomains | producer | | Integer | The maximum number of domain names you want returned. The range is 1 to 100. +| operation | producer | PutAttributes | SdbOperations | Operation to perform +| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client +| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client +| secretKey | producer | | String | Amazon AWS Secret Key +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + + +Required SDB component options + +You have to provide the amazonSDBClient in the +link:registry.html[Registry] or your accessKey and secretKey to access +the http://aws.amazon.com/sdb[Amazon's SDB]. + +[[AWS-SDB-Usage]] +Usage +^^^^^ + +[[AWS-SDB-MessageheadersevaluatedbytheSDBproducer]] +Message headers evaluated by the SDB producer ++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSdbAttributes` |`Collection<Attribute>` |List of attributes to be acted upon. + +|`CamelAwsSdbAttributeNames` |`Collection<String>` |The names of the attributes to be retrieved. + +|`CamelAwsSdbConsistentRead` |`Boolean` |Determines whether or not strong consistency should be enforced when +data is read. + +|`CamelAwsSdbDeletableItems` |`Collection<DeletableItem>` |A list of items on which to perform the delete operation in a batch. + +|`CamelAwsSdbDomainName` |`String` |The name of the domain currently worked with. + +|`CamelAwsSdbItemName` |`String` |The unique key for this item + +|`CamelAwsSdbMaxNumberOfDomains` |`Integer` |The maximum number of domain names you want returned. The range is 1 * +to 100. + +|`CamelAwsSdbNextToken` |`String` |A string specifying where to start the next list of domain/item names. + +|`CamelAwsSdbOperation` |`String` |To override the operation from the URI options. + +|`CamelAwsSdbReplaceableAttributes` |`Collection<ReplaceableAttribute>` |List of attributes to put in an Item. + +|`CamelAwsSdbReplaceableItems` |`Collection<ReplaceableItem>` |A list of items to put in a Domain. + +|`CamelAwsSdbSelectExpression` |`String` |The expression used to query the domain. + +|`CamelAwsSdbUpdateCondition` |`UpdateCondition` |The update condition which, if specified, determines whether the +specified attributes will be updated/deleted or not. +|======================================================================= + +[[AWS-SDB-MessageheaderssetduringDomainMetadataoperation]] +Message headers set during DomainMetadata operation ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSdbTimestamp` |`Integer` |The data and time when metadata was calculated, in Epoch (UNIX) seconds. + +|`CamelAwsSdbItemCount` |`Integer` |The number of all items in the domain. + +|`CamelAwsSdbAttributeNameCount` |`Integer` |The number of unique attribute names in the domain. + +|`CamelAwsSdbAttributeValueCount` |`Integer` |The number of all attribute name/value pairs in the domain. + +|`CamelAwsSdbAttributeNameSize` |`Long` |The total size of all unique attribute names in the domain, in bytes. + +|`CamelAwsSdbAttributeValueSize` |`Long` |The total size of all attribute values in the domain, in bytes. + +|`CamelAwsSdbItemNameSize` |`Long` |The total size of all item names in the domain, in bytes. +|======================================================================= + +[[AWS-SDB-MessageheaderssetduringGetAttributesoperation]] +Message headers set during GetAttributes operation +++++++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSdbAttributes` |`List<Attribute>` |The list of attributes returned by the operation. +|======================================================================= + +[[AWS-SDB-MessageheaderssetduringListDomainsoperation]] +Message headers set during ListDomains operation +++++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSdbDomainNames` |`List<String>` |A list of domain names that match the expression. + +|`CamelAwsSdbNextToken` |`String` |An opaque token indicating that there are more domains than the +specified MaxNumberOfDomains still available. +|======================================================================= + +[[AWS-SDB-MessageheaderssetduringSelectoperation]] +Message headers set during Select operation ++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSdbItems` |`List<Item>` |A list of items that match the select expression. + +|`CamelAwsSdbNextToken` |`String` |An opaque token indicating that more items than MaxNumberOfItems were +matched, the response size exceeded 1 megabyte, or the execution time +exceeded 5 seconds. +|======================================================================= + +[[AWS-SDB-AdvancedAmazonSimpleDBconfiguration]] +Advanced AmazonSimpleDB configuration ++++++++++++++++++++++++++++++++++++++ + +If you need more control over the `AmazonSimpleDB` instance +configuration you can create your own instance and refer to it from the +URI: + +[source,java] +---------------------------------------------------- +from("direct:start") +.to("aws-sdb://domainName?amazonSDBClient=#client"); +---------------------------------------------------- + +The `#client` refers to a `AmazonSimpleDB` in the +link:registry.html[Registry]. + +For example if your Camel Application is running behind a firewall: + +[source,java] +-------------------------------------------------------------------------------------- +AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); +ClientConfiguration clientConfiguration = new ClientConfiguration(); +clientConfiguration.setProxyHost("http://myProxyHost";); +clientConfiguration.setProxyPort(8080); + +AmazonSimpleDB client = new AmazonSimpleDBClient(awsCredentials, clientConfiguration); + +registry.bind("client", client); +-------------------------------------------------------------------------------------- + +[[AWS-SDB-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `${camel-version`} must be replaced by the actual version of Camel +(2.8.4 or higher). + +[[AWS-SDB-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:aws.html[AWS Component] + http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-sdb.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sdb.adoc b/components/camel-aws/src/main/docs/aws-sdb.adoc deleted file mode 100644 index 37d6a0b..0000000 --- a/components/camel-aws/src/main/docs/aws-sdb.adoc +++ /dev/null @@ -1,237 +0,0 @@ -[[AWS-SDB-SDBComponent]] -SDB Component -~~~~~~~~~~~~~ - -*Available as of Camel 2.8.4* - -The sdb component supports storing and retrieving data from/to -http://aws.amazon.com/sdb[Amazon's SDB] service. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon SDB. More information are available at -http://aws.amazon.com/sdb[Amazon SDB]. - -[[AWS-SDB-URIFormat]] -URI Format -^^^^^^^^^^ - -[source,java] ------------------------------- -aws-sdb://domainName[?options] ------------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -[[AWS-SDB-URIOptions]] -URI Options -^^^^^^^^^^^ - - -// component options: START -The AWS SimpleDB component has no options. -// component options: END - - - - -// endpoint options: START -The AWS SimpleDB component supports 12 endpoint options which are listed below: - -{% raw %} -[width="100%",cols="2s,1,1m,1m,5",options="header"] -|======================================================================= -| Name | Group | Default | Java Type | Description -| domainName | producer | | String | *Required* The name of the domain currently worked with. -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSDBClient | producer | | AmazonSimpleDB | To use the AmazonSimpleDB as the client -| amazonSdbEndpoint | producer | | String | The region with which the AWS-SDB client wants to work with. -| consistentRead | producer | false | boolean | Determines whether or not strong consistency should be enforced when data is read. -| maxNumberOfDomains | producer | | Integer | The maximum number of domain names you want returned. The range is 1 to 100. -| operation | producer | PutAttributes | SdbOperations | Operation to perform -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| secretKey | producer | | String | Amazon AWS Secret Key -| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -|======================================================================= -{% endraw %} -// endpoint options: END - - - -Required SDB component options - -You have to provide the amazonSDBClient in the -link:registry.html[Registry] or your accessKey and secretKey to access -the http://aws.amazon.com/sdb[Amazon's SDB]. - -[[AWS-SDB-Usage]] -Usage -^^^^^ - -[[AWS-SDB-MessageheadersevaluatedbytheSDBproducer]] -Message headers evaluated by the SDB producer -+++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSdbAttributes` |`Collection<Attribute>` |List of attributes to be acted upon. - -|`CamelAwsSdbAttributeNames` |`Collection<String>` |The names of the attributes to be retrieved. - -|`CamelAwsSdbConsistentRead` |`Boolean` |Determines whether or not strong consistency should be enforced when -data is read. - -|`CamelAwsSdbDeletableItems` |`Collection<DeletableItem>` |A list of items on which to perform the delete operation in a batch. - -|`CamelAwsSdbDomainName` |`String` |The name of the domain currently worked with. - -|`CamelAwsSdbItemName` |`String` |The unique key for this item - -|`CamelAwsSdbMaxNumberOfDomains` |`Integer` |The maximum number of domain names you want returned. The range is 1 * -to 100. - -|`CamelAwsSdbNextToken` |`String` |A string specifying where to start the next list of domain/item names. - -|`CamelAwsSdbOperation` |`String` |To override the operation from the URI options. - -|`CamelAwsSdbReplaceableAttributes` |`Collection<ReplaceableAttribute>` |List of attributes to put in an Item. - -|`CamelAwsSdbReplaceableItems` |`Collection<ReplaceableItem>` |A list of items to put in a Domain. - -|`CamelAwsSdbSelectExpression` |`String` |The expression used to query the domain. - -|`CamelAwsSdbUpdateCondition` |`UpdateCondition` |The update condition which, if specified, determines whether the -specified attributes will be updated/deleted or not. -|======================================================================= - -[[AWS-SDB-MessageheaderssetduringDomainMetadataoperation]] -Message headers set during DomainMetadata operation -+++++++++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSdbTimestamp` |`Integer` |The data and time when metadata was calculated, in Epoch (UNIX) seconds. - -|`CamelAwsSdbItemCount` |`Integer` |The number of all items in the domain. - -|`CamelAwsSdbAttributeNameCount` |`Integer` |The number of unique attribute names in the domain. - -|`CamelAwsSdbAttributeValueCount` |`Integer` |The number of all attribute name/value pairs in the domain. - -|`CamelAwsSdbAttributeNameSize` |`Long` |The total size of all unique attribute names in the domain, in bytes. - -|`CamelAwsSdbAttributeValueSize` |`Long` |The total size of all attribute values in the domain, in bytes. - -|`CamelAwsSdbItemNameSize` |`Long` |The total size of all item names in the domain, in bytes. -|======================================================================= - -[[AWS-SDB-MessageheaderssetduringGetAttributesoperation]] -Message headers set during GetAttributes operation -++++++++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSdbAttributes` |`List<Attribute>` |The list of attributes returned by the operation. -|======================================================================= - -[[AWS-SDB-MessageheaderssetduringListDomainsoperation]] -Message headers set during ListDomains operation -++++++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSdbDomainNames` |`List<String>` |A list of domain names that match the expression. - -|`CamelAwsSdbNextToken` |`String` |An opaque token indicating that there are more domains than the -specified MaxNumberOfDomains still available. -|======================================================================= - -[[AWS-SDB-MessageheaderssetduringSelectoperation]] -Message headers set during Select operation -+++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSdbItems` |`List<Item>` |A list of items that match the select expression. - -|`CamelAwsSdbNextToken` |`String` |An opaque token indicating that more items than MaxNumberOfItems were -matched, the response size exceeded 1 megabyte, or the execution time -exceeded 5 seconds. -|======================================================================= - -[[AWS-SDB-AdvancedAmazonSimpleDBconfiguration]] -Advanced AmazonSimpleDB configuration -+++++++++++++++++++++++++++++++++++++ - -If you need more control over the `AmazonSimpleDB` instance -configuration you can create your own instance and refer to it from the -URI: - -[source,java] ----------------------------------------------------- -from("direct:start") -.to("aws-sdb://domainName?amazonSDBClient=#client"); ----------------------------------------------------- - -The `#client` refers to a `AmazonSimpleDB` in the -link:registry.html[Registry]. - -For example if your Camel Application is running behind a firewall: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); - -AmazonSimpleDB client = new AmazonSimpleDBClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -[[AWS-SDB-Dependencies]] -Dependencies -^^^^^^^^^^^^ - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `${camel-version`} must be replaced by the actual version of Camel -(2.8.4 or higher). - -[[AWS-SDB-SeeAlso]] -See Also -^^^^^^^^ - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - -* link:aws.html[AWS Component] - http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-ses-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc new file mode 100644 index 0000000..716168b --- /dev/null +++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc @@ -0,0 +1,168 @@ +[[AWS-SES-SESComponent]] +SES Component +~~~~~~~~~~~~~ + +*Available as of Camel 2.8.4* + +The ses component supports sending emails with +http://aws.amazon.com/ses[Amazon's SES] service. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon SES. More information are available at +http://aws.amazon.com/ses[Amazon SES]. + +[[AWS-SES-URIFormat]] +URI Format +^^^^^^^^^^ + +[source,java] +------------------------ +aws-ses://from[?options] +------------------------ + +You can append query options to the URI in the following format, +?options=value&option2=value&... + +[[AWS-SES-URIOptions]] +URI Options +^^^^^^^^^^^ + + +// component options: START +The AWS Simple Email Service component has no options. +// component options: END + + + + +// endpoint options: START +The AWS Simple Email Service component supports 13 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| from | producer | | String | *Required* The sender's email address. +| accessKey | producer | | String | Amazon AWS Access Key +| amazonSESClient | producer | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client +| amazonSESEndpoint | producer | | String | The region with which the AWS-SES client wants to work with. +| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client +| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client +| replyToAddresses | producer | | List | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. +| returnPath | producer | | String | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. +| secretKey | producer | | String | Amazon AWS Secret Key +| subject | producer | | String | The subject which is used if the message header 'CamelAwsSesSubject' is not present. +| to | producer | | List | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + + +Required SES component options + +You have to provide the amazonSESClient in the +link:registry.html[Registry] or your accessKey and secretKey to access +the http://aws.amazon.com/ses[Amazon's SES]. + +[[AWS-SES-Usage]] +Usage +^^^^^ + +[[AWS-SES-MessageheadersevaluatedbytheSESproducer]] +Message headers evaluated by the SES producer ++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSesFrom` |`String` |The sender's email address. + +|`CamelAwsSesTo` |`List<String>` |The destination(s) for this email. + +|`CamelAwsSesSubject` |`String` |The subject of the message. + +|`CamelAwsSesReplyToAddresses` |`List<String>` |The reply-to email address(es) for the message. + +|`CamelAwsSesReturnPath` |`String` |The email address to which bounce notifications are to be forwarded. + +|`CamelAwsSesHtmlEmail` |`Boolean` |*Since Camel 2.12.3* The flag to show if email content is HTML. +|======================================================================= + +[[AWS-SES-MessageheaderssetbytheSESproducer]] +Message headers set by the SES producer ++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSesMessageId` |`String` |The Amazon SES message ID. +|======================================================================= + +[[AWS-SES-AdvancedAmazonSimpleEmailServiceconfiguration]] +Advanced AmazonSimpleEmailService configuration ++++++++++++++++++++++++++++++++++++++++++++++++ + +If you need more control over the `AmazonSimpleEmailService` instance +configuration you can create your own instance and refer to it from the +URI: + +[source,java] +------------------------------------------------------------- +from("direct:start") +.to("aws-ses://exam...@example.com?amazonSESClient=#client"); +------------------------------------------------------------- + +The `#client` refers to a `AmazonSimpleEmailService` in the +link:registry.html[Registry]. + +For example if your Camel Application is running behind a firewall: + +[source,java] +---------------------------------------------------------------------------------------------------------- +AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); +ClientConfiguration clientConfiguration = new ClientConfiguration(); +clientConfiguration.setProxyHost("http://myProxyHost";); +clientConfiguration.setProxyPort(8080); +AmazonSimpleEmailService client = new AmazonSimpleEmailServiceClient(awsCredentials, clientConfiguration); + +registry.bind("client", client); +---------------------------------------------------------------------------------------------------------- + +[[AWS-SES-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `${camel-version`} must be replaced by the actual version of Camel +(2.8.4 or higher). + +[[AWS-SES-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:aws.html[AWS Component] + http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-ses.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-ses.adoc b/components/camel-aws/src/main/docs/aws-ses.adoc deleted file mode 100644 index 716168b..0000000 --- a/components/camel-aws/src/main/docs/aws-ses.adoc +++ /dev/null @@ -1,168 +0,0 @@ -[[AWS-SES-SESComponent]] -SES Component -~~~~~~~~~~~~~ - -*Available as of Camel 2.8.4* - -The ses component supports sending emails with -http://aws.amazon.com/ses[Amazon's SES] service. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon SES. More information are available at -http://aws.amazon.com/ses[Amazon SES]. - -[[AWS-SES-URIFormat]] -URI Format -^^^^^^^^^^ - -[source,java] ------------------------- -aws-ses://from[?options] ------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -[[AWS-SES-URIOptions]] -URI Options -^^^^^^^^^^^ - - -// component options: START -The AWS Simple Email Service component has no options. -// component options: END - - - - -// endpoint options: START -The AWS Simple Email Service component supports 13 endpoint options which are listed below: - -{% raw %} -[width="100%",cols="2s,1,1m,1m,5",options="header"] -|======================================================================= -| Name | Group | Default | Java Type | Description -| from | producer | | String | *Required* The sender's email address. -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSESClient | producer | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client -| amazonSESEndpoint | producer | | String | The region with which the AWS-SES client wants to work with. -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| replyToAddresses | producer | | List | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. -| returnPath | producer | | String | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. -| secretKey | producer | | String | Amazon AWS Secret Key -| subject | producer | | String | The subject which is used if the message header 'CamelAwsSesSubject' is not present. -| to | producer | | List | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. -| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -|======================================================================= -{% endraw %} -// endpoint options: END - - - -Required SES component options - -You have to provide the amazonSESClient in the -link:registry.html[Registry] or your accessKey and secretKey to access -the http://aws.amazon.com/ses[Amazon's SES]. - -[[AWS-SES-Usage]] -Usage -^^^^^ - -[[AWS-SES-MessageheadersevaluatedbytheSESproducer]] -Message headers evaluated by the SES producer -+++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSesFrom` |`String` |The sender's email address. - -|`CamelAwsSesTo` |`List<String>` |The destination(s) for this email. - -|`CamelAwsSesSubject` |`String` |The subject of the message. - -|`CamelAwsSesReplyToAddresses` |`List<String>` |The reply-to email address(es) for the message. - -|`CamelAwsSesReturnPath` |`String` |The email address to which bounce notifications are to be forwarded. - -|`CamelAwsSesHtmlEmail` |`Boolean` |*Since Camel 2.12.3* The flag to show if email content is HTML. -|======================================================================= - -[[AWS-SES-MessageheaderssetbytheSESproducer]] -Message headers set by the SES producer -+++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSesMessageId` |`String` |The Amazon SES message ID. -|======================================================================= - -[[AWS-SES-AdvancedAmazonSimpleEmailServiceconfiguration]] -Advanced AmazonSimpleEmailService configuration -+++++++++++++++++++++++++++++++++++++++++++++++ - -If you need more control over the `AmazonSimpleEmailService` instance -configuration you can create your own instance and refer to it from the -URI: - -[source,java] -------------------------------------------------------------- -from("direct:start") -.to("aws-ses://exam...@example.com?amazonSESClient=#client"); -------------------------------------------------------------- - -The `#client` refers to a `AmazonSimpleEmailService` in the -link:registry.html[Registry]. - -For example if your Camel Application is running behind a firewall: - -[source,java] ----------------------------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); -AmazonSimpleEmailService client = new AmazonSimpleEmailServiceClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); ----------------------------------------------------------------------------------------------------------- - -[[AWS-SES-Dependencies]] -Dependencies -^^^^^^^^^^^^ - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `${camel-version`} must be replaced by the actual version of Camel -(2.8.4 or higher). - -[[AWS-SES-SeeAlso]] -See Also -^^^^^^^^ - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - -* link:aws.html[AWS Component] - http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-sns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc new file mode 100644 index 0000000..b441de6 --- /dev/null +++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc @@ -0,0 +1,162 @@ +[[AWS-SNS-SNSComponent]] +SNS Component +~~~~~~~~~~~~~ + +*Available as of Camel 2.8* + +The SNS component allows messages to be sent to an +http://aws.amazon.com/sns[Amazon Simple Notification] Topic. The +implementation of the Amazon API is provided by +the http://aws.amazon.com/sdkforjava/[AWS SDK]. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon SNS. More information are available at +http://aws.amazon.com/sns[Amazon SNS]. + +[[AWS-SNS-URIFormat]] +URI Format +^^^^^^^^^^ + +[source,java] +----------------------------- +aws-sns://topicNameOrArn[?options] +----------------------------- + +The topic will be created if they don't already exists. + + You can append query options to the URI in the following format, +`?options=value&option2=value&...` + +[[AWS-SNS-URIOptions]] +URI Options +^^^^^^^^^^^ + + +// component options: START +The AWS Simple Notification System component has no options. +// component options: END + + + + + +// endpoint options: START +The AWS Simple Notification System component supports 12 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| topicNameOrArn | producer | | String | *Required* Topic name or ARN +| accessKey | producer | | String | Amazon AWS Access Key +| amazonSNSClient | producer | | AmazonSNS | To use the AmazonSNS as the client +| amazonSNSEndpoint | producer | | String | The region with which the AWS-SNS client wants to work with. +| messageStructure | producer | | String | The message structure to use such as json +| policy | producer | | String | The policy for this queue +| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client +| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client +| secretKey | producer | | String | Amazon AWS Secret Key +| subject | producer | | String | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + + + +Required SNS component options + +You have to provide the amazonSNSClient in the +link:registry.html[Registry] or your accessKey and secretKey to access +the http://aws.amazon.com/sns[Amazon's SNS]. + +[[AWS-SNS-Usage]] +Usage +^^^^^ + +[[AWS-SNS-MessageheadersevaluatedbytheSNSproducer]] +Message headers evaluated by the SNS producer ++++++++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSnsSubject` |`String` |The Amazon SNS message subject. If not set, the subject from the +`SnsConfiguration` is used. +|======================================================================= + +[[AWS-SNS-MessageheaderssetbytheSNSproducer]] +Message headers set by the SNS producer ++++++++++++++++++++++++++++++++++++++++ + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsSnsMessageId` |`String` |The Amazon SNS message ID. +|======================================================================= + +[[AWS-SNS-AdvancedAmazonSNSconfiguration]] +Advanced AmazonSNS configuration +++++++++++++++++++++++++++++++++ + +If you need more control over the `AmazonSNS` instance configuration you +can create your own instance and refer to it from the URI: + +[source,java] +------------------------------------------------- +from("direct:start") +.to("aws-sns://MyTopic?amazonSNSClient=#client"); +------------------------------------------------- + +The `#client` refers to a `AmazonSNS` in the +link:registry.html[Registry]. + +For example if your Camel Application is running behind a firewall: + +[source,java] +-------------------------------------------------------------------------------------- +AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); +ClientConfiguration clientConfiguration = new ClientConfiguration(); +clientConfiguration.setProxyHost("http://myProxyHost";); +clientConfiguration.setProxyPort(8080); +AmazonSNS client = new AmazonSNSClient(awsCredentials, clientConfiguration); + +registry.bind("client", client); +-------------------------------------------------------------------------------------- + +[[AWS-SNS-Dependencies]] +Dependencies +^^^^^^^^^^^^ + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `${camel-version`} must be replaced by the actual version of Camel +(2.8 or higher). + +[[AWS-SNS-SeeAlso]] +See Also +^^^^^^^^ + +* link:configuring-camel.html[Configuring Camel] +* link:component.html[Component] +* link:endpoint.html[Endpoint] +* link:getting-started.html[Getting Started] + +* link:aws.html[AWS Component] + http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-aws/src/main/docs/aws-sns.adoc ---------------------------------------------------------------------- diff --git a/components/camel-aws/src/main/docs/aws-sns.adoc b/components/camel-aws/src/main/docs/aws-sns.adoc deleted file mode 100644 index b441de6..0000000 --- a/components/camel-aws/src/main/docs/aws-sns.adoc +++ /dev/null @@ -1,162 +0,0 @@ -[[AWS-SNS-SNSComponent]] -SNS Component -~~~~~~~~~~~~~ - -*Available as of Camel 2.8* - -The SNS component allows messages to be sent to an -http://aws.amazon.com/sns[Amazon Simple Notification] Topic. The -implementation of the Amazon API is provided by -the http://aws.amazon.com/sdkforjava/[AWS SDK]. - -Prerequisites - -You must have a valid Amazon Web Services developer account, and be -signed up to use Amazon SNS. More information are available at -http://aws.amazon.com/sns[Amazon SNS]. - -[[AWS-SNS-URIFormat]] -URI Format -^^^^^^^^^^ - -[source,java] ------------------------------ -aws-sns://topicNameOrArn[?options] ------------------------------ - -The topic will be created if they don't already exists. + - You can append query options to the URI in the following format, -`?options=value&option2=value&...` - -[[AWS-SNS-URIOptions]] -URI Options -^^^^^^^^^^^ - - -// component options: START -The AWS Simple Notification System component has no options. -// component options: END - - - - - -// endpoint options: START -The AWS Simple Notification System component supports 12 endpoint options which are listed below: - -{% raw %} -[width="100%",cols="2s,1,1m,1m,5",options="header"] -|======================================================================= -| Name | Group | Default | Java Type | Description -| topicNameOrArn | producer | | String | *Required* Topic name or ARN -| accessKey | producer | | String | Amazon AWS Access Key -| amazonSNSClient | producer | | AmazonSNS | To use the AmazonSNS as the client -| amazonSNSEndpoint | producer | | String | The region with which the AWS-SNS client wants to work with. -| messageStructure | producer | | String | The message structure to use such as json -| policy | producer | | String | The policy for this queue -| proxyHost | producer | | String | To define a proxy host when instantiating the SQS client -| proxyPort | producer | | Integer | To define a proxy port when instantiating the SQS client -| secretKey | producer | | String | Amazon AWS Secret Key -| subject | producer | | String | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. -| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -|======================================================================= -{% endraw %} -// endpoint options: END - - - - -Required SNS component options - -You have to provide the amazonSNSClient in the -link:registry.html[Registry] or your accessKey and secretKey to access -the http://aws.amazon.com/sns[Amazon's SNS]. - -[[AWS-SNS-Usage]] -Usage -^^^^^ - -[[AWS-SNS-MessageheadersevaluatedbytheSNSproducer]] -Message headers evaluated by the SNS producer -+++++++++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSnsSubject` |`String` |The Amazon SNS message subject. If not set, the subject from the -`SnsConfiguration` is used. -|======================================================================= - -[[AWS-SNS-MessageheaderssetbytheSNSproducer]] -Message headers set by the SNS producer -+++++++++++++++++++++++++++++++++++++++ - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelAwsSnsMessageId` |`String` |The Amazon SNS message ID. -|======================================================================= - -[[AWS-SNS-AdvancedAmazonSNSconfiguration]] -Advanced AmazonSNS configuration -++++++++++++++++++++++++++++++++ - -If you need more control over the `AmazonSNS` instance configuration you -can create your own instance and refer to it from the URI: - -[source,java] -------------------------------------------------- -from("direct:start") -.to("aws-sns://MyTopic?amazonSNSClient=#client"); -------------------------------------------------- - -The `#client` refers to a `AmazonSNS` in the -link:registry.html[Registry]. - -For example if your Camel Application is running behind a firewall: - -[source,java] --------------------------------------------------------------------------------------- -AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey"); -ClientConfiguration clientConfiguration = new ClientConfiguration(); -clientConfiguration.setProxyHost("http://myProxyHost";); -clientConfiguration.setProxyPort(8080); -AmazonSNS client = new AmazonSNSClient(awsCredentials, clientConfiguration); - -registry.bind("client", client); --------------------------------------------------------------------------------------- - -[[AWS-SNS-Dependencies]] -Dependencies -^^^^^^^^^^^^ - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `${camel-version`} must be replaced by the actual version of Camel -(2.8 or higher). - -[[AWS-SNS-SeeAlso]] -See Also -^^^^^^^^ - -* link:configuring-camel.html[Configuring Camel] -* link:component.html[Component] -* link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] - -* link:aws.html[AWS Component] -
