Provides a scheduled delivery of messages using the Quartz 2.x scheduler.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| groupName | path | consumer | Camel | java.lang.String | The quartz group name to use. The combination of group name and timer name should be unique. | ||
| triggerName | path | consumer | true | java.lang.String | The quartz timer name to use. The combination of group name and timer name should be unique. | ||
| bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| cron | parameter | consumer | java.lang.String | Specifies a cron expression to define when to trigger. | |||
| deleteJob | parameter | consumer | true | boolean | 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 | parameter | consumer | boolean | Whether or not the job should remain stored after it is orphaned (no triggers point to it). | |||
| pauseJob | parameter | consumer | boolean | 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 | parameter | consumer | boolean | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. | |||
| stateful | parameter | consumer | boolean | Uses a Quartz @PersistJobDataAfterExecution and @DisallowConcurrentExecution instead of the default job. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| customCalendar | parameter | advanced | org.quartz.Calendar | Specifies a custom calendar to avoid specific range of date | |||
| jobParameters | parameter | advanced | java.util.Map |
To configure additional options on the job. | |||
| prefixJobNameWithEndpointId | parameter | advanced | boolean | Whether the job name should be prefixed with endpoint id @param prefixJobNameWithEndpointId | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| triggerParameters | parameter | advanced | java.util.Map |
To configure additional options on the trigger. | |||
| usingFixedCamelContextName | parameter | advanced | boolean | 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 | parameter | scheduler | true | boolean | Whether or not the scheduler should be auto started. | ||
| fireNow | parameter | scheduler | boolean | If it is true will fire the trigger when the route is start when using SimpleTrigger. | |||
| startDelayedSeconds | parameter | scheduler | int | Seconds to wait before starting the quartz scheduler. | |||
| triggerStartDelay | parameter | scheduler | 500 | long | 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. |
A factory for QuartzEndpoint. This component will hold a Quartz Scheduler that will provide scheduled timer based endpoint that generate a QuartzMessage to a route. Currently it support Cron and Simple trigger scheduling type.
This component uses Quartz 2.x API and provide all the features from "camel-quartz". It has reused some of the code, but mostly has been re-written in attempt to be more easier to maintain, and use Quartz more fully.