From f5575774dfaf76200586b62e24e772835555c0a9 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:41:55 +0000 Subject: [PATCH] Update wiki Home page for quartz --- Home.md | 53 +++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..228bce9 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,46 @@ -# Deploy the Project on CamelX Platform +# Quartz -Deploy on CamelX Platform in three steps +Schedule sending of messages using the Quartz 2.x scheduler. -## 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 | `quartz` | +| Support Level | Stable | +| Labels | scheduling | +| 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-quartz + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `groupName` | string | | `Camel` | The quartz group name to use. The combination of group name and trigger name should be unique. | +| `triggerName` | string | ✓ | | The quartz trigger name to use. The combination of group name and trigger name should be unique. | +| `cron` | string | | | Specifies a cron expression to define when to trigger. | +| `deleteJob` | boolean | | `true` | If set to true, then the trigger automatically delete when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | +| `durableJob` | boolean | | `false` | Whether or not the job should remain stored after it is orphaned (no triggers point to it). | +| `pauseJob` | boolean | | `false` | If set to true, then the trigger automatically pauses when route stop. Else if set to false, it will remain in scheduler. When set to false, it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | +| `recoverableJob` | boolean | | `false` | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. | +| `stateful` | boolean | | `false` | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job. | +| `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. | +| `customCalendar` | object | | | Specifies a custom calendar to avoid specific range of date | +| `ignoreExpiredNextFireTime` | boolean | | `false` | Whether to ignore quartz cannot schedule a trigger because the trigger will never fire in the future. This can happen when using a cron trigger that are configured to only run in the past. By default, Quartz will fail to schedule the trigger and therefore fail to start the Camel route. You can set this to true which then logs a WARN and then ignore the problem, meaning that the route will never fire in the future. | +| `jobParameters` | object | | | To configure additional options on the job. | +| `prefixJobNameWithEndpointId` | boolean | | `false` | Whether the job name should be prefixed with endpoint id | +| `triggerParameters` | object | | | To configure additional options on the trigger. The parameter timeZone is supported if the cron option is present. Otherwise the parameters repeatInterval and repeatCount are supported. Note: When using repeatInterval values of 1000 or less, the first few events after starting the camel context may be fired more rapidly than expected. | +| `usingFixedCamelContextName` | boolean | | `false` | If it is true, JobDataMap uses the CamelContext name directly to reference the CamelContext, if it is false, JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | +| `autoStartScheduler` | boolean | | `true` | Whether or not the scheduler should be auto started. | +| `triggerStartDelay` | duration | | `500` | In case of scheduler has already started, we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. Negative value shifts trigger start time in the past. |