-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CAMEL-19847 - Camel-Thymeleaf: Create a SB starter (#934)
Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
- Loading branch information
Showing
14 changed files
with
599 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -297,6 +297,7 @@ string-template | |
| stub | ||
| telegram | ||
| thrift | ||
| thymeleaf | ||
| tika | ||
| timer | ||
| twilio | ||
|
|
||
49 changes: 49 additions & 0 deletions
49
...ringboot/src/main/resources/org/apache/camel/springboot/catalog/components/thymeleaf.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| { | ||
| "component": { | ||
| "kind": "component", | ||
| "name": "thymeleaf", | ||
| "title": "Thymeleaf", | ||
| "description": "Transform messages using a Thymeleaf template.", | ||
| "deprecated": false, | ||
| "firstVersion": "1.0.0", | ||
| "label": "transformation", | ||
| "javaType": "org.apache.camel.component.thymeleaf.ThymeleafComponent", | ||
| "supportLevel": "Stable", | ||
| "groupId": "org.apache.camel.springboot", | ||
| "artifactId": "camel-thymeleaf-starter", | ||
| "version": "4.1.0-SNAPSHOT", | ||
| "scheme": "thymeleaf", | ||
| "extendsScheme": "", | ||
| "syntax": "thymeleaf:templatePath", | ||
| "async": false, | ||
| "api": false, | ||
| "consumerOnly": false, | ||
| "producerOnly": true, | ||
| "lenientProperties": false | ||
| }, | ||
| "componentProperties": { | ||
| "lazyStartProducer": { "index": 0, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during 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." }, | ||
| "autowiredEnabled": { "index": 1, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." } | ||
| }, | ||
| "headers": { | ||
| "CamelThymeleafResourceUri": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the Thymeleaf template.", "constantName": "org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_RESOURCE_URI" }, | ||
| "CamelThymeleafTemplate": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The content of the Thymeleaf template.", "constantName": "org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_TEMPLATE" }, | ||
| "CamelThymeleafVariableMap": { "index": 2, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Map<String, Object>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The value of this header should be a Map with key\/values that will be override any existing key with the same name. This can be used to preconfigure common key\/values you want to reuse in your Thymeleaf endpoints.", "constantName": "org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_VARIABLE_MAP" }, | ||
| "CamelThymeleafServletContext": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "jakarta.servlet.ServletContext", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The ServletContext for a web application.", "constantName": "org.apache.camel.component.thymeleaf.ThymeleafConstants#THYMELEAF_SERVLET_CONTEXT" } | ||
| }, | ||
| "properties": { | ||
| "resourceUri": { "index": 0, "kind": "path", "displayName": "Resource Uri", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "supportFileReference": true, "description": "Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod." }, | ||
| "allowContextMapAll": { "index": 1, "kind": "parameter", "displayName": "Allow Context Map All", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API." }, | ||
| "cacheable": { "index": 2, "kind": "parameter", "displayName": "Cacheable", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Whether templates have to be considered cacheable or not." }, | ||
| "cacheTimeToLive": { "index": 3, "kind": "parameter", "displayName": "Cache Time To Live", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Long", "deprecated": false, "autowired": false, "secret": false, "description": "The cache Time To Live for templates, expressed in milliseconds." }, | ||
| "checkExistence": { "index": 4, "kind": "parameter", "displayName": "Check Existence", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "description": "Whether a template resources will be checked for existence before being returned." }, | ||
| "contentCache": { "index": 5, "kind": "parameter", "displayName": "Content Cache", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Sets whether to use resource content cache or not" }, | ||
| "encoding": { "index": 6, "kind": "parameter", "displayName": "Encoding", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The character encoding to be used for reading template resources." }, | ||
| "order": { "index": 7, "kind": "parameter", "displayName": "Order", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "The order in which this template will be resolved as part of the resolver chain." }, | ||
| "prefix": { "index": 8, "kind": "parameter", "displayName": "Prefix", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "An optional prefix added to template names to convert them into resource names." }, | ||
| "resolver": { "index": 9, "kind": "parameter", "displayName": "Resolver", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.thymeleaf.ThymeleafResolverType", "enum": [ "CLASS_LOADER", "DEFAULT", "FILE", "STRING", "URL", "WEB_APP" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "CLASS_LOADER", "description": "The type of resolver to be used by the template engine." }, | ||
| "suffix": { "index": 10, "kind": "parameter", "displayName": "Suffix", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "An optional suffix added to template names to convert them into resource names." }, | ||
| "templateMode": { "index": 11, "kind": "parameter", "displayName": "Template Mode", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The template mode to be applied to templates." }, | ||
| "lazyStartProducer": { "index": 12, "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 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." } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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.1.0-SNAPSHOT</version> | ||
| </parent> | ||
| <artifactId>camel-thymeleaf-starter</artifactId> | ||
| <packaging>jar</packaging> | ||
| <name>Camel SB Starters :: Thymeleaf</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-thymeleaf</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> |
43 changes: 43 additions & 0 deletions
43
components-starter/camel-thymeleaf-starter/src/main/docs/thymeleaf.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| { | ||
| "groups": [ | ||
| { | ||
| "name": "camel.component.thymeleaf", | ||
| "type": "org.apache.camel.component.thymeleaf.springboot.ThymeleafComponentConfiguration", | ||
| "sourceType": "org.apache.camel.component.thymeleaf.springboot.ThymeleafComponentConfiguration" | ||
| }, | ||
| { | ||
| "name": "camel.component.thymeleaf.customizer", | ||
| "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", | ||
| "sourceType": "org.apache.camel.component.thymeleaf.springboot.ThymeleafComponentConfiguration", | ||
| "sourceMethod": "getCustomizer()" | ||
| } | ||
| ], | ||
| "properties": [ | ||
| { | ||
| "name": "camel.component.thymeleaf.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.thymeleaf.springboot.ThymeleafComponentConfiguration", | ||
| "defaultValue": true | ||
| }, | ||
| { | ||
| "name": "camel.component.thymeleaf.customizer.enabled", | ||
| "type": "java.lang.Boolean", | ||
| "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" | ||
| }, | ||
| { | ||
| "name": "camel.component.thymeleaf.enabled", | ||
| "type": "java.lang.Boolean", | ||
| "description": "Whether to enable auto configuration of the thymeleaf component. This is enabled by default.", | ||
| "sourceType": "org.apache.camel.component.thymeleaf.springboot.ThymeleafComponentConfiguration" | ||
| }, | ||
| { | ||
| "name": "camel.component.thymeleaf.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 producer may take a little time and prolong the total processing time of the processing.", | ||
| "sourceType": "org.apache.camel.component.thymeleaf.springboot.ThymeleafComponentConfiguration", | ||
| "defaultValue": false | ||
| } | ||
| ], | ||
| "hints": [] | ||
| } |
77 changes: 77 additions & 0 deletions
77
.../org/apache/camel/component/thymeleaf/springboot/ThymeleafComponentAutoConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * 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.thymeleaf.springboot; | ||
|
|
||
| import org.apache.camel.CamelContext; | ||
| import org.apache.camel.Component; | ||
| import org.apache.camel.component.thymeleaf.ThymeleafComponent; | ||
| 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.beans.factory.annotation.Autowired; | ||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| 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.Configuration; | ||
| import org.springframework.context.annotation.Lazy; | ||
|
|
||
| /** | ||
| * Generated by camel-package-maven-plugin - do not edit this file! | ||
| */ | ||
| @Configuration(proxyBeanMethods = false) | ||
| @Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) | ||
| @EnableConfigurationProperties({ComponentConfigurationProperties.class,ThymeleafComponentConfiguration.class}) | ||
| @ConditionalOnHierarchicalProperties({"camel.component", "camel.component.thymeleaf"}) | ||
| @AutoConfigureAfter(CamelAutoConfiguration.class) | ||
| public class ThymeleafComponentAutoConfiguration { | ||
|
|
||
| @Autowired | ||
| private ApplicationContext applicationContext; | ||
| private final CamelContext camelContext; | ||
| @Autowired | ||
| private ThymeleafComponentConfiguration configuration; | ||
|
|
||
| public ThymeleafComponentAutoConfiguration( | ||
| org.apache.camel.CamelContext camelContext) { | ||
| this.camelContext = camelContext; | ||
| } | ||
|
|
||
| @Lazy | ||
| @Bean | ||
| public ComponentCustomizer configureThymeleafComponent() { | ||
| return new ComponentCustomizer() { | ||
| @Override | ||
| public void configure(String name, Component target) { | ||
| CamelPropertiesHelper.copyProperties(camelContext, configuration, target); | ||
| } | ||
| @Override | ||
| public boolean isEnabled(String name, Component target) { | ||
| return HierarchicalPropertiesEvaluator.evaluate( | ||
| applicationContext, | ||
| "camel.component.customizer", | ||
| "camel.component.thymeleaf.customizer") | ||
| && target instanceof ThymeleafComponent; | ||
| } | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.