Package io.quarkus.quartz.runtime

Class QuartzBuildTimeConfig

java.lang.Object

io.quarkus.quartz.runtime.QuartzBuildTimeConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED)
public class QuartzBuildTimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
long	clusterCheckinInterval	The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster.
boolean	clustered	Enable cluster mode or not.
Optional<String>	dataSourceName	The name of the datasource to use.
Map<String,QuartzExtensionPointConfig>	instanceIdGenerators	Instance ID generators.
Map<String,QuartzExtensionPointConfig>	jobListeners	Job listeners.
Map<String,QuartzExtensionPointConfig>	plugins	Plugins.
Optional<String>	selectWithLockSql	The SQL string that selects a row in the "LOCKS" table and places a lock on the row.
Optional<Boolean>	serializeJobData	Instructs JDBCJobStore to serialize JobDataMaps in the BLOB column.
StoreType	storeType	The type of store to use.
String	tablePrefix	The prefix for quartz job store tables.
Map<String,QuartzExtensionPointConfig>	triggerListeners	Trigger listeners.

Constructor Summary

Constructors

Constructor	Description
QuartzBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clustered

@ConfigItem
public boolean clustered

Enable cluster mode or not.

If enabled make sure to set the appropriate cluster properties.

clusterCheckinInterval

@ConfigItem(defaultValue="15000")
public long clusterCheckinInterval

The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster.

Ignored if using a `ram` store i.e StoreType.RAM.

storeType

@ConfigItem(defaultValue="ram")
public StoreType storeType

The type of store to use.

When using StoreType.JDBC_CMT or StoreType.JDBC_TX configuration values make sure that you have the datasource configured. See Configuring your datasource for more information.

To create Quartz tables, you can perform a schema migration via the Flyway extension using a SQL script matching your database picked from Quartz repository.

dataSourceName

@ConfigItem(name="datasource")
public Optional<String> dataSourceName

The name of the datasource to use.

Ignored if using a `ram` store i.e StoreType.RAM.

Optionally needed when using the `jdbc-tx` or `jdbc-cmt` store types. If not specified, defaults to using the default datasource.

tablePrefix

@ConfigItem(defaultValue="QRTZ_")
public String tablePrefix

The prefix for quartz job store tables.

Ignored if using a `ram` store i.e StoreType.RAM

selectWithLockSql

@ConfigItem
public Optional<String> selectWithLockSql

The SQL string that selects a row in the "LOCKS" table and places a lock on the row.

Ignored if using a `ram` store i.e StoreType.RAM.

If not set, the default value of Quartz applies, for which the "{0}" is replaced during run-time with the `table-prefix`, the "{1}" with the `instance-name`.

An example SQL string `SELECT * FROM {0}LOCKS WHERE SCHED_NAME = {1} AND LOCK_NAME = ? FOR UPDATE`

serializeJobData

@ConfigItem(defaultValue="false")
public Optional<Boolean> serializeJobData

Instructs JDBCJobStore to serialize JobDataMaps in the BLOB column.

Ignored if using a `ram` store i.e StoreType.RAM.

If this is set to `true`, the JDBCJobStore will store the JobDataMaps in their serialize form in the BLOB Column. This is useful when you want to store complex JobData objects other than String. This is equivalent of setting `org.quartz.jobStore.useProperties` to `false`. NOTE: When this option is set to `true`, all the non-String classes used in JobDataMaps have to be registered for serialization when building a native image

If this is set to `false` (the default), the values can be stored as name-value pairs rather than storing more complex objects in their serialized form in the BLOB column. This can be handy, as you avoid the class versioning issues that can arise from serializing your non-String classes into a BLOB. This is equivalent of setting `org.quartz.jobStore.useProperties` to `true`.

instanceIdGenerators

@ConfigItem
@ConfigDocMapKey("generator-name")
@ConfigDocSection
public Map<String,QuartzExtensionPointConfig> instanceIdGenerators

Instance ID generators.

triggerListeners

@ConfigItem
@ConfigDocMapKey("listener-name")
@ConfigDocSection
public Map<String,QuartzExtensionPointConfig> triggerListeners

Trigger listeners.

jobListeners

@ConfigItem
@ConfigDocMapKey("listener-name")
@ConfigDocSection
public Map<String,QuartzExtensionPointConfig> jobListeners

Job listeners.

plugins

@ConfigItem
@ConfigDocMapKey("plugin-name")
@ConfigDocSection
public Map<String,QuartzExtensionPointConfig> plugins

Plugins.

Constructor Detail

QuartzBuildTimeConfig

public QuartzBuildTimeConfig()