camel-quartz-kafka-connector source configuration

When using camel-quartz-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-quartz-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

The camel-quartz source connector supports 35 options, which are listed below.

Name	Description	Default	Priority
camel.source.path.groupName	The quartz group name to use. The combination of group name and timer name should be unique.	"Camel"	MEDIUM
camel.source.path.triggerName	The quartz timer name to use. The combination of group name and timer name should be unique.	null	HIGH
camel.source.endpoint.bridgeErrorHandler	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 or ERROR level and ignored.	false	MEDIUM
camel.source.endpoint.cron	Specifies a cron expression to define when to trigger.	null	MEDIUM
camel.source.endpoint.deleteJob	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.	true	MEDIUM
camel.source.endpoint.durableJob	Whether or not the job should remain stored after it is orphaned (no triggers point to it).	false	MEDIUM
camel.source.endpoint.pauseJob	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.	false	MEDIUM
camel.source.endpoint.recoverableJob	Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered.	false	MEDIUM
camel.source.endpoint.stateful	Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job.	false	MEDIUM
camel.source.endpoint.exceptionHandler	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.	null	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	MEDIUM
camel.source.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM
camel.source.endpoint.customCalendar	Specifies a custom calendar to avoid specific range of date	null	MEDIUM
camel.source.endpoint.jobParameters	To configure additional options on the job.	null	MEDIUM
camel.source.endpoint.prefixJobNameWithEndpointId	Whether the job name should be prefixed with endpoint id	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	MEDIUM
camel.source.endpoint.triggerParameters	To configure additional options on the trigger.	null	MEDIUM
camel.source.endpoint.usingFixedCamelContextName	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.	false	MEDIUM
camel.source.endpoint.autoStartScheduler	Whether or not the scheduler should be auto started.	true	MEDIUM
camel.source.endpoint.fireNow	If it is true will fire the trigger when the route is start when using SimpleTrigger.	false	MEDIUM
camel.source.endpoint.startDelayedSeconds	Seconds to wait before starting the quartz scheduler.	null	MEDIUM
camel.source.endpoint.triggerStartDelay	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.	500L	MEDIUM
camel.component.quartz.bridgeErrorHandler	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 or ERROR level and ignored.	false	MEDIUM
camel.component.quartz.enableJmx	Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true	true	MEDIUM
camel.component.quartz.prefixInstanceName	Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default, to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext’s.	true	MEDIUM
camel.component.quartz.prefixJobNameWithEndpointId	Whether to prefix the quartz job with the endpoint id. This option is default false.	false	MEDIUM
camel.component.quartz.properties	Properties to configure the Quartz scheduler.	null	MEDIUM
camel.component.quartz.propertiesFile	File name of the properties to load from the classpath	null	MEDIUM
camel.component.quartz.propertiesRef	References to an existing Properties or Map to lookup in the registry to use for configuring quartz.	null	MEDIUM
camel.component.quartz.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM
camel.component.quartz.scheduler	To use the custom configured Quartz scheduler, instead of creating a new Scheduler.	null	MEDIUM
camel.component.quartz.schedulerFactory	To use the custom SchedulerFactory which is used to create the Scheduler.	null	MEDIUM
camel.component.quartz.autoStartScheduler	Whether or not the scheduler should be auto started. This options is default true	true	MEDIUM
camel.component.quartz.interruptJobsOnShutdown	Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted.	false	MEDIUM
camel.component.quartz.startDelayedSeconds	Seconds to wait before starting the quartz scheduler.	null	MEDIUM

Name

Description

Default

Priority

camel.source.path.groupName

The quartz group name to use. The combination of group name and timer name should be unique.

"Camel"

MEDIUM

camel.source.path.triggerName

The quartz timer name to use. The combination of group name and timer name should be unique.

null

HIGH

camel.source.endpoint.bridgeErrorHandler

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 or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.cron

Specifies a cron expression to define when to trigger.

null

MEDIUM

camel.source.endpoint.deleteJob

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.

true

MEDIUM

camel.source.endpoint.durableJob

Whether or not the job should remain stored after it is orphaned (no triggers point to it).

false

MEDIUM

camel.source.endpoint.pauseJob

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.

false

MEDIUM

camel.source.endpoint.recoverableJob

Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered.

false

MEDIUM

camel.source.endpoint.stateful

Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job.

false

MEDIUM

camel.source.endpoint.exceptionHandler

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.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.customCalendar

Specifies a custom calendar to avoid specific range of date

null

MEDIUM

camel.source.endpoint.jobParameters

To configure additional options on the job.

null

MEDIUM

camel.source.endpoint.prefixJobNameWithEndpointId

Whether the job name should be prefixed with endpoint id

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.triggerParameters

To configure additional options on the trigger.

null

MEDIUM

camel.source.endpoint.usingFixedCamelContextName

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.

false

MEDIUM

camel.source.endpoint.autoStartScheduler

Whether or not the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.fireNow

If it is true will fire the trigger when the route is start when using SimpleTrigger.

false

MEDIUM

camel.source.endpoint.startDelayedSeconds

Seconds to wait before starting the quartz scheduler.

null

MEDIUM

camel.source.endpoint.triggerStartDelay

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.

500L

MEDIUM

camel.component.quartz.bridgeErrorHandler

false

MEDIUM

camel.component.quartz.enableJmx

Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true

true

MEDIUM

camel.component.quartz.prefixInstanceName

Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default, to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext’s.

true

MEDIUM

camel.component.quartz.prefixJobNameWithEndpointId

Whether to prefix the quartz job with the endpoint id. This option is default false.

false

MEDIUM

camel.component.quartz.properties

Properties to configure the Quartz scheduler.

null

MEDIUM

camel.component.quartz.propertiesFile

File name of the properties to load from the classpath

null

MEDIUM

camel.component.quartz.propertiesRef

References to an existing Properties or Map to lookup in the registry to use for configuring quartz.

null

MEDIUM

camel.component.quartz.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.quartz.scheduler

To use the custom configured Quartz scheduler, instead of creating a new Scheduler.

null

MEDIUM

camel.component.quartz.schedulerFactory

To use the custom SchedulerFactory which is used to create the Scheduler.

null

MEDIUM

camel.component.quartz.autoStartScheduler

Whether or not the scheduler should be auto started. This options is default true

true

MEDIUM

camel.component.quartz.interruptJobsOnShutdown

Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted.

false

MEDIUM

camel.component.quartz.startDelayedSeconds

Seconds to wait before starting the quartz scheduler.

null

MEDIUM