This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8a4ba1cbb93d0d4af0c2ef4c81405c052172a9dd Author: Andrea Cosentino <[email protected]> AuthorDate: Thu Feb 18 18:28:57 2021 +0100 CAMEL-16115 - Remove Camel-AWS-* components - AWS-SES --- .../org/apache/camel/catalog/components.properties | 1 - .../apache/camel/catalog/components/aws-ses.json | 58 ------ .../org/apache/camel/catalog/docs.properties | 1 - .../camel/catalog/docs/aws-ses-component.adoc | 212 -------------------- .../component/ComponentsBuilderFactory.java | 2 +- .../src/generated/resources/metadata.json | 23 --- .../builder/endpoint/EndpointBuilderFactory.java | 1 - .../camel/builder/endpoint/EndpointBuilders.java | 1 - .../builder/endpoint/StaticEndpointBuilders.java | 2 +- docs/components/modules/ROOT/nav.adoc | 1 - .../modules/ROOT/pages/aws-ses-component.adoc | 214 --------------------- 11 files changed, 2 insertions(+), 514 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties index 537b0c5..b79f8aaa 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties @@ -32,7 +32,6 @@ aws-lambda aws-mq aws-msk aws-s3 -aws-ses aws-swf aws2-athena aws2-cw diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ses.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ses.json deleted file mode 100644 index acec598..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-ses.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "component": { - "kind": "component", - "name": "aws-ses", - "title": "AWS Simple Email Service (SES)", - "description": "Send e-mails through AWS SES service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.9.0", - "label": "cloud,mail", - "javaType": "org.apache.camel.component.aws.ses.SesComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ses", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ses", - "extendsScheme": "", - "syntax": "aws-ses:from", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": true, - "lenientProperties": false - }, - "componentProperties": { - "amazonSESClient": { "kind": "property", "displayName": "Amazon SESClient", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleemail.AmazonSimpleEmailService", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To use the AmazonSimpleEmailService as the client" }, - "autoDiscoverClient": { "kind": "property", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client instan [...] - "configuration": { "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.ses.SesConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, - "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 producer may otherwise fail during star [...] - "proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the SES client" }, - "proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the SES client" }, - "proxyProtocol": { "kind": "property", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the SES client" }, - "region": { "kind": "property", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region [...] - "replyToAddresses": { "kind": "property", "displayName": "Reply To Addresses", "group": "producer", "label": "", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' h [...] - "returnPath": { "kind": "property", "displayName": "Return Path", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header." }, - "subject": { "kind": "property", "displayName": "Subject", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The subject which is used if the message header 'CamelAwsSesSubject' is not present." }, - "to": { "kind": "property", "displayName": "To", "group": "producer", "label": "", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "List of destination email address. Can be overriden with 'CamelAwsSesTo' header." }, - "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...] - "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - }, - "properties": { - "from": { "kind": "path", "displayName": "From", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The sender's email address." }, - "amazonSESClient": { "kind": "parameter", "displayName": "Amazon SESClient", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleemail.AmazonSimpleEmailService", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To use the AmazonSimpleEmailService as the client" }, - "autoDiscoverClient": { "kind": "parameter", "displayName": "Auto Discover Client", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Setting the autoDiscoverClient mechanism, if true, the component will look for a client insta [...] - "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 producer may otherwise fail during sta [...] - "proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the SES client" }, - "proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the SES client" }, - "proxyProtocol": { "kind": "parameter", "displayName": "Proxy Protocol", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.Protocol", "enum": [ "HTTP", "HTTPS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HTTPS", "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "To define a proxy protocol when instantiating the SES client" }, - "region": { "kind": "parameter", "displayName": "Region", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region [...] - "replyToAddresses": { "kind": "parameter", "displayName": "Reply To Addresses", "group": "producer", "label": "", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' [...] - "returnPath": { "kind": "parameter", "displayName": "Return Path", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header." }, - "subject": { "kind": "parameter", "displayName": "Subject", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "The subject which is used if the message header 'CamelAwsSesSubject' is not present." }, - "to": { "kind": "parameter", "displayName": "To", "group": "producer", "label": "", "required": false, "type": "array", "javaType": "java.util.List<java.lang.String>", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "List of destination email address. Can be overriden with 'CamelAwsSesTo' header." }, - "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, - "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.ses.SesConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } - } -} diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties index ac09b66..4435e07 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties @@ -36,7 +36,6 @@ aws-lambda-component aws-mq-component aws-msk-component aws-s3-component -aws-ses-component aws-summary aws-swf-component aws-xray diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ses-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ses-component.adoc deleted file mode 100644 index 05c0d51..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-ses-component.adoc +++ /dev/null @@ -1,212 +0,0 @@ -[[aws-ses-component]] -= AWS Simple Email Service (SES) Component (deprecated) -:docTitle: AWS Simple Email Service (SES) -:artifactId: camel-aws-ses -:description: Send e-mails through AWS SES service. -:since: 2.9 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only producer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ses.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The ses component supports sending emails with -https://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 is available at -https://aws.amazon.com/ses[Amazon SES]. - -== URI Format - -[source,java] ------------------------- -aws-ses://from[?options] ------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Email Service (SES) component supports 15 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSESClient* (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmailService -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (producer) | The component configuration | | SesConfiguration -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *proxyHost* (producer) | To define a proxy host when instantiating the SES client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the SES client | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the SES client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (producer) | The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *replyToAddresses* (producer) | List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | | List -| *returnPath* (producer) | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | | String -| *subject* (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String -| *to* (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// component options: END - - - - -// endpoint options: START -The AWS Simple Email Service (SES) endpoint is configured using URI syntax: - ----- -aws-ses:from ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *from* | *Required* The sender's email address. | | String -|=== - - -=== Query Parameters (13 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSESClient* (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmailService -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *proxyHost* (producer) | To define a proxy host when instantiating the SES client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the SES client | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the SES client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (producer) | The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *replyToAddresses* (producer) | List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | | List -| *returnPath* (producer) | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | | String -| *subject* (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String -| *to* (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - -Required SES component options - -You have to provide the amazonSESClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/ses[Amazon's SES]. - -== Usage - -=== 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` |The flag to show if email content is HTML. -|======================================================================= - -=== 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. -|======================================================================= - -=== 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://[email protected]?amazonSESClient=#client"); -------------------------------------------------------------- - -The `#client` refers to a `AmazonSimpleEmailService` in the -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); ----------------------------------------------------------------------------------------------------------- - -== Automatic detection of AmazonSimpleEmailService client in registry - -The component is capable of detecting the presence of an AmazonSimpleEmailService bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Producer Examples - -[source,java] --------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SesConstants.SUBJECT, constant("This is my subject")) - .setHeader(SesConstants.TO, constant(Collections.singletonList("[email protected]")) - .setBody(constant("This is my message text.")) - .to("aws-ses://[email protected]?accessKey=xxx&secretKey=yyy"); --------------------------------------------------------------------------------- - -== 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-ses</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ses-starter.adoc[] diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java index 784cc86..c3139c6 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java @@ -4876,4 +4876,4 @@ public interface ComponentsBuilderFactory { static org.apache.camel.builder.component.dsl.ZookeeperMasterComponentBuilderFactory.ZookeeperMasterComponentBuilder zookeeperMaster() { return org.apache.camel.builder.component.dsl.ZookeeperMasterComponentBuilderFactory.zookeeperMaster(); } -} +} \ No newline at end of file diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json b/core/camel-componentdsl/src/generated/resources/metadata.json index a4fa4f0..06ee123 100644 --- a/core/camel-componentdsl/src/generated/resources/metadata.json +++ b/core/camel-componentdsl/src/generated/resources/metadata.json @@ -1228,29 +1228,6 @@ "producerOnly": false, "lenientProperties": false }, - "AwsSesComponentBuilderFactory": { - "kind": "component", - "name": "aws-ses", - "title": "AWS Simple Email Service (SES)", - "description": "Send e-mails through AWS SES service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.9.0", - "label": "cloud,mail", - "javaType": "org.apache.camel.component.aws.ses.SesComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-ses", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-ses", - "extendsScheme": "", - "syntax": "aws-ses:from", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": true, - "lenientProperties": false - }, "AwsSwfComponentBuilderFactory": { "kind": "component", "name": "aws-swf", diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java index fdd77ac..57c724e 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java @@ -309,7 +309,6 @@ public interface EndpointBuilderFactory org.apache.camel.builder.endpoint.dsl.ServiceNowEndpointBuilderFactory.ServiceNowBuilders, org.apache.camel.builder.endpoint.dsl.ServletEndpointBuilderFactory.ServletBuilders, org.apache.camel.builder.endpoint.dsl.Ses2EndpointBuilderFactory.Ses2Builders, - org.apache.camel.builder.endpoint.dsl.SesEndpointBuilderFactory.SesBuilders, org.apache.camel.builder.endpoint.dsl.SftpEndpointBuilderFactory.SftpBuilders, org.apache.camel.builder.endpoint.dsl.SimpleNotificationEndpointBuilderFactory.SimpleNotificationBuilders, org.apache.camel.builder.endpoint.dsl.SipEndpointBuilderFactory.SipBuilders, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java index 627d1e4..f87c798 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilders.java @@ -306,7 +306,6 @@ public interface EndpointBuilders org.apache.camel.builder.endpoint.dsl.ServiceNowEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.ServletEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.Ses2EndpointBuilderFactory, - org.apache.camel.builder.endpoint.dsl.SesEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.SftpEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.SimpleNotificationEndpointBuilderFactory, org.apache.camel.builder.endpoint.dsl.SipEndpointBuilderFactory, diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java index 3c8888a..58c6232 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java @@ -17072,4 +17072,4 @@ public class StaticEndpointBuilders { return org.apache.camel.builder.endpoint.dsl.ZooKeeperMasterEndpointBuilderFactory.endpointBuilder(componentName, path); } } -//CHECKSTYLE:ON +//CHECKSTYLE:ON \ No newline at end of file diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index b3f0e42..35faec6 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -36,7 +36,6 @@ *** xref:aws-msk-component.adoc[AWS Managed Streaming for Apache Kafka (MSK)] *** xref:aws-mq-component.adoc[AWS MQ] *** xref:aws-s3-component.adoc[AWS S3 Storage Service] -*** xref:aws-ses-component.adoc[AWS Simple Email Service (SES)] *** xref:aws-swf-component.adoc[AWS Simple Workflow (SWF)] ** xref:aws2-summary.adoc[AWS 2] *** xref:aws2-athena-component.adoc[AWS 2 Athena] diff --git a/docs/components/modules/ROOT/pages/aws-ses-component.adoc b/docs/components/modules/ROOT/pages/aws-ses-component.adoc deleted file mode 100644 index 042f244..0000000 --- a/docs/components/modules/ROOT/pages/aws-ses-component.adoc +++ /dev/null @@ -1,214 +0,0 @@ -[[aws-ses-component]] -= AWS Simple Email Service (SES) Component (deprecated) -//THIS FILE IS COPIED: EDIT THE SOURCE FILE: -:page-source: components/camel-aws-ses/src/main/docs/aws-ses-component.adoc -:docTitle: AWS Simple Email Service (SES) -:artifactId: camel-aws-ses -:description: Send e-mails through AWS SES service. -:since: 2.9 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Only producer is supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-ses.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The ses component supports sending emails with -https://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 is available at -https://aws.amazon.com/ses[Amazon SES]. - -== URI Format - -[source,java] ------------------------- -aws-ses://from[?options] ------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Email Service (SES) component supports 15 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSESClient* (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmailService -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *configuration* (producer) | The component configuration | | SesConfiguration -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *proxyHost* (producer) | To define a proxy host when instantiating the SES client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the SES client | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the SES client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (producer) | The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *replyToAddresses* (producer) | List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | | List -| *returnPath* (producer) | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | | String -| *subject* (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String -| *to* (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// component options: END - - - - -// endpoint options: START -The AWS Simple Email Service (SES) endpoint is configured using URI syntax: - ----- -aws-ses:from ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *from* | *Required* The sender's email address. | | String -|=== - - -=== Query Parameters (13 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSESClient* (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmailService -| *autoDiscoverClient* (common) | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | boolean -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *proxyHost* (producer) | To define a proxy host when instantiating the SES client | | String -| *proxyPort* (producer) | To define a proxy port when instantiating the SES client | | Integer -| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the SES client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol -| *region* (producer) | The region in which SES client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *replyToAddresses* (producer) | List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. | | List -| *returnPath* (producer) | The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. | | String -| *subject* (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String -| *to* (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List -| *accessKey* (security) | Amazon AWS Access Key | | String -| *secretKey* (security) | Amazon AWS Secret Key | | String -|=== -// endpoint options: END - - - - -Required SES component options - -You have to provide the amazonSESClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/ses[Amazon's SES]. - -== Usage - -=== 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` |The flag to show if email content is HTML. -|======================================================================= - -=== 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. -|======================================================================= - -=== 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://[email protected]?amazonSESClient=#client"); -------------------------------------------------------------- - -The `#client` refers to a `AmazonSimpleEmailService` in the -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); ----------------------------------------------------------------------------------------------------------- - -== Automatic detection of AmazonSimpleEmailService client in registry - -The component is capable of detecting the presence of an AmazonSimpleEmailService bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Producer Examples - -[source,java] --------------------------------------------------------------------------------- -from("direct:start") - .setHeader(SesConstants.SUBJECT, constant("This is my subject")) - .setHeader(SesConstants.TO, constant(Collections.singletonList("[email protected]")) - .setBody(constant("This is my message text.")) - .to("aws-ses://[email protected]?accessKey=xxx&secretKey=yyy"); --------------------------------------------------------------------------------- - -== 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-ses</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-ses-starter.adoc[]
