This is an automated email from the ASF dual-hosted git repository. Croway pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit d920828992fe96de47c0c3db4d9de25dc064408f Author: croway <[email protected]> AuthorDate: Tue Sep 15 13:27:17 2026 +0200 Add camel-camunda-starter camel-camunda has been in Camel core since 4.19.0 but never got a Spring Boot starter. Generate it with starter-create and regenerate the docs, catalog and dependencies BOM entries. Add a smoke test that verifies camel.component.camunda.* Spring Boot properties are copied onto the CamundaComponent bean by the starter. Co-Authored-By: Claude Sonnet 5 <[email protected]> --- .../camel/springboot/catalog/components.properties | 1 + .../springboot/catalog/components/camunda.json | 58 ++++++ components-starter/camel-camunda-starter/pom.xml | 48 +++++ .../src/main/docs/camunda.json | 98 ++++++++++ .../CamundaComponentAutoConfiguration.java | 74 ++++++++ .../springboot/CamundaComponentConfiguration.java | 182 ++++++++++++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ ...rk.boot.autoconfigure.AutoConfiguration.imports | 17 ++ .../CamundaComponentAutoConfigurationTest.java | 57 ++++++ components-starter/pom.xml | 1 + docs/spring-boot/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/starters/camunda.adoc | 42 +++++ tooling/camel-spring-boot-dependencies/pom.xml | 10 + 14 files changed, 803 insertions(+) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties index 09fffc8e95e..e466750012a 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties @@ -73,6 +73,7 @@ braintree browse caffeine-cache caffeine-loadcache +camunda chatscript chunk class diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/camunda.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/camunda.json new file mode 100644 index 00000000000..38eb8611906 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/camunda.json @@ -0,0 +1,58 @@ +{ + "component": { + "kind": "component", + "name": "camunda", + "title": "Camunda", + "description": "Interact with Camunda 8 Orchestration Clusters using the Camunda Java Client.", + "deprecated": false, + "firstVersion": "4.19.0", + "label": "workflow,saas", + "javaType": "org.apache.camel.component.camunda.CamundaComponent", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-camunda-starter", + "version": "4.23.0-SNAPSHOT", + "scheme": "camunda", + "extendsScheme": "", + "syntax": "camunda:operationName", + "async": false, + "api": false, + "consumerOnly": false, + "producerOnly": false, + "lenientProperties": false, + "browsable": false, + "remote": true + }, + "componentProperties": { + "grpcAddress": { "index": 0, "kind": "property", "displayName": "Grpc Address", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "http:\/\/localhost:26500", "description": "gRPC address of the Camunda cluster (e.g. http:\/\/localhost:26500). Used for self-managed connections when clusterId is not set." }, + "restAddress": { "index": 1, "kind": "property", "displayName": "Rest Address", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "http:\/\/localhost:8080", "description": "REST address of the Camunda cluster (e.g. http:\/\/localhost:8080). Used for self-managed connections when clusterId is not set." }, + "bridgeErrorHandler": { "index": 2, "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the like [...] + "lazyStartProducer": { "index": 3, "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 [...] + "autowiredEnabled": { "index": 4, "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 t [...] + "clientId": { "index": 5, "kind": "property", "displayName": "Client Id", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "security": "secret", "description": "Client ID for OAuth \/ SaaS authentication." }, + "clientSecret": { "index": 6, "kind": "property", "displayName": "Client Secret", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "security": "secret", "description": "Client secret for OAuth \/ SaaS authentication." }, + "clusterId": { "index": 7, "kind": "property", "displayName": "Cluster Id", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Camunda SaaS cluster ID. When set, the client connects via the cloud builder." }, + "oAuthAPI": { "index": 8, "kind": "property", "displayName": "OAuth API", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "OAuth authorization server URL for self-managed authentication." }, + "region": { "index": 9, "kind": "property", "displayName": "Region", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "bru-2", "description": "Camunda SaaS region (default: bru-2)." } + }, + "headers": { + "CamelCamundaJobKey": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Job key for the worker job", "constantName": "org.apache.camel.component.camunda.CamundaConstants#JOB_KEY" }, + "CamelCamundaResourceName": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Resource name for deploy operation", "constantName": "org.apache.camel.component.camunda.CamundaConstants#RESOURCE_NAME" }, + "CamelCamundaIsSuccess": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Indicates if the operation was successful", "constantName": "org.apache.camel.component.camunda.CamundaConstants#IS_SUCCESS" }, + "CamelCamundaErrorMessage": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Error message if operation failed", "constantName": "org.apache.camel.component.camunda.CamundaConstants#ERROR_MESSAGE" }, + "CamelCamundaErrorCode": { "index": 4, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Error code if operation failed", "constantName": "org.apache.camel.component.camunda.CamundaConstants#ERROR_CODE" }, + "CamelCamundaBPMNProcessId": { "index": 5, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The process ID of a deployed process", "constantName": "org.apache.camel.component.camunda.CamundaConstants#BPMN_PROCESS_ID" }, + "CamelCamundaVersion": { "index": 6, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The version of a deployed process", "constantName": "org.apache.camel.component.camunda.CamundaConstants#VERSION" }, + "CamelCamundaProcessDefinitionKey": { "index": 7, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The process definition key of a deployed process", "constantName": "org.apache.camel.component.camunda.CamundaConstants#PROCESS_DEFINITION_KEY" } + }, + "properties": { + "operationName": { "index": 0, "kind": "path", "displayName": "Operation Name", "group": "common", "label": "common", "required": true, "type": "enum", "javaType": "org.apache.camel.component.camunda.internal.OperationName", "enum": [ "startProcess", "cancelProcess", "publishMessage", "completeJob", "failJob", "updateJobRetries", "worker", "throwError", "deployResource" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation t [...] + "formatJSON": { "index": 1, "kind": "parameter", "displayName": "Format JSON", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Format the result in the body as JSON." }, + "jobType": { "index": 2, "kind": "parameter", "displayName": "Job Type", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Job type for the job worker." }, + "timeout": { "index": 3, "kind": "parameter", "displayName": "Timeout", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": 10, "description": "Timeout for job worker in seconds." }, + "bridgeErrorHandler": { "index": 4, "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming [...] + "exceptionHandler": { "index": 5, "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By def [...] + "exchangePattern": { "index": 6, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, + "lazyStartProducer": { "index": 7, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a produc [...] + } +} diff --git a/components-starter/camel-camunda-starter/pom.xml b/components-starter/camel-camunda-starter/pom.xml new file mode 100644 index 00000000000..d0ed46721ba --- /dev/null +++ b/components-starter/camel-camunda-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>4.23.0-SNAPSHOT</version> + </parent> + <artifactId>camel-camunda-starter</artifactId> + <packaging>jar</packaging> + <name>Camel SB Starters :: camunda</name> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-camunda</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-camunda-starter/src/main/docs/camunda.json b/components-starter/camel-camunda-starter/src/main/docs/camunda.json new file mode 100644 index 00000000000..c82cada8c51 --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/docs/camunda.json @@ -0,0 +1,98 @@ +{ + "groups": [ + { + "name": "camel.component.camunda", + "type": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.customizer", + "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "sourceMethod": "getCustomizer()" + } + ], + "properties": [ + { + "name": "camel.component.camunda.autowired-enabled", + "type": "java.lang.Boolean", + "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 then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": true + }, + { + "name": "camel.component.camunda.bridge-error-handler", + "type": "java.lang.Boolean", + "description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is n [...] + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.camunda.client-id", + "type": "java.lang.String", + "description": "Client ID for OAuth \/ SaaS authentication.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.client-secret", + "type": "java.lang.String", + "description": "Client secret for OAuth \/ SaaS authentication.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.cluster-id", + "type": "java.lang.String", + "description": "Camunda SaaS cluster ID. When set, the client connects via the cloud builder.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.customizer.enabled", + "type": "java.lang.Boolean", + "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" + }, + { + "name": "camel.component.camunda.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable auto configuration of the camunda component. This is enabled by default.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.grpc-address", + "type": "java.lang.String", + "description": "gRPC address of the Camunda cluster (e.g. http:\/\/localhost:26500). Used for self-managed connections when clusterId is not set.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": "http:\/\/localhost:26500" + }, + { + "name": "camel.component.camunda.lazy-start-producer", + "type": "java.lang.Boolean", + "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 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 starting the [...] + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.camunda.o-auth-a-p-i", + "type": "java.lang.String", + "description": "OAuth authorization server URL for self-managed authentication.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration" + }, + { + "name": "camel.component.camunda.region", + "type": "java.lang.String", + "description": "Camunda SaaS region (default: bru-2).", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": "bru-2" + }, + { + "name": "camel.component.camunda.rest-address", + "type": "java.lang.String", + "description": "REST address of the Camunda cluster (e.g. http:\/\/localhost:8080). Used for self-managed connections when clusterId is not set.", + "sourceType": "org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration", + "defaultValue": "http:\/\/localhost:8080" + } + ], + "hints": [], + "ignored": { + "properties": [] + } +} \ No newline at end of file diff --git a/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfiguration.java b/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfiguration.java new file mode 100644 index 00000000000..e6a9f052cee --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfiguration.java @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.camunda.springboot; + +import org.apache.camel.CamelContext; +import org.apache.camel.Component; +import org.apache.camel.component.camunda.CamundaComponent; +import org.apache.camel.spi.ComponentCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.ComponentConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@AutoConfiguration(after = CamelAutoConfiguration.class) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({ComponentConfigurationProperties.class,CamundaComponentConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.component", "camel.component.camunda"}) +public class CamundaComponentAutoConfiguration { + + private final ApplicationContext applicationContext; + private final CamundaComponentConfiguration configuration; + + public CamundaComponentAutoConfiguration( + org.springframework.context.ApplicationContext applicationContext, + org.apache.camel.component.camunda.springboot.CamundaComponentConfiguration configuration) { + this.applicationContext = applicationContext; + this.configuration = configuration; + } + + @Lazy + @Bean + public ComponentCustomizer configureCamundaComponent() { + return new ComponentCustomizer() { + @Override + public void configure(String name, Component target) { + CamelPropertiesHelper.copyConfigurationProperties(target.getCamelContext(), applicationContext, + "camel.component.camunda", configuration, target); + } + @Override + public boolean isEnabled(String name, Component target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.component.customizer", + "camel.component.camunda.customizer") + && target instanceof CamundaComponent; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentConfiguration.java b/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentConfiguration.java new file mode 100644 index 00000000000..66d1695a756 --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/java/org/apache/camel/component/camunda/springboot/CamundaComponentConfiguration.java @@ -0,0 +1,182 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.camunda.springboot; + +import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Interact with Camunda 8 Orchestration Clusters using the Camunda Java Client. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@ConfigurationProperties(prefix = "camel.component.camunda") +public class CamundaComponentConfiguration + extends + ComponentConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the camunda component. This is + * enabled by default. + */ + private Boolean enabled; + /** + * gRPC address of the Camunda cluster (e.g. http://localhost:26500). Used + * for self-managed connections when clusterId is not set. + */ + private String grpcAddress = "http://localhost:26500";; + /** + * REST address of the Camunda cluster (e.g. http://localhost:8080). Used + * for self-managed connections when clusterId is not set. + */ + private String restAddress = "http://localhost:8080";; + /** + * Allows for bridging the consumer to the Camel routing Error Handler, + * which mean any exceptions (if possible) occurred while the Camel consumer + * is trying to pickup incoming messages, or the likes, will now be + * processed as a message and handled by the routing Error Handler. + * Important: This is only possible if the 3rd party component allows Camel + * to be alerted if an exception was thrown. Some components handle this + * internally only, and therefore bridgeErrorHandler is not possible. In + * other situations we may improve the Camel component to hook into the 3rd + * party component and make this possible for future releases. By default + * the consumer will use the org.apache.camel.spi.ExceptionHandler to deal + * with exceptions, that will be logged at WARN or ERROR level and ignored. + */ + private Boolean bridgeErrorHandler = false; + /** + * 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 starting the producer may take a little time + * and prolong the total processing time of the processing. + */ + private Boolean lazyStartProducer = false; + /** + * 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. + */ + private Boolean autowiredEnabled = true; + /** + * Client ID for OAuth / SaaS authentication. + */ + private String clientId; + /** + * Client secret for OAuth / SaaS authentication. + */ + private String clientSecret; + /** + * Camunda SaaS cluster ID. When set, the client connects via the cloud + * builder. + */ + private String clusterId; + /** + * OAuth authorization server URL for self-managed authentication. + */ + private String oAuthAPI; + /** + * Camunda SaaS region (default: bru-2). + */ + private String region = "bru-2"; + + public String getGrpcAddress() { + return grpcAddress; + } + + public void setGrpcAddress(String grpcAddress) { + this.grpcAddress = grpcAddress; + } + + public String getRestAddress() { + return restAddress; + } + + public void setRestAddress(String restAddress) { + this.restAddress = restAddress; + } + + public Boolean getBridgeErrorHandler() { + return bridgeErrorHandler; + } + + public void setBridgeErrorHandler(Boolean bridgeErrorHandler) { + this.bridgeErrorHandler = bridgeErrorHandler; + } + + public Boolean getLazyStartProducer() { + return lazyStartProducer; + } + + public void setLazyStartProducer(Boolean lazyStartProducer) { + this.lazyStartProducer = lazyStartProducer; + } + + public Boolean getAutowiredEnabled() { + return autowiredEnabled; + } + + public void setAutowiredEnabled(Boolean autowiredEnabled) { + this.autowiredEnabled = autowiredEnabled; + } + + public String getClientId() { + return clientId; + } + + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public String getClientSecret() { + return clientSecret; + } + + public void setClientSecret(String clientSecret) { + this.clientSecret = clientSecret; + } + + public String getClusterId() { + return clusterId; + } + + public void setClusterId(String clusterId) { + this.clusterId = clusterId; + } + + public String getOAuthAPI() { + return oAuthAPI; + } + + public void setOAuthAPI(String oAuthAPI) { + this.oAuthAPI = oAuthAPI; + } + + public String getRegion() { + return region; + } + + public void setRegion(String region) { + this.region = region; + } +} \ No newline at end of file diff --git a/components-starter/camel-camunda-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-camunda-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-camunda-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-camunda-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-camunda-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/components-starter/camel-camunda-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000000..07dd2ed54e1 --- /dev/null +++ b/components-starter/camel-camunda-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,17 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +org.apache.camel.component.camunda.springboot.CamundaComponentAutoConfiguration diff --git a/components-starter/camel-camunda-starter/src/test/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfigurationTest.java b/components-starter/camel-camunda-starter/src/test/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfigurationTest.java new file mode 100644 index 00000000000..a97285f057b --- /dev/null +++ b/components-starter/camel-camunda-starter/src/test/java/org/apache/camel/component/camunda/springboot/CamundaComponentAutoConfigurationTest.java @@ -0,0 +1,57 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.camunda.springboot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +import org.apache.camel.CamelContext; +import org.apache.camel.component.camunda.CamundaComponent; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.test.spring.junit6.CamelSpringBootTest; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; + +@DirtiesContext +@CamelSpringBootTest +@SpringBootTest(classes = { CamelAutoConfiguration.class, CamundaComponentAutoConfiguration.class }, + properties = { + "camel.component.camunda.grpc-address = http://localhost:26500";, + "camel.component.camunda.rest-address = http://localhost:8080";, + "camel.component.camunda.client-id = demo-client", + "camel.component.camunda.region = demo-region" }) +public class CamundaComponentAutoConfigurationTest { + + @Autowired + CamelContext context; + + @Test + public void componentIsAutoConfigured() { + CamundaComponent component = assertInstanceOf(CamundaComponent.class, context.getComponent("camunda")); + + // set through camel.component.camunda.*, so this asserts the Spring Boot + // properties are copied onto the component by the starter + assertEquals("http://localhost:26500";, component.getGrpcAddress()); + assertEquals("http://localhost:8080";, component.getRestAddress()); + assertEquals("demo-client", component.getClientId()); + assertEquals("demo-region", component.getRegion()); + } +} diff --git a/components-starter/pom.xml b/components-starter/pom.xml index fbcfc75fbd4..34beebd88a0 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -182,6 +182,7 @@ <module>camel-braintree-starter</module> <module>camel-browse-starter</module> <module>camel-caffeine-starter</module> + <module>camel-camunda-starter</module> <module>camel-cassandraql-starter</module> <module>camel-cbor-starter</module> <module>camel-chatscript-starter</module> diff --git a/docs/spring-boot/modules/ROOT/nav.adoc b/docs/spring-boot/modules/ROOT/nav.adoc index 442e36d4369..180b006a4a0 100644 --- a/docs/spring-boot/modules/ROOT/nav.adoc +++ b/docs/spring-boot/modules/ROOT/nav.adoc @@ -81,6 +81,7 @@ ** xref:starters/braintree.adoc[Braintree] ** xref:starters/browse.adoc[Browse] ** xref:starters/caffeine.adoc[Caffeine Cache] +** xref:starters/camunda.adoc[Camunda] ** xref:starters/cassandraql.adoc[Cassandra CQL] ** xref:starters/cbor.adoc[CBOR] ** xref:starters/chatscript.adoc[ChatScript] diff --git a/docs/spring-boot/modules/ROOT/pages/starters/camunda.adoc b/docs/spring-boot/modules/ROOT/pages/starters/camunda.adoc new file mode 100644 index 00000000000..6ed6709c8ed --- /dev/null +++ b/docs/spring-boot/modules/ROOT/pages/starters/camunda.adoc @@ -0,0 +1,42 @@ +// Do not edit directly! +// This file was generated by camel-spring-boot-generator-maven-plugin += Camunda +:artifactid: camel-camunda-starter + +Interact with Camunda 8 Orchestration Clusters using the Camunda Java Client. + +== What's inside + +* xref:{csb-camel-components}::camunda-component.adoc[Camunda component], URI syntax: `camunda:operationName` + +Please refer to the above links for usage and configuration details. + +== Maven coordinates + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-camunda-starter</artifactId> +</dependency> +---- + +== Spring Boot Auto-Configuration + +The starter supports 11 options, which are listed below. + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| camel.component.camunda.autowired-enabled | 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 +| camel.component.camunda.bridge-error-handler | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and theref [...] +| camel.component.camunda.client-id | Client ID for OAuth / SaaS authentication. | | String +| camel.component.camunda.client-secret | Client secret for OAuth / SaaS authentication. | | String +| camel.component.camunda.cluster-id | Camunda SaaS cluster ID. When set, the client connects via the cloud builder. | | String +| camel.component.camunda.enabled | Whether to enable auto configuration of the camunda component. This is enabled by default. | | Boolean +| camel.component.camunda.grpc-address | gRPC address of the Camunda cluster (e.g. http://localhost:26500). Used for self-managed connections when clusterId is not set. | http://localhost:26500 | String +| camel.component.camunda.lazy-start-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 [...] +| camel.component.camunda.o-auth-a-p-i | OAuth authorization server URL for self-managed authentication. | | String +| camel.component.camunda.region | Camunda SaaS region (default: bru-2). | bru-2 | String +| camel.component.camunda.rest-address | REST address of the Camunda cluster (e.g. http://localhost:8080). Used for self-managed connections when clusterId is not set. | http://localhost:8080 | String +|=== diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index 1b76dd5af13..9fd532935b5 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -65,6 +65,11 @@ <artifactId>sls20201230</artifactId> <version>5.18.1</version> </dependency> + <dependency> + <groupId>com.aliyun</groupId> + <artifactId>tea</artifactId> + <version>1.4.2</version> + </dependency> <dependency> <groupId>com.aliyun</groupId> <artifactId>tea-openapi</artifactId> @@ -732,6 +737,11 @@ <artifactId>camel-caffeine-starter</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-camunda-starter</artifactId> + <version>${project.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-cassandraql-starter</artifactId>
