QuartzGrailsPlugin (Grails 8.0.0-SNAPSHOT)

quartz.QuartzGrailsPlugin

@groovy.util.logging.Slf4j
class QuartzGrailsPlugin
extends Plugin

Inherited fields
Fields inherited from class	Fields
`class Plugin`	`enabled`

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`author`
`java.lang.Object`	`configureJobBeans` Configure job beans.
`java.lang.Object`	`configureScheduler`
`java.lang.Object`	`description`
`java.lang.Object`	`documentation`
`java.lang.Object`	`grailsVersion`
`java.lang.Object`	`issueManagement`
`java.lang.Object`	`license`
`java.util.List`	`loadAfter`
`java.lang.Object`	`profiles`
`java.lang.Object`	`scm`
`java.lang.Object`	`title`
`java.lang.Object`	`watchedResources`

Inherited properties
Properties inherited from class	Properties
`class Plugin`	`applicationContext, artefacts, environment, grailsApplication, plugin, pluginManager`

Constructor Summary

Constructors
Constructor and description
`QuartzGrailsPlugin()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`groovy.lang.Closure`	`doWithSpring()`
	`java.lang.String`	`getApplicationName()` The name of the application, which every job registered by the plugin is stamped with.
	`java.lang.String`	`getJdbcStoreDataSource()` The name of the Spring bean holding the `DataSource` Quartz uses when the JDBC job store is enabled.
	`java.lang.String`	`getSchedulerInstanceName()` The name given to the scheduler.
	`boolean`	`isApplicationNamed()` Whether the application registers its jobs under a name of its own.
	`boolean`	`isAutoStartup()` Whether the scheduler is started once the application has finished bootstrapping.
	`boolean`	`isExposeSchedulerInRepository()` Whether the scheduler is registered with the Quartz `SchedulerRepository`.
	`boolean`	`isFailOnNeverFiringTriggers()` Whether startup fails when a job declares a trigger which can never fire, for example a cron expression whose last occurrence is in the past.
	`boolean`	`isJdbcStore()` Whether Quartz persists jobs and triggers in a database instead of the in memory `RAMJobStore`.
	`boolean`	`isPluginEnabled()` Whether the plugin is active.
	`boolean`	`isPurgeQuartzTablesOnStartup()` Whether every Quartz table is emptied during startup.
	`boolean`	`isWaitForJobsToCompleteOnShutdown()` Whether shutdown blocks until currently executing jobs have finished.
	`java.lang.Object`	`loadQuartzProperties()` Loads the quartz stanza from the grails configuration and turns it into a flattened Properties object suitable for use by the Quartz SchedulerFactoryBean.
	`void`	`onChange(java.util.Map<java.lang.String, java.lang.Object> event)`
	`void`	`onShutdown(java.util.Map<java.lang.String, java.lang.Object> event)`
	`void`	`onStartup(java.util.Map<java.lang.String, java.lang.Object> event)`
	`void`	`refreshJobs(boolean ignoreErrors)`
	`java.lang.Object`	`scheduleJob(GrailsJobClass jobClass, ApplicationContext ctx, boolean hasHibernate)` Schedules jobs.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Plugin`	`beanRegistrar, beans, doWithApplicationContext, doWithDynamicMethods, doWithSpring, doWithSpring, getApplicationContext, getConfig, getManager, onChange, onConfigChange, onShutdown, onStartup, setApplicationContext`

- Property Detail
  - java.lang.Object author
  - java.lang.Object configureJobBeans
    
    Configure job beans.
  - java.lang.Object configureScheduler
  - java.lang.Object description
  - java.lang.Object documentation
  - java.lang.Object grailsVersion
  - java.lang.Object issueManagement
  - java.lang.Object license
  - java.util.List loadAfter
  - java.lang.Object profiles
  - java.lang.Object scm
  - java.lang.Object title
  - java.lang.Object watchedResources
- Constructor Detail
  - QuartzGrailsPlugin()
- Method Detail
  - groovy.lang.Closure doWithSpring()
  - java.lang.String getApplicationName()
    
    The name of the application, which every job registered by the plugin is stamped with. It is what lets the plugin recognise its own jobs in a job store shared with other applications, so that it never removes a job it did not register itself.
    Returns:
    the value of info.app.name, or the name the application metadata reports
  - java.lang.String getJdbcStoreDataSource()
    
    The name of the Spring bean holding the DataSource Quartz uses when the JDBC job store is enabled.
    Returns:
    the value of quartz.jdbcStoreDataSource, or dataSource
  - java.lang.String getSchedulerInstanceName()
    
    The name given to the scheduler. When unset the bean name is used.
    Returns:
    the value of quartz.scheduler.instanceName, or null
  - boolean isApplicationNamed()
    
    Whether the application registers its jobs under a name of its own. An application which does not name itself registers them under the default name, which every application that does not name itself shares.
    Returns:
    false when the name of the application is the default one
  - boolean isAutoStartup()
    
    Whether the scheduler is started once the application has finished bootstrapping.
    Returns:
    true unless quartz.autoStartup is configured otherwise
  - boolean isExposeSchedulerInRepository()
    
    Whether the scheduler is registered with the Quartz SchedulerRepository.
    Returns:
    false unless quartz.exposeSchedulerInRepository is configured otherwise
  - boolean isFailOnNeverFiringTriggers()
    
    Whether startup fails when a job declares a trigger which can never fire, for example a cron expression whose last occurrence is in the past. When false such a trigger is reported and skipped, and the rest of the application starts as usual.
    Returns:
    false unless quartz.failOnNeverFiringTriggers is configured otherwise
  - boolean isJdbcStore()
    
    Whether Quartz persists jobs and triggers in a database instead of the in memory RAMJobStore.
    Returns:
    false unless quartz.jdbcStore is configured otherwise
  - boolean isPluginEnabled()
    
    Whether the plugin is active. When disabled no scheduler, job beans or listeners are registered and no job is ever scheduled.
    Returns:
    true unless quartz.pluginEnabled is configured otherwise
  - boolean isPurgeQuartzTablesOnStartup()
    
    Whether every Quartz table is emptied during startup. Only honoured when the JDBC job store is enabled and a Hibernate plugin is present.
    Returns:
    false unless quartz.purgeQuartzTablesOnStartup is configured otherwise
  - boolean isWaitForJobsToCompleteOnShutdown()
    
    Whether shutdown blocks until currently executing jobs have finished.
    Returns:
    true unless quartz.waitForJobsToCompleteOnShutdown is configured otherwise
  - java.lang.Object loadQuartzProperties()
    
    Loads the quartz stanza from the grails configuration and turns it into a flattened Properties object suitable for use by the Quartz SchedulerFactoryBean.
    Returns:
    Quartz properties as defined in the Grails Configuration object
  - void onChange(java.util.Map<java.lang.String, java.lang.Object> event)
  - void onShutdown(java.util.Map<java.lang.String, java.lang.Object> event)
  - void onStartup(java.util.Map<java.lang.String, java.lang.Object> event)
  - void refreshJobs(boolean ignoreErrors)
  - java.lang.Object scheduleJob(GrailsJobClass jobClass, ApplicationContext ctx, boolean hasHibernate)
    
    Schedules jobs. Creates job details and trigger beans. And schedules them.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class QuartzGrailsPlugin

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object author

java.lang.Object configureJobBeans

java.lang.Object configureScheduler

java.lang.Object description

java.lang.Object documentation

java.lang.Object grailsVersion

java.lang.Object issueManagement

java.lang.Object license

java.util.List loadAfter

java.lang.Object profiles

java.lang.Object scm

java.lang.Object title

java.lang.Object watchedResources

Constructor Detail

QuartzGrailsPlugin()

Method Detail

groovy.lang.Closure doWithSpring()

java.lang.String getApplicationName()

java.lang.String getJdbcStoreDataSource()

java.lang.String getSchedulerInstanceName()

boolean isApplicationNamed()

boolean isAutoStartup()

boolean isExposeSchedulerInRepository()

boolean isFailOnNeverFiringTriggers()

boolean isJdbcStore()

boolean isPluginEnabled()

boolean isPurgeQuartzTablesOnStartup()

boolean isWaitForJobsToCompleteOnShutdown()

java.lang.Object loadQuartzProperties()

void onChange(java.util.Map<java.lang.String, java.lang.Object> event)

void onShutdown(java.util.Map<java.lang.String, java.lang.Object> event)

void onStartup(java.util.Map<java.lang.String, java.lang.Object> event)

void refreshJobs(boolean ignoreErrors)

java.lang.Object scheduleJob(GrailsJobClass jobClass, ApplicationContext ctx, boolean hasHibernate)