From 33d259e3abc234cc09cc7e99ff1949214239c0d1 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:40:01 +0000 Subject: [PATCH] Update wiki Home page for jpa --- Home.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 68 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..24a504e 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,75 @@ -# Deploy the Project on CamelX Platform +# JPA -Deploy on CamelX Platform in three steps +Store and retrieve Java objects from databases using Java Persistence API (JPA). -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `jpa` | +| Support Level | Stable | +| Labels | database | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-jpa + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `entityType` | string | ✓ | | Entity class name | +| `joinTransaction` | boolean | | `true` | The camel-jpa component will join transaction by default. You can use this option to turn this off, for example, if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints. | +| `maximumResults` | integer | | `-1` | Set the maximum number of results to retrieve on the Query. | +| `namedQuery` | string | | | To use a named query. | +| `nativeQuery` | string | | | To use a custom native query. You may want to use the option resultClass also when using native queries. | +| `persistenceUnit` | string | ✓ | `camel` | The JPA persistence unit used by default. | +| `query` | string | | | To use a custom query. | +| `resultClass` | string | | | Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an effect when using in conjunction with a native query when consuming data. | +| `consumeDelete` | boolean | | `true` | If true, the entity is deleted after it is consumed; if false, the entity is not deleted. | +| `consumeLockEntity` | boolean | | `true` | Specifies whether to set an exclusive lock on each entity bean while processing the results from polling. | +| `deleteHandler` | object | | | To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange | +| `lockModeType` | object | | `PESSIMISTIC_WRITE` | To configure the lock mode on the consumer. | +| `maxMessagesPerPoll` | integer | | | An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. It can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable. | +| `preDeleteHandler` | object | | | To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. | +| `sendEmptyMessageWhenIdle` | boolean | | `false` | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | +| `skipLockedEntity` | boolean | | `false` | To configure whether to use NOWAIT on lock and silently skip the entity. | +| `transacted` | boolean | | `false` | Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only roll back the last failed message. | +| `bridgeErrorHandler` | boolean | | `false` | 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. | +| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. | +| `parameters` | object | | | This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc. | +| `pollStrategy` | object | | | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | +| `findEntity` | boolean | | `false` | If enabled, then the producer will find a single entity by using the message body as a key and entityType as the class type. This can be used instead of a query to find a single entity. | +| `firstResult` | integer | | `-1` | Set the position of the first result to retrieve. | +| `flushOnSend` | boolean | | `true` | Flushes the EntityManager after the entity bean has been persisted. | +| `outputTarget` | string | | | To put the query (or find) result in a header or property instead of the body. If the value starts with the prefix property:, put the result into the so named property, otherwise into the header. | +| `remove` | boolean | | `false` | Indicates to use entityManager.remove(entity). | +| `singleResult` | boolean | | `false` | If enabled, a query or a find which would return no results or more than one result, will throw an exception instead. | +| `useExecuteUpdate` | boolean | | | To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or a DELETE statement as a named query, you need to specify this option to 'true'. | +| `usePersist` | boolean | | `false` | Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)! | +| `lazyStartProducer` | boolean | | `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. | +| `usePassedInEntityManager` | boolean | | `false` | If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITY_MANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use. | +| `entityManagerProperties` | object | | | Additional properties for the entity manager to use. | +| `sharedEntityManager` | boolean | | `false` | Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases, joinTransaction should be set to false as this is not an EXTENDED EntityManager. | +| `backoffErrorThreshold` | integer | | | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | +| `backoffIdleThreshold` | integer | | | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | +| `backoffMultiplier` | integer | | | 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 happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | +| `delay` | integer | | `500` | Milliseconds before the next poll. | +| `greedy` | boolean | | `false` | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | +| `initialDelay` | integer | | `1000` | Milliseconds before the first poll starts. | +| `repeatCount` | integer | | `0` | 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` | object | | `TRACE` | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | +| `scheduledExecutorService` | object | | | 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` | object | | `none` | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | +| `schedulerProperties` | object | | | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | +| `startScheduler` | boolean | | `true` | Whether the scheduler should be auto started. | +| `timeUnit` | object | | `MILLISECONDS` | Time unit for initialDelay and delay options. | +| `useFixedDelay` | boolean | | `true` | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |