org.neo4j.scheduler

Interface JobScheduler

All Superinterfaces:

Lifecycle

public interface JobScheduler
extends Lifecycle

To be expanded, the idea here is to have a database-global service for running jobs, handling jobs crashing and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JobScheduler.CancelListener Gets notified about calls to JobScheduler.JobHandle.cancel(boolean).
static class	JobScheduler.Group Represents a common group of jobs, defining how they should be scheduled.
static class	JobScheduler.Groups This is an exhaustive list of job types that run in the database.
static interface	JobScheduler.JobHandle

Nested classes/interfaces inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

Lifecycle.Delegate

Method Summary

Modifier and Type	Method and Description
Executor	executor(JobScheduler.Group group) Expose a group scheduler as an Executor
JobScheduler.JobHandle	schedule(JobScheduler.Group group, Runnable job) Schedule a new job in the specified group.
JobScheduler.JobHandle	schedule(JobScheduler.Group group, Runnable runnable, long initialDelay, TimeUnit timeUnit) Schedule a new job in the specified group with the given delay
JobScheduler.JobHandle	schedule(JobScheduler.Group group, Runnable job, Map<String,String> metadata) Schedule a new job in the specified group, passing in metadata for the scheduling strategy to use.
JobScheduler.JobHandle	scheduleRecurring(JobScheduler.Group group, Runnable runnable, long initialDelay, long period, TimeUnit timeUnit) Schedule a recurring job where the first invocation is delayed the specified time
JobScheduler.JobHandle	scheduleRecurring(JobScheduler.Group group, Runnable runnable, long period, TimeUnit timeUnit) Schedule a recurring job
ThreadFactory	threadFactory(JobScheduler.Group group) Expose a group scheduler as a ThreadFactory.

Methods inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

init, shutdown, start, stop

Method Detail

executor

Executor executor(JobScheduler.Group group)

Expose a group scheduler as an Executor

threadFactory

ThreadFactory threadFactory(JobScheduler.Group group)

Expose a group scheduler as a ThreadFactory. This is a lower-level alternative than executor(Group), where you are in control of when to spin up new threads for your jobs. The lifecycle of the threads you get out of here are not managed by the JobScheduler, you own the lifecycle and must start the thread before it can be used. This mechanism is strongly preferred over manually creating threads, as it allows a central place for record keeping of thread creation, central place for customizing the threads based on their groups, and lays a foundation for controlling things like thread affinity and priorities in a coordinated manner in the future.

schedule

JobScheduler.JobHandle schedule(JobScheduler.Group group,
                                Runnable job)

Schedule a new job in the specified group.

schedule

JobScheduler.JobHandle schedule(JobScheduler.Group group,
                                Runnable job,
                                Map<String,String> metadata)

Schedule a new job in the specified group, passing in metadata for the scheduling strategy to use.

schedule

JobScheduler.JobHandle schedule(JobScheduler.Group group,
                                Runnable runnable,
                                long initialDelay,
                                TimeUnit timeUnit)

Schedule a new job in the specified group with the given delay

scheduleRecurring

JobScheduler.JobHandle scheduleRecurring(JobScheduler.Group group,
                                         Runnable runnable,
                                         long period,
                                         TimeUnit timeUnit)

Schedule a recurring job

scheduleRecurring

JobScheduler.JobHandle scheduleRecurring(JobScheduler.Group group,
                                         Runnable runnable,
                                         long initialDelay,
                                         long period,
                                         TimeUnit timeUnit)

Schedule a recurring job where the first invocation is delayed the specified time