Packages

class QuartzSchedulerExtension extends Extension

Note that this extension will only be instantiated *once* *per actor system*.

Linear Supertypes
Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QuartzSchedulerExtension
  2. Extension
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new QuartzSchedulerExtension(system: ActorSystem)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def config: Config
    Attributes
    protected
  8. 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.

  9. 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.

  10. val daemonThreads_?: Boolean
  11. val defaultTimezone: TimeZone
  12. def deleteAll(): Unit

    Deletes all jobs in the scheduler

  13. 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

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. 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
  20. def isInStandbyMode: Boolean
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isStarted: Boolean
  23. lazy val jobStore: JobStore
    Attributes
    protected
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def nextTrigger(name: String): Option[Date]

    Returns the next Date a schedule will be fired

  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. 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.

  29. def resumeAll(): Unit

    Unpauses all jobs in the scheduler

  30. 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

  31. val runningJobs: TrieMap[String, JobKey]
  32. 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.

  33. 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.

  34. 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.

  35. 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.

  36. 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.

  37. 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.

  38. lazy val scheduler: Scheduler
    Attributes
    protected
  39. def schedulerName: String
  40. val schedules: TrieMap[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.

  41. 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

  42. 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'

  43. 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.

  44. def suspendAll(): Unit

    Suspends (pauses) all jobs in the scheduler

  45. 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

  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. val threadCount: Int
  48. lazy val threadPool: SimpleThreadPool
    Attributes
    protected
  49. val threadPriority: Int
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. 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

  52. 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.

  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped