You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2020/09/21 16:30:41 UTC
[camel] 08/10: CAMEL-15375 - Camel-AWS2-Eventbridge: First part of
documentation
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 82ae66c9c7ede7b03545c8ef01949b5983962acd
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Mon Sep 21 16:41:18 2020 +0200
CAMEL-15375 - Camel-AWS2-Eventbridge: First part of documentation
---
.../catalog/docs/aws2-eventbridge-component.adoc | 117 ++++----------------
.../aws2/eventbridge/aws2-eventbridge.json | 4 +-
...ponent.adoc => aws2-eventbridge-component.adoc} | 117 ++++----------------
.../aws2/eventbridge/EventbridgeProducer.java | 58 +++++-----
.../EventbridgePutRuleIntegrationTest.java | 10 +-
.../dsl/EventbridgeEndpointBuilderFactory.java | 2 +-
.../ROOT/pages/aws2-eventbridge-component.adoc | 119 +++++----------------
7 files changed, 109 insertions(+), 318 deletions(-)
diff --git a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
similarity index 57%
copy from components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
copy to catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
index f05455e..a319ad7 100644
--- a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws2-eventbridge-component.adoc
@@ -1,9 +1,9 @@
-[[aws2-sts-component]]
-= AWS 2 Security Token Service (STS) Component
-:docTitle: AWS 2 Security Token Service (STS)
-:artifactId: camel-aws2-sts
-:description: Manage AWS STS cluster instances using AWS SDK version 2.x.
-:since: 3.5
+[[aws2-eventbridge-component]]
+= AWS 2 Eventbridge Component
+:docTitle: AWS 2 Eventbridge
+:artifactId: camel-aws2-eventbridge
+:description: Manage AWS Eventbridge cluster instances using AWS SDK version 2.x.
+:since: 3.6
:supportLevel: Preview
:component-header: Only producer is supported
//Manually maintained attributes
@@ -13,25 +13,25 @@
*{component-header}*
-The AWS2 STS component supports assumeRole operation.
-https://aws.amazon.com/sts/[AWS STS].
+The AWS2 Eventbridge component supports assumeRole operation.
+https://aws.amazon.com/eventbridge/[AWS Eventbridge].
Prerequisites
You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon STS. More information is available at
-https://aws.amazon.com/sts/[Amazon STS].
+https://aws.amazon.com/eventbridge/[Amazon Eventbridge].
[NOTE]
====
-The AWS2 STS component is not supported in OSGI
+The AWS2 Eventbridge component is not supported in OSGI
====
== URI Format
[source,java]
-------------------------
-aws2-sts://label[?options]
+aws2-eventbridge://label[?options]
-------------------------
You can append query options to the URI in the following format,
@@ -41,7 +41,7 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Security Token Service (STS) component supports 14 options, which are listed below.
+The AWS 2 Eventbridge component supports 15 options, which are listed below.
@@ -49,15 +49,16 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
|===
| Name | Description | Default | Type
| *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) | Component configuration | | STS2Configuration
+| *configuration* (producer) | Component configuration | | EventbridgeConfiguration
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *accessKey* (security) | Amazon AWS Access Key | | String
@@ -69,10 +70,10 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
// endpoint options: START
-The AWS 2 Security Token Service (STS) endpoint is configured using URI syntax:
+The AWS 2 Eventbridge endpoint is configured using URI syntax:
----
-aws2-sts:label
+aws2-eventbridge:label
----
with the following path and query parameters:
@@ -87,21 +88,22 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (15 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *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
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
@@ -110,77 +112,6 @@ with the following path and query parameters:
|===
// endpoint options: END
-
-
-Required STS component options
-
-You have to provide the amazonSTSClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/sts/[Amazon STS] service.
-
-== Usage
-
-[NOTE]
-====
-The AWS2 STS component works on the aws-global region and it has aws-global as default region
-====
-
-=== STS Producer operations
-
-Camel-AWS STS component provides the following operation on the producer side:
-
-- assumeRole
-- getSessionToken
-- getFedeationToken
-
-== Producer Examples
-
-- assumeRole: this operation will make an AWS user assume a different role temporary
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:assumeRole")
- .setHeader(STS2Constants.ROLE_ARN, constant("arn:123"))
- .setHeader(STS2Constants.ROLE_SESSION_NAME, constant("groot"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole")
---------------------------------------------------------------------------------
-
-- getSessionToken: this operation will return a temporary session token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getSessionToken")
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-- getFederationToken: this operation will return a temporary federation token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getFederationToken")
- .setHeader(STS2Constants.FEDERATED_NAME, constant("federation-account"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-== Automatic detection of StsClient client in registry
-
-The component is capable of detecting the presence of an StsClient 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.
-
-== Using a POJO as body
-
-Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as body.
-In AWS STS, as example for Assume Role request, you can do something like:
-
-------------------------------------------------------------------------------------------------------
-from("direct:createUser")
- .setBody(AssumeRoleRequest.builder().roleArn("arn:123").roleSessionName("groot").build())
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole&pojoRequest=true")
-------------------------------------------------------------------------------------------------------
-
-In this way you'll pass the request directly without the need of passing headers and options specifically related to this operation.
-
== Dependencies
Maven users will need to add the following dependency to their pom.xml.
@@ -191,11 +122,9 @@ Maven users will need to add the following dependency to their pom.xml.
---------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-aws2-sts</artifactId>
+ <artifactId>camel-aws2-eventbridge</artifactId>
<version>${camel-version}</version>
</dependency>
---------------------------------------
where `$\{camel-version}` must be replaced by the actual version of Camel.
-
-include::camel-spring-boot::page$aws2-sts-starter.adoc[]
diff --git a/components/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json b/components/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
index b644136..4dbbcf5 100644
--- a/components/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
+++ b/components/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
@@ -27,7 +27,7 @@
"eventbridgeClient": { "kind": "property", "displayName": "Eventbridge Client", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To use a existing configured AWS Eventbridge as client" },
"eventPatternFile": { "kind": "property", "displayName": "Event Pattern File", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "EventPattern File" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": 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 starting and cause the r [...]
- "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws2.eventbridge.EvenbridgeOperations", "enum": [ "putRule", "putTarget" ], "deprecated": false, "deprecationNote": "", "secret": false, "defaultValue": "assumeRole", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": [...]
+ "operation": { "kind": "property", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws2.eventbridge.EvenbridgeOperations", "enum": [ "putRule", "putTargets" ], "deprecated": false, "deprecationNote": "", "secret": false, "defaultValue": "assumeRole", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": [...]
"pojoRequest": { "kind": "property", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" },
"proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the STS client" },
"proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the STS client" },
@@ -44,7 +44,7 @@
"eventbridgeClient": { "kind": "parameter", "displayName": "Eventbridge Client", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To use a existing configured AWS Eventbridge as client" },
"eventPatternFile": { "kind": "parameter", "displayName": "Event Pattern File", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "EventPattern File" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": 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 starting and cause the [...]
- "operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws2.eventbridge.EvenbridgeOperations", "enum": [ "putRule", "putTarget" ], "deprecated": false, "deprecationNote": "", "secret": false, "defaultValue": "assumeRole", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": [...]
+ "operation": { "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.aws2.eventbridge.EvenbridgeOperations", "enum": [ "putRule", "putTargets" ], "deprecated": false, "deprecationNote": "", "secret": false, "defaultValue": "assumeRole", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description" [...]
"pojoRequest": { "kind": "parameter", "displayName": "Pojo Request", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "If we want to use a POJO request as body or not" },
"proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To define a proxy host when instantiating the STS client" },
"proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration", "configurationField": "configuration", "description": "To define a proxy port when instantiating the STS client" },
diff --git a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc b/components/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
similarity index 57%
copy from components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
copy to components/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
index f05455e..a319ad7 100644
--- a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
+++ b/components/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
@@ -1,9 +1,9 @@
-[[aws2-sts-component]]
-= AWS 2 Security Token Service (STS) Component
-:docTitle: AWS 2 Security Token Service (STS)
-:artifactId: camel-aws2-sts
-:description: Manage AWS STS cluster instances using AWS SDK version 2.x.
-:since: 3.5
+[[aws2-eventbridge-component]]
+= AWS 2 Eventbridge Component
+:docTitle: AWS 2 Eventbridge
+:artifactId: camel-aws2-eventbridge
+:description: Manage AWS Eventbridge cluster instances using AWS SDK version 2.x.
+:since: 3.6
:supportLevel: Preview
:component-header: Only producer is supported
//Manually maintained attributes
@@ -13,25 +13,25 @@
*{component-header}*
-The AWS2 STS component supports assumeRole operation.
-https://aws.amazon.com/sts/[AWS STS].
+The AWS2 Eventbridge component supports assumeRole operation.
+https://aws.amazon.com/eventbridge/[AWS Eventbridge].
Prerequisites
You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon STS. More information is available at
-https://aws.amazon.com/sts/[Amazon STS].
+https://aws.amazon.com/eventbridge/[Amazon Eventbridge].
[NOTE]
====
-The AWS2 STS component is not supported in OSGI
+The AWS2 Eventbridge component is not supported in OSGI
====
== URI Format
[source,java]
-------------------------
-aws2-sts://label[?options]
+aws2-eventbridge://label[?options]
-------------------------
You can append query options to the URI in the following format,
@@ -41,7 +41,7 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Security Token Service (STS) component supports 14 options, which are listed below.
+The AWS 2 Eventbridge component supports 15 options, which are listed below.
@@ -49,15 +49,16 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
|===
| Name | Description | Default | Type
| *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) | Component configuration | | STS2Configuration
+| *configuration* (producer) | Component configuration | | EventbridgeConfiguration
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *accessKey* (security) | Amazon AWS Access Key | | String
@@ -69,10 +70,10 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
// endpoint options: START
-The AWS 2 Security Token Service (STS) endpoint is configured using URI syntax:
+The AWS 2 Eventbridge endpoint is configured using URI syntax:
----
-aws2-sts:label
+aws2-eventbridge:label
----
with the following path and query parameters:
@@ -87,21 +88,22 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (15 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *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
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
@@ -110,77 +112,6 @@ with the following path and query parameters:
|===
// endpoint options: END
-
-
-Required STS component options
-
-You have to provide the amazonSTSClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/sts/[Amazon STS] service.
-
-== Usage
-
-[NOTE]
-====
-The AWS2 STS component works on the aws-global region and it has aws-global as default region
-====
-
-=== STS Producer operations
-
-Camel-AWS STS component provides the following operation on the producer side:
-
-- assumeRole
-- getSessionToken
-- getFedeationToken
-
-== Producer Examples
-
-- assumeRole: this operation will make an AWS user assume a different role temporary
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:assumeRole")
- .setHeader(STS2Constants.ROLE_ARN, constant("arn:123"))
- .setHeader(STS2Constants.ROLE_SESSION_NAME, constant("groot"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole")
---------------------------------------------------------------------------------
-
-- getSessionToken: this operation will return a temporary session token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getSessionToken")
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-- getFederationToken: this operation will return a temporary federation token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getFederationToken")
- .setHeader(STS2Constants.FEDERATED_NAME, constant("federation-account"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-== Automatic detection of StsClient client in registry
-
-The component is capable of detecting the presence of an StsClient 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.
-
-== Using a POJO as body
-
-Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as body.
-In AWS STS, as example for Assume Role request, you can do something like:
-
-------------------------------------------------------------------------------------------------------
-from("direct:createUser")
- .setBody(AssumeRoleRequest.builder().roleArn("arn:123").roleSessionName("groot").build())
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole&pojoRequest=true")
-------------------------------------------------------------------------------------------------------
-
-In this way you'll pass the request directly without the need of passing headers and options specifically related to this operation.
-
== Dependencies
Maven users will need to add the following dependency to their pom.xml.
@@ -191,11 +122,9 @@ Maven users will need to add the following dependency to their pom.xml.
---------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-aws2-sts</artifactId>
+ <artifactId>camel-aws2-eventbridge</artifactId>
<version>${camel-version}</version>
</dependency>
---------------------------------------
where `$\{camel-version}` must be replaced by the actual version of Camel.
-
-include::camel-spring-boot::page$aws2-sts-starter.adoc[]
diff --git a/components/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeProducer.java b/components/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeProducer.java
index e4e4d05f..68a91ff 100644
--- a/components/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeProducer.java
+++ b/components/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeProducer.java
@@ -61,7 +61,7 @@ public class EventbridgeProducer extends DefaultProducer {
putRule(getEndpoint().getEventbridgeClient(), exchange);
break;
case putTargets:
- putTargets(getEndpoint().getEventbridgeClient(), exchange);
+ putTargets(getEndpoint().getEventbridgeClient(), exchange);
break;
default:
throw new IllegalArgumentException("Unsupported operation");
@@ -129,43 +129,43 @@ public class EventbridgeProducer extends DefaultProducer {
}
}
- private void putTargets(EventBridgeClient eventbridgeClient, Exchange exchange) throws InvalidPayloadException {
- if (getConfiguration().isPojoRequest()) {
- Object payload = exchange.getIn().getMandatoryBody();
- if (payload instanceof PutTargetsRequest) {
- PutTargetsResponse result;
- try {
- result = eventbridgeClient.putTargets((PutTargetsRequest) payload);
- } catch (AwsServiceException ase) {
- LOG.trace("PutTargets command returned the error code {}", ase.awsErrorDetails().errorCode());
- throw ase;
- }
- Message message = getMessageForResponse(exchange);
- message.setBody(result);
- }
- } else {
- PutTargetsRequest.Builder builder = PutTargetsRequest.builder();
- if (ObjectHelper.isNotEmpty(exchange.getIn().getHeader(EventbridgeConstants.RULE_NAME))) {
- String ruleName = exchange.getIn().getHeader(EventbridgeConstants.RULE_NAME, String.class);
- builder.rule(ruleName);
- }
- if (ObjectHelper.isNotEmpty(exchange.getIn().getHeader(EventbridgeConstants.TARGETS))) {
- Collection<Target> targets = exchange.getIn().getHeader(EventbridgeConstants.TARGETS, Collection.class);
- builder.targets(targets);
- } else {
- throw new IllegalArgumentException("At least one targets must be specified");
- }
+ private void putTargets(EventBridgeClient eventbridgeClient, Exchange exchange) throws InvalidPayloadException {
+ if (getConfiguration().isPojoRequest()) {
+ Object payload = exchange.getIn().getMandatoryBody();
+ if (payload instanceof PutTargetsRequest) {
PutTargetsResponse result;
try {
- result = eventbridgeClient.putTargets(builder.build());
+ result = eventbridgeClient.putTargets((PutTargetsRequest) payload);
} catch (AwsServiceException ase) {
- LOG.trace("Put Targets command returned the error code {}", ase.awsErrorDetails().errorCode());
+ LOG.trace("PutTargets command returned the error code {}", ase.awsErrorDetails().errorCode());
throw ase;
}
Message message = getMessageForResponse(exchange);
message.setBody(result);
}
+ } else {
+ PutTargetsRequest.Builder builder = PutTargetsRequest.builder();
+ if (ObjectHelper.isNotEmpty(exchange.getIn().getHeader(EventbridgeConstants.RULE_NAME))) {
+ String ruleName = exchange.getIn().getHeader(EventbridgeConstants.RULE_NAME, String.class);
+ builder.rule(ruleName);
+ }
+ if (ObjectHelper.isNotEmpty(exchange.getIn().getHeader(EventbridgeConstants.TARGETS))) {
+ Collection<Target> targets = exchange.getIn().getHeader(EventbridgeConstants.TARGETS, Collection.class);
+ builder.targets(targets);
+ } else {
+ throw new IllegalArgumentException("At least one targets must be specified");
+ }
+ PutTargetsResponse result;
+ try {
+ result = eventbridgeClient.putTargets(builder.build());
+ } catch (AwsServiceException ase) {
+ LOG.trace("Put Targets command returned the error code {}", ase.awsErrorDetails().errorCode());
+ throw ase;
+ }
+ Message message = getMessageForResponse(exchange);
+ message.setBody(result);
}
+ }
@Override
public EventbridgeEndpoint getEndpoint() {
diff --git a/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/integration/EventbridgePutRuleIntegrationTest.java b/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/integration/EventbridgePutRuleIntegrationTest.java
index 6d38748..e931f40 100644
--- a/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/integration/EventbridgePutRuleIntegrationTest.java
+++ b/components/camel-aws2-eventbridge/src/test/java/org/apache/camel/component/aws2/eventbridge/integration/EventbridgePutRuleIntegrationTest.java
@@ -51,7 +51,7 @@ public class EventbridgePutRuleIntegrationTest extends CamelTestSupport {
@EndpointInject("mock:result")
private MockEndpoint result;
-
+
@EndpointInject("mock:result1")
private MockEndpoint result1;
@@ -67,13 +67,14 @@ public class EventbridgePutRuleIntegrationTest extends CamelTestSupport {
exchange.getIn().setHeader(EventbridgeConstants.RULE_NAME, "firstrule");
}
});
-
+
template.send("direct:evs-targets", new Processor() {
@Override
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(EventbridgeConstants.RULE_NAME, "firstrule");
- Target target = Target.builder().id("sqs-queue").arn("arn:aws:sqs:eu-west-1:780410022472:camel-connector-test").build();
+ Target target = Target.builder().id("sqs-queue").arn("arn:aws:sqs:eu-west-1:780410022472:camel-connector-test")
+ .build();
List<Target> targets = new ArrayList<Target>();
targets.add(target);
exchange.getIn().setHeader(EventbridgeConstants.TARGETS, targets);
@@ -88,7 +89,8 @@ public class EventbridgePutRuleIntegrationTest extends CamelTestSupport {
return new RouteBuilder() {
@Override
public void configure() throws Exception {
- String awsEndpoint = "aws2-eventbridge://test?operation=putRule&eventPatternFile=file:src/test/resources/eventpattern.json";
+ String awsEndpoint
+ = "aws2-eventbridge://test?operation=putRule&eventPatternFile=file:src/test/resources/eventpattern.json";
String target = "aws2-eventbridge://test?operation=putTargets";
from("direct:evs").to(awsEndpoint).log("${body}").to("mock:result");
from("direct:evs-targets").to(target).log("${body}").to("mock:result1");
diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventbridgeEndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventbridgeEndpointBuilderFactory.java
index 6316c76..3323d3b 100644
--- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventbridgeEndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventbridgeEndpointBuilderFactory.java
@@ -402,7 +402,7 @@ public interface EventbridgeEndpointBuilderFactory {
*/
enum EvenbridgeOperations {
putRule,
- putTarget;
+ putTargets;
}
/**
diff --git a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc b/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
similarity index 57%
rename from components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
rename to docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
index f05455e..ab4aa1a 100644
--- a/components/camel-aws2-eventbridge/src/main/docs/aws2-sts-component.adoc
+++ b/docs/components/modules/ROOT/pages/aws2-eventbridge-component.adoc
@@ -1,9 +1,11 @@
-[[aws2-sts-component]]
-= AWS 2 Security Token Service (STS) Component
-:docTitle: AWS 2 Security Token Service (STS)
-:artifactId: camel-aws2-sts
-:description: Manage AWS STS cluster instances using AWS SDK version 2.x.
-:since: 3.5
+[[aws2-eventbridge-component]]
+= AWS 2 Eventbridge Component
+//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
+:page-source: components/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
+:docTitle: AWS 2 Eventbridge
+:artifactId: camel-aws2-eventbridge
+:description: Manage AWS Eventbridge cluster instances using AWS SDK version 2.x.
+:since: 3.6
:supportLevel: Preview
:component-header: Only producer is supported
//Manually maintained attributes
@@ -13,25 +15,25 @@
*{component-header}*
-The AWS2 STS component supports assumeRole operation.
-https://aws.amazon.com/sts/[AWS STS].
+The AWS2 Eventbridge component supports assumeRole operation.
+https://aws.amazon.com/eventbridge/[AWS Eventbridge].
Prerequisites
You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon STS. More information is available at
-https://aws.amazon.com/sts/[Amazon STS].
+https://aws.amazon.com/eventbridge/[Amazon Eventbridge].
[NOTE]
====
-The AWS2 STS component is not supported in OSGI
+The AWS2 Eventbridge component is not supported in OSGI
====
== URI Format
[source,java]
-------------------------
-aws2-sts://label[?options]
+aws2-eventbridge://label[?options]
-------------------------
You can append query options to the URI in the following format,
@@ -41,7 +43,7 @@ You can append query options to the URI in the following format,
// component options: START
-The AWS 2 Security Token Service (STS) component supports 14 options, which are listed below.
+The AWS 2 Eventbridge component supports 15 options, which are listed below.
@@ -49,15 +51,16 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
|===
| Name | Description | Default | Type
| *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) | Component configuration | | STS2Configuration
+| *configuration* (producer) | Component configuration | | EventbridgeConfiguration
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *accessKey* (security) | Amazon AWS Access Key | | String
@@ -69,10 +72,10 @@ The AWS 2 Security Token Service (STS) component supports 14 options, which are
// endpoint options: START
-The AWS 2 Security Token Service (STS) endpoint is configured using URI syntax:
+The AWS 2 Eventbridge endpoint is configured using URI syntax:
----
-aws2-sts:label
+aws2-eventbridge:label
----
with the following path and query parameters:
@@ -87,21 +90,22 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (15 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *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
+| *eventbridgeClient* (producer) | To use a existing configured AWS Eventbridge as client | | EventBridgeClient
+| *eventPatternFile* (producer) | EventPattern File | | String
| *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 [...]
-| *operation* (producer) | *Required* The operation to perform. There are 3 enums and the value can be one of: assumeRole, getSessionToken, getFederationToken | assumeRole | STS2Operations
+| *operation* (producer) | *Required* The operation to perform. There are 2 enums and the value can be one of: putRule, putTargets | assumeRole | EvenbridgeOperations
| *pojoRequest* (producer) | If we want to use a POJO request as body or not | false | boolean
| *proxyHost* (producer) | To define a proxy host when instantiating the STS client | | String
| *proxyPort* (producer) | To define a proxy port when instantiating the STS client | | Integer
| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the STS client. There are 2 enums and the value can be one of: HTTP, HTTPS | HTTPS | Protocol
| *region* (producer) | The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() | aws-global | String
-| *stsClient* (producer) | To use a existing configured AWS STS as client | | StsClient
| *trustAllCertificates* (producer) | If we want to trust all certificates in case of overriding the endpoint | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
@@ -110,77 +114,6 @@ with the following path and query parameters:
|===
// endpoint options: END
-
-
-Required STS component options
-
-You have to provide the amazonSTSClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/sts/[Amazon STS] service.
-
-== Usage
-
-[NOTE]
-====
-The AWS2 STS component works on the aws-global region and it has aws-global as default region
-====
-
-=== STS Producer operations
-
-Camel-AWS STS component provides the following operation on the producer side:
-
-- assumeRole
-- getSessionToken
-- getFedeationToken
-
-== Producer Examples
-
-- assumeRole: this operation will make an AWS user assume a different role temporary
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:assumeRole")
- .setHeader(STS2Constants.ROLE_ARN, constant("arn:123"))
- .setHeader(STS2Constants.ROLE_SESSION_NAME, constant("groot"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole")
---------------------------------------------------------------------------------
-
-- getSessionToken: this operation will return a temporary session token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getSessionToken")
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-- getFederationToken: this operation will return a temporary federation token
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:getFederationToken")
- .setHeader(STS2Constants.FEDERATED_NAME, constant("federation-account"))
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=getSessionToken")
---------------------------------------------------------------------------------
-
-== Automatic detection of StsClient client in registry
-
-The component is capable of detecting the presence of an StsClient 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.
-
-== Using a POJO as body
-
-Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as body.
-In AWS STS, as example for Assume Role request, you can do something like:
-
-------------------------------------------------------------------------------------------------------
-from("direct:createUser")
- .setBody(AssumeRoleRequest.builder().roleArn("arn:123").roleSessionName("groot").build())
- .to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole&pojoRequest=true")
-------------------------------------------------------------------------------------------------------
-
-In this way you'll pass the request directly without the need of passing headers and options specifically related to this operation.
-
== Dependencies
Maven users will need to add the following dependency to their pom.xml.
@@ -191,11 +124,9 @@ Maven users will need to add the following dependency to their pom.xml.
---------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-aws2-sts</artifactId>
+ <artifactId>camel-aws2-eventbridge</artifactId>
<version>${camel-version}</version>
</dependency>
---------------------------------------
where `$\{camel-version}` must be replaced by the actual version of Camel.
-
-include::camel-spring-boot::page$aws2-sts-starter.adoc[]