QuartzSchedulerExtension

Instance Constructors

new QuartzSchedulerExtension(system: ExtendedActorSystem)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def cancelJob(name: String): Boolean

Cancels the running job and all associated triggers
Cancels the running job and all associated triggers
name
The name of the job, as defined in the schedule
returns
Success or Failure in a Boolean
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: Config

Attributes
protected
def createJobSchedule(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

Creates job, associated triggers and corresponding schedule at once.
Creates job, associated triggers and corresponding schedule at once.
name
The name of the job, as defined in the schedule
receiver
An ActorRef, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
description
A string describing the purpose of the job
cronExpression
A string with the cron-type expression
calendar
An optional calendar to use.
timezone
The time zone to use if different from default.
returns
A date which indicates the first time the trigger will fire.
def createSchedule(name: String, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Unit

Create a schedule programmatically (must still be scheduled by calling 'schedule')
Create a schedule programmatically (must still be scheduled by calling 'schedule')
name
A String identifying the job
description
A string describing the purpose of the job
cronExpression
A string with the cron-type expression
calendar
An optional calendar to use.
val daemonThreads_?: Boolean
val defaultTimezone: TimeZone
def deleteJobSchedule(name: String): Boolean

Deletes job, associated triggers and corresponding schedule at once.
Deletes job, associated triggers and corresponding schedule at once.
Remark: Identical to unscheduleJob. Exists to provide consistent naming of related JobSchedule operations.
name
The name of the job, as defined in the schedule
returns
Success or Failure in a Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def initialiseCalendars(): Unit

Parses calendar configurations, creates Calendar instances and attaches them to the scheduler
Parses calendar configurations, creates Calendar instances and attaches them to the scheduler

Attributes
protected
def isInStandbyMode: Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isStarted: Boolean
lazy val jobStore: JobStore

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nextTrigger(name: String): Option[Date]

Returns the next Date a schedule will be fired
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def rescheduleJob(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

Reschedule a job
Reschedule a job
name
A String identifying the job
receiver
An ActorRef, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
description
A string describing the purpose of the job
cronExpression
A string with the cron-type expression
calendar
An optional calendar to use.
returns
A date which indicates the first time the trigger will fire.
def resumeAll(): Unit

Unpauses all jobs in the scheduler
def resumeJob(name: String): Boolean

Attempts to resume (un-pause) the given job
Attempts to resume (un-pause) the given job
name
The name of the job, as defined in the schedule
returns
Success or Failure in a Boolean
val runningJobs: Map[String, JobKey]
def schedule(name: String, receiver: EventStream, msg: AnyRef, startDate: Option[Date]): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An EventStream, who will be published to each time the schedule fires
msg
A message object, which will be published to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def schedule(name: String, receiver: ActorSelection, msg: AnyRef, startDate: Option[Date]): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An ActorSelection, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def schedule(name: String, receiver: ActorRef, msg: AnyRef, startDate: Option[Date]): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An ActorRef, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def schedule(name: String, receiver: EventStream, msg: AnyRef): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An EventStream, who will be published to each time the schedule fires
msg
A message object, which will be published to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def schedule(name: String, receiver: ActorSelection, msg: AnyRef): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An ActorSelection, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def schedule(name: String, receiver: ActorRef, msg: AnyRef): Date

Schedule a job, whose named configuration must be available
Schedule a job, whose named configuration must be available
name
A String identifying the job, which must match configuration
receiver
An ActorRef, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
returns
A date which indicates the first time the trigger will fire.
def scheduleJob(name: String, receiver: AnyRef, msg: AnyRef, startDate: Option[Date])(schedule: QuartzSchedule): Date

Creates the actual jobs for Quartz, and setups the Trigger, etc.
Creates the actual jobs for Quartz, and setups the Trigger, etc.
returns
A date, which indicates the first time the trigger will fire.

Attributes
protected
lazy val scheduler: Scheduler

Attributes
protected
def schedulerName: String
var schedules: Map[String, QuartzSchedule]

Parses job and trigger configurations, preparing them for any code request of a matching job.
Parses job and trigger configurations, preparing them for any code request of a matching job. In our world, jobs and triggers are essentially 'merged' - our scheduler is built around triggers and jobs are basically 'idiot' programs who fire off messages.
RECAST KEY AS UPPERCASE TO AVOID RUNTIME LOOKUP ISSUES
def shutdown(waitForJobsToComplete: Boolean = false): Unit

Shutdown the scheduler manually.
Shutdown the scheduler manually. The scheduler cannot be re-started.
waitForJobsToComplete
wait for jobs to complete? default to false
def standby(): Unit

Puts the Scheduler in 'standby' mode, temporarily halting firing of triggers.
Puts the Scheduler in 'standby' mode, temporarily halting firing of triggers. Resumable by running 'start'
def start(): Boolean

Starts up the scheduler.
Starts up the scheduler. This is typically used from userspace only to restart a scheduler in standby mode.
returns
True if calling this function resulted in the starting of the scheduler; false if the scheduler was already started.
def suspendAll(): Unit

Suspends (pauses) all jobs in the scheduler
def suspendJob(name: String): Boolean

Attempts to suspend (pause) the given job
Attempts to suspend (pause) the given job
name
The name of the job, as defined in the schedule
returns
Success or Failure in a Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val threadCount: Int
lazy val threadPool: SimpleThreadPool

Attributes
protected
val threadPriority: Int
def toString(): String

Definition Classes
AnyRef → Any
def unscheduleJob(name: String): Boolean

Unschedule an existing schedule
Unschedule an existing schedule
Cancels the running job and all associated triggers and removes corresponding schedule entry from internal schedules map.
name
The name of the job, as defined in the schedule
returns
Success or Failure in a Boolean
def updateJobSchedule(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

Updates job, associated triggers and corresponding schedule at once.
Updates job, associated triggers and corresponding schedule at once.
name
The name of the job, as defined in the schedule
receiver
An ActorRef, who will be notified each time the schedule fires
msg
A message object, which will be sent to receiver each time the schedule fires
description
A string describing the purpose of the job
cronExpression
A string with the cron-type expression
calendar
An optional calendar to use.
timezone
The time zone to use if different from default.
returns
A date which indicates the first time the trigger will fire.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object QuartzSchedulerExtension | package quartz

class QuartzSchedulerExtension extends Extension

Instance Constructors

new QuartzSchedulerExtension(system: ExtendedActorSystem)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def cancelJob(name: String): Boolean

def clone(): AnyRef

val config: Config

def createJobSchedule(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

def createSchedule(name: String, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Unit

val daemonThreads_?: Boolean

val defaultTimezone: TimeZone

def deleteJobSchedule(name: String): Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def initialiseCalendars(): Unit

def isInStandbyMode: Boolean

final def isInstanceOf[T0]: Boolean

def isStarted: Boolean

lazy val jobStore: JobStore

final def ne(arg0: AnyRef): Boolean

def nextTrigger(name: String): Option[Date]

final def notify(): Unit

final def notifyAll(): Unit

def rescheduleJob(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

def resumeAll(): Unit

def resumeJob(name: String): Boolean

val runningJobs: Map[String, JobKey]

def schedule(name: String, receiver: EventStream, msg: AnyRef, startDate: Option[Date]): Date

def schedule(name: String, receiver: ActorSelection, msg: AnyRef, startDate: Option[Date]): Date

def schedule(name: String, receiver: ActorRef, msg: AnyRef, startDate: Option[Date]): Date

def schedule(name: String, receiver: EventStream, msg: AnyRef): Date

def schedule(name: String, receiver: ActorSelection, msg: AnyRef): Date

def schedule(name: String, receiver: ActorRef, msg: AnyRef): Date

def scheduleJob(name: String, receiver: AnyRef, msg: AnyRef, startDate: Option[Date])(schedule: QuartzSchedule): Date

lazy val scheduler: Scheduler

def schedulerName: String

var schedules: Map[String, QuartzSchedule]

def shutdown(waitForJobsToComplete: Boolean = false): Unit

def standby(): Unit

def start(): Boolean

def suspendAll(): Unit

def suspendJob(name: String): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

val threadCount: Int

lazy val threadPool: SimpleThreadPool

val threadPriority: Int

def toString(): String

def unscheduleJob(name: String): Boolean

def updateJobSchedule(name: String, receiver: ActorRef, msg: AnyRef, description: Option[String] = None, cronExpression: String, calendar: Option[String] = None, timezone: TimeZone = defaultTimezone): Date

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped