clojurewerkz.quartzite.scheduler — adamwynne/quartzite 1.2.4

*scheduler* clj

add-job clj

(add-job job-detail)

(add-job job-detail replace)

(add-job job-detail replace store-durably-till-scheduled)

Adds given job to the scheduler with no associated trigger

add-scheduler-listener clj

(add-scheduler-listener listener)

Registers a schedule listener. Use it to hook into Quartz scheduler events

add-trigger clj

(add-trigger trigger)

Adds given trigger to the scheduled job with which the trigger has been associated

all-scheduled? clj

(all-scheduled? & keys)

Returns true if all provided keys (trigger or job) are scheduled

clear! clj

(clear!)

Resets the scheduler by clearing all triggers and jobs from it

delete-job clj

(delete-job key)

Deletes the identified job and all triggers associated with it from the scheduler

delete-jobs clj

(delete-jobs keys)

Remove all of the indicated jobs (and associated triggers) from the scheduler. Bulk equivalent of delete-job

delete-trigger clj

(delete-trigger key)

Removes the indicated trigger from the scheduler. If the related job does not have any other triggers, and the job is not durable, then the job will also be deleted

delete-triggers clj

(delete-triggers keys)

Remove all of the indicated triggers from the scheduler

get-job clj

(get-job key)

(get-job group key)

Returns a JobDetail instance for the given key.

get-job-group-names clj

(get-job-group-names)

Get the names of all known JobDetail groups.

get-job-keys clj

(get-job-keys gm)

Returns a set of keys that match the given group matcher. Commonly used with the functions in the clojurewerkz.quartzite.matchers.* namespace.

get-jobs clj

(get-jobs keys)

Returns a set of JobDetail instances for the given collection of keys.

get-matching-jobs clj

Returns a set of JobDetail instances with keys that match the given group matcher. Commonly used with the functions in the clojurewerkz.quartzite.matchers.* namespace.

get-matching-triggers clj

Returns a set of Trigger instances with keys that match the given group matcher. Commonly used with the functions in the clojurewerkz.quartzite.matchers.* namespace.

get-trigger clj

(get-trigger key)

(get-trigger group key)

Returns a Trigger instance for the given key.

get-trigger-group-names clj

(get-trigger-group-names)

Get the names of all known Trigger groups.

get-trigger-keys clj

(get-trigger-keys gm)

Returns a set of keys that match the given group matcher. Commonly used with the functions in the clojurewerkz.quartzite.matchers.* namespace.

get-triggers clj

(get-triggers keys)

Returns a set of Trigger instances for the given collection of keys.

get-triggers-of-job clj

(get-triggers-of-job key)

Returns a set of Trigger instances for the given collection of keys.

initialize clj

(initialize)

(initialize scheduler)

Initializers default scheduler. Use this function before starting Quartzite's scheduler

KeyPredicates clj protocol

scheduled? clj

(scheduled? key)

Checks if entity with given key already exists within the scheduler

maybe-schedule clj

(maybe-schedule job-detail trigger)

Adds given job to the scheduler and associates it with given trigger but only if they are not already known to the scheduler.

Like schedule but avoids org.quartz.ObjectAlreadyExistsException by checking if keys of provided job and trigger are already scheduled and do not need to be scheduled again

pause-all! clj

(pause-all!)

Pauses all triggers and jobs

pause-job clj

(pause-job key)

Pauses a job with the given key

pause-jobs clj

(pause-jobs matcher)

Pauses a group of jobs

pause-trigger clj

(pause-trigger key)

Pauses a trigger with the given key

pause-triggers clj

(pause-triggers matcher)

Pauses a group of triggers

recreate clj

(recreate)

Recreates (reinitializes) Quartzite's scheduler instance

resume-all! clj

(resume-all!)

Resumes all paused triggers and jobs

resume-job clj

(resume-job key)

Resumes a job with the given key

resume-jobs clj

(resume-jobs matcher)

Resumes a group of jobs

resume-trigger clj

(resume-trigger key)

Resumes a trigger with the given key

resume-triggers clj

(resume-triggers matcher)

Resumes a group of triggers

schedule clj

(schedule job-detail trigger)

Adds given job to the scheduler and associates it with given trigger. Trigger controls job execution schedule, initial execution time and other characteristics

shutdown clj

(shutdown)

(shutdown wait-for-jobs-to-complete)

Shuts scheduler down, releasing all the resources associated with it. When passed true causes scheduler to wait for running jobs to complete before shutting down

shutdown? clj

(shutdown?)

Returns true if the scheduler has been shut down, false otherwise

standby clj

(standby)

Puts scheduler in standby mode. When in scheduler is standby mode, no triggers will fire

standby? clj

(standby?)

Returns true if the scheduler is in standby mode, false otherwise

start clj

(start)

Starts Quartzite's scheduler. Newly initialized scheduler is not active (in standby mode), this function starts it

start-delayed clj

(start-delayed seconds)

Starts Quartzite's scheduler after a delay in seconds

started? clj

(started?)

Returns true if the scheduler has been ever started, false otherwise

trigger clj

(trigger jk)

Returns trigger for given key

unschedule-job clj deprecated

(unschedule-job key)

Removes the indicated trigger from the scheduler. If the related job does not have any other triggers, and the job is not durable, then the job will also be deleted

unschedule-jobs clj deprecated

(unschedule-jobs keys)

Remove all of the indicated triggers from the scheduler

with-scheduler clj macro

(with-scheduler sched & body)