camel-quartz-kafka-connector source configuration

Connector description: Schedule sending of messages using the Quartz 2.x scheduler.

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>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.quartz.CamelQuartzSourceConnector

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

Name Description Default Required Priority

camel.source.path.groupName

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

"Camel"

false

MEDIUM

camel.source.path.triggerName

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

null

true

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

false

MEDIUM

camel.source.endpoint.cron

Specifies a cron expression to define when to trigger.

null

false

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

false

MEDIUM

camel.source.endpoint.durableJob

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

false

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

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

false

MEDIUM

camel.source.endpoint.stateful

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

false

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

false

MEDIUM

camel.source.endpoint.exchangePattern

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

null

false

MEDIUM

camel.source.endpoint.customCalendar

Specifies a custom calendar to avoid specific range of date

null

false

MEDIUM

camel.source.endpoint.jobParameters

To configure additional options on the job.

null

false

MEDIUM

camel.source.endpoint.prefixJobNameWithEndpointId

Whether the job name should be prefixed with endpoint id

false

false

MEDIUM

camel.source.endpoint.triggerParameters

To configure additional options on the trigger.

null

false

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

false

MEDIUM

camel.source.endpoint.autoStartScheduler

Whether or not the scheduler should be auto started.

true

false

MEDIUM

camel.source.endpoint.fireNow

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

false

false

MEDIUM

camel.source.endpoint.startDelayedSeconds

Seconds to wait before starting the quartz scheduler.

null

false

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

false

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

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

false

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

false

MEDIUM

camel.component.quartz.prefixJobNameWithEndpointId

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

false

false

MEDIUM

camel.component.quartz.properties

Properties to configure the Quartz scheduler.

null

false

MEDIUM

camel.component.quartz.propertiesFile

File name of the properties to load from the classpath

null

false

MEDIUM

camel.component.quartz.propertiesRef

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

null

false

MEDIUM

camel.component.quartz.autowiredEnabled

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

false

MEDIUM

camel.component.quartz.scheduler

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

null

false

MEDIUM

camel.component.quartz.schedulerFactory

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

null

false

MEDIUM

camel.component.quartz.autoStartScheduler

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

true

false

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

false

MEDIUM

camel.component.quartz.startDelayedSeconds

Seconds to wait before starting the quartz scheduler.

null

false

MEDIUM

The camel-quartz source connector has no converters out of the box.

The camel-quartz source connector has no transforms out of the box.

The camel-quartz source connector has no aggregation strategies out of the box.

Back to top