This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit daaaa7591e25bfb16365d5779c9f922d548c6248 Author: Claus Ibsen <[email protected]> AuthorDate: Mon Oct 26 20:35:11 2026 +0100 chore: add camel-hibernate-starter Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]> --- .../camel/springboot/catalog/components.properties | 1 + .../springboot/catalog/components/hibernate.json | 77 ++++++++ components-starter/camel-hibernate-starter/pom.xml | 48 +++++ .../src/main/docs/hibernate.json | 78 ++++++++ .../HibernateComponentAutoConfiguration.java | 74 ++++++++ .../HibernateComponentConfiguration.java | 149 +++++++++++++++ .../springboot/HibernateComponentConverter.java | 53 ++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ ...rk.boot.autoconfigure.AutoConfiguration.imports | 18 ++ components-starter/pom.xml | 1 + docs/spring-boot/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/starters/hibernate.adoc | 38 ++++ tooling/camel-spring-boot-bom/pom.xml | 5 + tooling/camel-spring-boot-dependencies/pom.xml | 5 + 15 files changed, 762 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 a3e9a00df33..efb76aa927c 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 @@ -172,6 +172,7 @@ hazelcast-ringbuffer hazelcast-seda hazelcast-set hazelcast-topic +hibernate hivemq http https diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/hibernate.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/hibernate.json new file mode 100644 index 00000000000..b4514742597 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/hibernate.json @@ -0,0 +1,77 @@ +{ + "component": { + "kind": "component", + "name": "hibernate", + "title": "Hibernate", + "description": "Execute selection and mutation queries and natural-id lookups using Hibernate ORM.", + "deprecated": false, + "firstVersion": "4.24.0", + "label": "database", + "javaType": "org.apache.camel.component.hibernate.HibernateComponent", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-hibernate-starter", + "version": "4.24.0-SNAPSHOT", + "scheme": "hibernate", + "extendsScheme": "", + "syntax": "hibernate:entityClassName", + "async": false, + "api": false, + "consumerOnly": false, + "producerOnly": false, + "lenientProperties": false, + "browsable": false, + "remote": true + }, + "componentProperties": { + "dataSource": { "index": 0, "kind": "property", "displayName": "Data Source", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "description": "The DataSource to use for bootstrapping the SessionFactory (bean reference or registry name)." }, + "hibernateProperties": { "index": 1, "kind": "property", "displayName": "Hibernate Properties", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "Arbitrary Hibernate configuration properties passthrough map." }, + "schemaAction": { "index": 2, "kind": "property", "displayName": "Schema Action", "group": "common", "label": "", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "none", "validate", "update", "create", "create-drop", "create-only", "drop" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "Schema generation action: none, validate, update, create, create-drop, create-only, drop." }, + "sessionFactory": { "index": 3, "kind": "property", "displayName": "Session Factory", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hibernate.SessionFactory", "deprecated": false, "autowired": false, "secret": false, "description": "The Hibernate SessionFactory to use." }, + "bridgeErrorHandler": { "index": 4, "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": 5, "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": 6, "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 [...] + }, + "headers": { + "CamelHibernateParameters": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Map<String, Object>", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Map of named parameters to bind to the Hibernate query, or to override natural-id lookup values.", "constantName": "org.apache.camel.component.hibernate.HibernateConstants#HIBERNATE_PARAMETERS" } + }, + "bodyTypes": { + "consumerOut": { "carriers": [ "pojo" ], "javaTypeOption": "entityClassName", "description": "The configured selection query emits one entity per message." }, + "producerIn": { "carriers": [ "any" ], "byOption": [ { "option": "statelessOperation", "value": "*", "carriers": [ "pojo" ] } ], "description": "Stateless insert\/upsert consumes the entity in the message body. For selection and mutation queries, the body is not used; named parameters come from the CamelHibernateParameters header. Natural-id values can be configured on the endpoint or supplied in that header." }, + "producerOut": { "carriers": [ "pojo", "list", "value", "null", "unchanged" ], "byOption": [ { "option": "streaming", "value": "true", "carriers": [ "iterator" ] } ], "description": "The result depends on the operation: a selection query returns a list, or a java.util.stream.Stream when streaming=true; a mutation query returns the affected-row count; a natural-id lookup returns the entity or null; stateless operations leave the body unchanged." } + }, + "properties": { + "entityClassName": { "index": 0, "kind": "path", "displayName": "Entity Class Name", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Target entity class name" }, + "filters": { "index": 1, "kind": "parameter", "displayName": "Filters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>>", "prefix": "filter.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "Hibernate filters and their parameter values. This is a multi-value option with prefix: filter." }, + "readOnly": { "index": 2, "kind": "parameter", "displayName": "Read Only", "group": "common", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the Hibernate session and selection query should be read-only." }, + "selectionQuery": { "index": 3, "kind": "parameter", "displayName": "Selection Query", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The HQL selection query to execute." }, + "tenantIdentifier": { "index": 4, "kind": "parameter", "displayName": "Tenant Identifier", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The tenant identifier used to create the Hibernate session." }, + "consumeDelete": { "index": 5, "kind": "parameter", "displayName": "Consume Delete", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to delete consumed entities after successful processing." }, + "maximumResults": { "index": 6, "kind": "parameter", "displayName": "Maximum Results", "group": "consumer", "label": "consumer", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The maximum number of entities to retrieve in a single poll." }, + "sendEmptyMessageWhenIdle": { "index": 7, "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." }, + "skipLocked": { "index": 8, "kind": "parameter", "displayName": "Skip Locked", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the consumer should skip rows that are already locked by another consumer." }, + "bridgeErrorHandler": { "index": 9, "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": 10, "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 de [...] + "exchangePattern": { "index": 11, "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." }, + "pollStrategy": { "index": 12, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the po [...] + "mutationQuery": { "index": 13, "kind": "parameter", "displayName": "Mutation Query", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The HQL mutation query to execute." }, + "naturalIdParameters": { "index": 14, "kind": "parameter", "displayName": "Natural Id Parameters", "group": "producer", "label": "producer", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "naturalId.", "multiValue": true, "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "supportSimpleExpression": true, "description": "The natural-id property values used for lookup. String values can use S [...] + "statelessOperation": { "index": 15, "kind": "parameter", "displayName": "Stateless Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.hibernate.HibernateEndpoint.StatelessOperation", "enum": [ "INSERT", "UPSERT" ], "deprecated": false, "autowired": false, "secret": false, "description": "Stateless operation to perform: insert or upsert." }, + "streaming": { "index": 16, "kind": "parameter", "displayName": "Streaming", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether selection query results should be returned as a stream." }, + "lazyStartProducer": { "index": 17, "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 produ [...] + "backoffErrorThreshold": { "index": 18, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, + "backoffIdleThreshold": { "index": 19, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, + "backoffMultiplier": { "index": 20, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is h [...] + "delay": { "index": 21, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, + "greedy": { "index": 22, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, + "initialDelay": { "index": 23, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, + "repeatCount": { "index": 24, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." }, + "runLoggingLevel": { "index": 25, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the log [...] + "scheduledExecutorService": { "index": 26, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, + "scheduler": { "index": 27, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, + "schedulerProperties": { "index": 28, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This i [...] + "startScheduler": { "index": 29, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, + "timeUnit": { "index": 30, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, + "useFixedDelay": { "index": 31, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." } + } +} diff --git a/components-starter/camel-hibernate-starter/pom.xml b/components-starter/camel-hibernate-starter/pom.xml new file mode 100644 index 00000000000..cb6fb465ebe --- /dev/null +++ b/components-starter/camel-hibernate-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.24.0-SNAPSHOT</version> + </parent> + <artifactId>camel-hibernate-starter</artifactId> + <packaging>jar</packaging> + <name>Camel SB Starters :: hibernate</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-hibernate</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-hibernate-starter/src/main/docs/hibernate.json b/components-starter/camel-hibernate-starter/src/main/docs/hibernate.json new file mode 100644 index 00000000000..5bd7f2e1324 --- /dev/null +++ b/components-starter/camel-hibernate-starter/src/main/docs/hibernate.json @@ -0,0 +1,78 @@ +{ + "groups": [ + { + "name": "camel.component.hibernate", + "type": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration" + }, + { + "name": "camel.component.hibernate.customizer", + "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration", + "sourceMethod": "getCustomizer()" + }, + { + "name": "camel.component.hibernate.data-source", + "type": "java.lang.Object", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration", + "sourceMethod": "getDataSource()" + } + ], + "properties": [ + { + "name": "camel.component.hibernate.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.hibernate.springboot.HibernateComponentConfiguration", + "defaultValue": true + }, + { + "name": "camel.component.hibernate.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.hibernate.springboot.HibernateComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.hibernate.customizer.enabled", + "type": "java.lang.Boolean", + "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" + }, + { + "name": "camel.component.hibernate.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable auto configuration of the hibernate component. This is enabled by default.", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration" + }, + { + "name": "camel.component.hibernate.hibernate-properties", + "type": "java.util.Map<java.lang.String,java.lang.Object>", + "description": "Arbitrary Hibernate configuration properties passthrough map.", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration" + }, + { + "name": "camel.component.hibernate.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.hibernate.springboot.HibernateComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.hibernate.schema-action", + "type": "java.lang.String", + "description": "Schema generation action: none, validate, update, create, create-drop, create-only, drop.", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration", + "defaultValue": "none" + }, + { + "name": "camel.component.hibernate.session-factory", + "type": "org.hibernate.SessionFactory", + "description": "The Hibernate SessionFactory to use. The option is a org.hibernate.SessionFactory type.", + "sourceType": "org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration" + } + ], + "hints": [], + "ignored": { + "properties": [] + } +} \ No newline at end of file diff --git a/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentAutoConfiguration.java b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentAutoConfiguration.java new file mode 100644 index 00000000000..51ce5f16a8b --- /dev/null +++ b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentAutoConfiguration.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.hibernate.springboot; + +import org.apache.camel.CamelContext; +import org.apache.camel.Component; +import org.apache.camel.component.hibernate.HibernateComponent; +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, HibernateComponentConverter.class}) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({ComponentConfigurationProperties.class,HibernateComponentConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.component", "camel.component.hibernate"}) +public class HibernateComponentAutoConfiguration { + + private final ApplicationContext applicationContext; + private final HibernateComponentConfiguration configuration; + + public HibernateComponentAutoConfiguration( + org.springframework.context.ApplicationContext applicationContext, + org.apache.camel.component.hibernate.springboot.HibernateComponentConfiguration configuration) { + this.applicationContext = applicationContext; + this.configuration = configuration; + } + + @Lazy + @Bean + public ComponentCustomizer configureHibernateComponent() { + return new ComponentCustomizer() { + @Override + public void configure(String name, Component target) { + CamelPropertiesHelper.copyConfigurationProperties(target.getCamelContext(), applicationContext, + "camel.component.hibernate", configuration, target); + } + @Override + public boolean isEnabled(String name, Component target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.component.customizer", + "camel.component.hibernate.customizer") + && target instanceof HibernateComponent; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConfiguration.java b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConfiguration.java new file mode 100644 index 00000000000..e066382c9d7 --- /dev/null +++ b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConfiguration.java @@ -0,0 +1,149 @@ +/* + * 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.hibernate.springboot; + +import java.util.Map; +import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; +import org.hibernate.SessionFactory; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Execute selection and mutation queries and natural-id lookups using Hibernate + * ORM. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@ConfigurationProperties(prefix = "camel.component.hibernate") +public class HibernateComponentConfiguration + extends + ComponentConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the hibernate component. This is + * enabled by default. + */ + private Boolean enabled; + /** + * The DataSource to use for bootstrapping the SessionFactory (bean + * reference or registry name). The option is a java.lang.Object type. + */ + private Object dataSource; + /** + * Arbitrary Hibernate configuration properties passthrough map. + */ + private Map<String, Object> hibernateProperties; + /** + * Schema generation action: none, validate, update, create, create-drop, + * create-only, drop. + */ + private String schemaAction = "none"; + /** + * The Hibernate SessionFactory to use. The option is a + * org.hibernate.SessionFactory type. + */ + private SessionFactory sessionFactory; + /** + * 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; + + public Object getDataSource() { + return dataSource; + } + + public void setDataSource(Object dataSource) { + this.dataSource = dataSource; + } + + public Map<String, Object> getHibernateProperties() { + return hibernateProperties; + } + + public void setHibernateProperties(Map<String, Object> hibernateProperties) { + this.hibernateProperties = hibernateProperties; + } + + public String getSchemaAction() { + return schemaAction; + } + + public void setSchemaAction(String schemaAction) { + this.schemaAction = schemaAction; + } + + public SessionFactory getSessionFactory() { + return sessionFactory; + } + + public void setSessionFactory(SessionFactory sessionFactory) { + this.sessionFactory = sessionFactory; + } + + 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; + } +} \ No newline at end of file diff --git a/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConverter.java b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConverter.java new file mode 100644 index 00000000000..4bfa3c1a703 --- /dev/null +++ b/components-starter/camel-hibernate-starter/src/main/java/org/apache/camel/component/hibernate/springboot/HibernateComponentConverter.java @@ -0,0 +1,53 @@ +/* + * 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.hibernate.springboot; + +import java.util.LinkedHashSet; +import java.util.Set; +import org.apache.camel.spring.boot.util.BeanReferenceHelper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.ConfigurationPropertiesBinding; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.convert.TypeDescriptor; +import org.springframework.core.convert.converter.GenericConverter; +import org.springframework.stereotype.Component; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Configuration(proxyBeanMethods = false) +@ConfigurationPropertiesBinding +@Component +public class HibernateComponentConverter implements GenericConverter { + + @Autowired + private ApplicationContext applicationContext; + + public Set<ConvertiblePair> getConvertibleTypes() { + Set<ConvertiblePair> answer = new LinkedHashSet<>(); + answer.add(new ConvertiblePair(String.class, org.hibernate.SessionFactory.class)); + return answer; + } + + public Object convert( + Object source, + TypeDescriptor sourceType, + TypeDescriptor targetType) { + return BeanReferenceHelper.resolveBeanReference(applicationContext, source, targetType, "camel.component.hibernate"); + } +} \ No newline at end of file diff --git a/components-starter/camel-hibernate-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-hibernate-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/components-starter/camel-hibernate-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-hibernate-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-hibernate-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/components-starter/camel-hibernate-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-hibernate-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/components-starter/camel-hibernate-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000000..0f5723a7439 --- /dev/null +++ b/components-starter/camel-hibernate-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,18 @@ +## --------------------------------------------------------------------------- +## 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.hibernate.springboot.HibernateComponentConverter +org.apache.camel.component.hibernate.springboot.HibernateComponentAutoConfiguration diff --git a/components-starter/pom.xml b/components-starter/pom.xml index b5ed2b415d1..4088de8a673 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -274,6 +274,7 @@ <module>camel-gson-starter</module> <module>camel-hashicorp-vault-starter</module> <module>camel-hazelcast-starter</module> + <module>camel-hibernate-starter</module> <module>camel-hivemq-starter</module> <module>camel-hl7-starter</module> <module>camel-http-starter</module> diff --git a/docs/spring-boot/modules/ROOT/nav.adoc b/docs/spring-boot/modules/ROOT/nav.adoc index 22b08b8ee45..5edcfad4eb8 100644 --- a/docs/spring-boot/modules/ROOT/nav.adoc +++ b/docs/spring-boot/modules/ROOT/nav.adoc @@ -175,6 +175,7 @@ ** xref:starters/gson.adoc[JSON Gson] ** xref:starters/hashicorp-vault.adoc[HashiCorp Vault] ** xref:starters/hazelcast.adoc[Hazelcast Instance] +** xref:starters/hibernate.adoc[Hibernate] ** xref:starters/hivemq.adoc[HiveMQ] ** xref:starters/hl7.adoc[HL7] ** xref:starters/http.adoc[HTTP] diff --git a/docs/spring-boot/modules/ROOT/pages/starters/hibernate.adoc b/docs/spring-boot/modules/ROOT/pages/starters/hibernate.adoc new file mode 100644 index 00000000000..1c248a5cf25 --- /dev/null +++ b/docs/spring-boot/modules/ROOT/pages/starters/hibernate.adoc @@ -0,0 +1,38 @@ +// Do not edit directly! +// This file was generated by camel-spring-boot-generator-maven-plugin += Hibernate +:artifactid: camel-hibernate-starter + +Execute selection and mutation queries and natural-id lookups using Hibernate ORM. + +== What's inside + +* xref:{csb-camel-components}::hibernate-component.adoc[Hibernate component], URI syntax: `hibernate:entityClassName` + +Please refer to the above links for usage and configuration details. + +== Maven coordinates + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-hibernate-starter</artifactId> +</dependency> +---- + +== Spring Boot Auto-Configuration + +The starter supports 7 options, which are listed below. + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| camel.component.hibernate.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.hibernate.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 ther [...] +| camel.component.hibernate.enabled | Whether to enable auto configuration of the hibernate component. This is enabled by default. | | Boolean +| camel.component.hibernate.hibernate-properties | Arbitrary Hibernate configuration properties passthrough map. | | Object> +| camel.component.hibernate.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 th [...] +| camel.component.hibernate.schema-action | Schema generation action: none, validate, update, create, create-drop, create-only, drop. | none | String +| camel.component.hibernate.session-factory | The Hibernate SessionFactory to use. The option is a org.hibernate.SessionFactory type. | | SessionFactory +|=== diff --git a/tooling/camel-spring-boot-bom/pom.xml b/tooling/camel-spring-boot-bom/pom.xml index a27eb6eb1db..6c7670f2cdc 100644 --- a/tooling/camel-spring-boot-bom/pom.xml +++ b/tooling/camel-spring-boot-bom/pom.xml @@ -903,6 +903,11 @@ <artifactId>camel-hazelcast-starter</artifactId> <version>4.24.0-SNAPSHOT</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-hibernate-starter</artifactId> + <version>4.24.0-SNAPSHOT</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-hivemq-starter</artifactId> diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index 411a19d0dfb..87cdf643a67 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -1237,6 +1237,11 @@ <artifactId>camel-hazelcast-starter</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-hibernate-starter</artifactId> + <version>${project.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-hivemq-starter</artifactId>
