Index (Atlassian Scheduler - Core 3.0.0 API)

A B C D E F G H I J L M N P Q R S T U V W

A

AbstractJobDetails - Class in com.atlassian.scheduler.core.status: Base implementation for JobDetails.
AbstractJobDetails(JobId, JobRunnerKey, RunMode, Schedule, Date, byte[]) - Constructor for class com.atlassian.scheduler.core.status.AbstractJobDetails
AbstractJobDetailsFactory<T> - Class in com.atlassian.scheduler.core.status: Converts a scheduler implementation's internal representation of a job into a JobDetails.
AbstractJobDetailsFactory(AbstractSchedulerService) - Constructor for class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory
AbstractSchedulerService - Class in com.atlassian.scheduler.core: Base class for implementing a scheduler service.
AbstractSchedulerService(RunDetailsDao) - Constructor for class com.atlassian.scheduler.core.AbstractSchedulerService
AbstractSchedulerService(RunDetailsDao, ParameterMapSerializer) - Constructor for class com.atlassian.scheduler.core.AbstractSchedulerService
addRunDetails(JobId, Date, RunOutcome, String) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Creates or updates the job status record for the given job ID.
addRunDetails(JobId, RunDetails) - Method in class com.atlassian.scheduler.core.impl.MemoryRunDetailsDao
addRunDetails(JobId, RunDetails) - Method in class com.atlassian.scheduler.core.impl.NullRunDetailsDao
addRunDetails(JobId, RunDetails) - Method in interface com.atlassian.scheduler.core.spi.RunDetailsDao: Records the result of an attempt to run the specified job.
appendToStringDetails(StringBuilder) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
appendToStringDetails(StringBuilder) - Method in class com.atlassian.scheduler.core.status.LazyJobDetails
appendToStringDetails(StringBuilder) - Method in class com.atlassian.scheduler.core.status.SimpleJobDetails
appendToStringDetails(StringBuilder) - Method in class com.atlassian.scheduler.core.status.UnusableJobDetails

B

buildJobDetails(JobId, T, RunMode) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory: Transforms the scheduler's internal representation of a job into a JobDetails.
BY_JOB_ID - Static variable in class com.atlassian.scheduler.core.AbstractSchedulerService: Sorts by job ID (and nothing else).

C

calculateNextRunTime(Schedule) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
cancel() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
cancel() - Method in interface com.atlassian.scheduler.core.RunningJob: Requests that the job be cancelled.
checked(SchedulerRuntimeException) - Static method in class com.atlassian.scheduler.core.AbstractSchedulerService: Converts the unchecked SchedulerRuntimeException to the checked SchedulerServiceException.
ClassLoaderAwareObjectInputStream - Class in com.atlassian.scheduler.core.util: An object input stream that uses the provided ClassLoader in preference to any other.
ClassLoaderAwareObjectInputStream(ClassLoader, byte[]) - Constructor for class com.atlassian.scheduler.core.util.ClassLoaderAwareObjectInputStream
com.atlassian.scheduler.core - package com.atlassian.scheduler.core: Core components that will likely be needed by any implementation of the atlassian-scheduler API.
com.atlassian.scheduler.core.impl - package com.atlassian.scheduler.core.impl: Core implementation support classes.
com.atlassian.scheduler.core.spi - package com.atlassian.scheduler.core.spi: Functionality that must be provided by the host application.
com.atlassian.scheduler.core.status - package com.atlassian.scheduler.core.status: Core implementations for a job's details and run history.
com.atlassian.scheduler.core.util - package com.atlassian.scheduler.core.util: Various helpful internal utilities.
createObjectInputStream(ClassLoader, byte[]) - Method in class com.atlassian.scheduler.core.util.ParameterMapSerializer
CronExpressionQuantizer - Class in com.atlassian.scheduler.core.util: Utility class to prevent the use of cron expressions that run more frequently than once per minute.
CronExpressionQuantizer() - Constructor for class com.atlassian.scheduler.core.util.CronExpressionQuantizer
CronExpressionQuantizer.Randomize - Enum in com.atlassian.scheduler.core.util: Controls whether or not randomization is performed when a cron expression is quantized.

D

DefaultSchedulerHistoryService - Class in com.atlassian.scheduler.core
DefaultSchedulerHistoryService(RunDetailsDao) - Constructor for class com.atlassian.scheduler.core.DefaultSchedulerHistoryService
DelegatingSchedulerService - Class in com.atlassian.scheduler.core: A scheduler service that delegates all requests to another scheduler service.
DelegatingSchedulerService(SchedulerService) - Constructor for class com.atlassian.scheduler.core.DelegatingSchedulerService
deserializeParameters(ClassLoader, byte[]) - Method in class com.atlassian.scheduler.core.util.ParameterMapSerializer: Deserializes the parameters map from a byte array using the provided ClassLoader.

E

equals(Object) - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl

F

firedAt - Variable in class com.atlassian.scheduler.core.JobLauncher

G

getDefaultTimeZone() - Method in interface com.atlassian.scheduler.core.spi.SchedulerServiceConfiguration: Returns the default TimeZone to use when scheduling a job to run according to a cron expression when no specific time zone is provided.
getDurationInMillis() - Method in class com.atlassian.scheduler.core.status.RunDetailsImpl
getJobConfig() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
getJobDetails(JobId) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
getJobId() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
getJobId() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
getJobRunner(JobRunnerKey) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
getJobRunner(JobRunnerKey) - Method in class com.atlassian.scheduler.core.util.JobRunnerRegistry
getJobRunnerKey() - Method in exception com.atlassian.scheduler.core.JobRunnerNotRegisteredException
getJobRunnerKey() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
getJobRunnerKey(T) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory: Provided by the scheduler implementation to extract the job's JobRunnerKey from the scheduler's internal representation of the job.
getJobRunnerKeysForAllScheduledJobs() - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
getJobsByJobRunnerKey(JobRunnerKey) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
getLastRunForJob(JobId) - Method in class com.atlassian.scheduler.core.DefaultSchedulerHistoryService
getLastRunForJob(JobId) - Method in class com.atlassian.scheduler.core.impl.MemoryRunDetailsDao
getLastRunForJob(JobId) - Method in class com.atlassian.scheduler.core.impl.NullRunDetailsDao
getLastRunForJob(JobId) - Method in interface com.atlassian.scheduler.core.spi.RunDetailsDao: Returns the result of the most recent attempt to run this job.
getLastSuccessfulRunForJob(JobId) - Method in class com.atlassian.scheduler.core.DefaultSchedulerHistoryService
getLastSuccessfulRunForJob(JobId) - Method in class com.atlassian.scheduler.core.impl.MemoryRunDetailsDao
getLastSuccessfulRunForJob(JobId) - Method in class com.atlassian.scheduler.core.impl.NullRunDetailsDao
getLastSuccessfulRunForJob(JobId) - Method in interface com.atlassian.scheduler.core.spi.RunDetailsDao: Returns the result of the most recent successful run of this job.
getLocallyRunningJobs() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
getLocallyRunningJobs() - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Returns the list of jobs that are currently executing on this node.
getMessage() - Method in class com.atlassian.scheduler.core.status.RunDetailsImpl
getNextRunTime() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
getNextRunTime(T) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory: Provided by the scheduler implementation to extract the job's next scheduled run time from the scheduler's internal representation of the job.
getParameterMapSerializer() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Returns the parameter map serializer used by this scheduler.
getParameters() - Method in class com.atlassian.scheduler.core.status.LazyJobDetails
getParameters() - Method in class com.atlassian.scheduler.core.status.SimpleJobDetails
getParameters() - Method in class com.atlassian.scheduler.core.status.UnusableJobDetails: The parameters are not available because the map could not be reconstructed.
getRawParameters() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails: Returns the raw bytes from the job's parameters.
getRegisteredJobRunnerKeys() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
getRegisteredJobRunnerKeys() - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
getRegisteredJobRunnerKeys() - Method in class com.atlassian.scheduler.core.util.JobRunnerRegistry
getRunMode() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
getRunOutcome() - Method in class com.atlassian.scheduler.core.status.RunDetailsImpl
getSchedule() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
getSchedule(T) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory: Provided by the scheduler implementation to extract the job's Schedule from the scheduler's internal representation of the job.
getSerializedParameters(T) - Method in class com.atlassian.scheduler.core.status.AbstractJobDetailsFactory: Provided by the scheduler implementation to extract the job's parameters map (in serialized form) from the scheduler's internal representation of the job.
getStartTime() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
getStartTime() - Method in class com.atlassian.scheduler.core.status.RunDetailsImpl
getState() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
getState() - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Returns the scheduler service's running state.

H

hashCode() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl

I

isCancellationRequested() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
isRunnable() - Method in class com.atlassian.scheduler.core.status.LazyJobDetails
isRunnable() - Method in class com.atlassian.scheduler.core.status.SimpleJobDetails
isRunnable() - Method in class com.atlassian.scheduler.core.status.UnusableJobDetails

J

jobId - Variable in class com.atlassian.scheduler.core.JobLauncher
jobId - Variable in class com.atlassian.scheduler.core.status.AbstractJobDetails
JobLauncher - Class in com.atlassian.scheduler.core: Scheduler implementations can (and should) use JobLauncher to invoke jobs when it is time to run them.
JobLauncher(AbstractSchedulerService, RunMode, Date, JobId) - Constructor for class com.atlassian.scheduler.core.JobLauncher: Creates a job launcher to handle the running of a scheduled job.
JobLauncher(AbstractSchedulerService, RunMode, Date, JobId, JobDetails) - Constructor for class com.atlassian.scheduler.core.JobLauncher: Creates a job launcher to handle the running of a scheduled job.
jobRunnerKey - Variable in class com.atlassian.scheduler.core.status.AbstractJobDetails
JobRunnerNotRegisteredException - Exception in com.atlassian.scheduler.core
JobRunnerNotRegisteredException(JobRunnerKey) - Constructor for exception com.atlassian.scheduler.core.JobRunnerNotRegisteredException
JobRunnerRegistry - Class in com.atlassian.scheduler.core.util: Encapsulates the registration and retrieval of job runners.
JobRunnerRegistry() - Constructor for class com.atlassian.scheduler.core.util.JobRunnerRegistry

L

launch() - Method in class com.atlassian.scheduler.core.JobLauncher: Call this to validate the job, run it, and update its status.
LazyJobDetails - Class in com.atlassian.scheduler.core.status: A job details implementation that waits until the first request to one of the methods that needs to know the state of the parameters map before trying to deserialize it.
LazyJobDetails(AbstractSchedulerService, JobId, JobRunnerKey, RunMode, Schedule, Date, byte[]) - Constructor for class com.atlassian.scheduler.core.status.LazyJobDetails: Creates a lazy job details representation.
LifecycleAwareSchedulerService - Interface in com.atlassian.scheduler.core: An interface that scheduler service implementations will generally be expected to implement so that they can be stopped from accepting jobs when the application is not at a point in its lifecycle where it should be running them.
LifecycleAwareSchedulerService.State - Enum in com.atlassian.scheduler.core: A representation of the scheduler's current state.
LOG - Static variable in class com.atlassian.scheduler.core.JobLauncher
LogWarn - Class in com.atlassian.scheduler.core.util: Log a warning, optionally including a full stack trace if the logger's DEBUG level is enabled.
logWarn(Logger, String, Throwable) - Static method in class com.atlassian.scheduler.core.util.LogWarn: Log a warning, optionally including a full stack trace if the logger's DEBUG level is enabled.

M

mapException(String, ParseException) - Static method in class com.atlassian.scheduler.core.util.QuartzParseExceptionMapper
MemoryRunDetailsDao - Class in com.atlassian.scheduler.core.impl: An implementation of the RunDetailsDao that keeps the scheduler history in memory.
MemoryRunDetailsDao() - Constructor for class com.atlassian.scheduler.core.impl.MemoryRunDetailsDao
MemoryRunDetailsDao(int) - Constructor for class com.atlassian.scheduler.core.impl.MemoryRunDetailsDao

N

NullRunDetailsDao - Class in com.atlassian.scheduler.core.impl: An implementation of RunDetailsDao that silently discards all run details supplied to it.
NullRunDetailsDao() - Constructor for class com.atlassian.scheduler.core.impl.NullRunDetailsDao

P

ParameterMapSerializer - Class in com.atlassian.scheduler.core.util: Utility for serializing the parameters map to a byte[] and restoring it to its original form.
ParameterMapSerializer() - Constructor for class com.atlassian.scheduler.core.util.ParameterMapSerializer
postJob() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: This method is called after a job has finished execution.
preJob() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: This method is called before a job begins execution.

Q

quantize(long, int) - Static method in class com.atlassian.scheduler.core.util.TimeIntervalQuantizer: Quantizes millisecond time intervals to the specified resolution, rounding up.
quantizeSecondsField(String) - Static method in class com.atlassian.scheduler.core.util.CronExpressionQuantizer: Quantize the seconds field using CronExpressionQuantizer.Randomize.AS_NEEDED.
quantizeSecondsField(String, CronExpressionQuantizer.Randomize) - Static method in class com.atlassian.scheduler.core.util.CronExpressionQuantizer: Quantize the seconds field, randomizing it as requested.
quantizeToMinutes(long) - Static method in class com.atlassian.scheduler.core.util.TimeIntervalQuantizer: Quantizes millisecond time intervals to a one minute resolution, rounding up.
QuartzParseExceptionMapper - Class in com.atlassian.scheduler.core.util: Maps the various ParseException messages from Quartz to our more informative and translatable exceptions in the CronSyntaxException family.
QuartzParseExceptionMapper() - Constructor for class com.atlassian.scheduler.core.util.QuartzParseExceptionMapper

R

registerJobRunner(JobRunnerKey, JobRunner) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
registerJobRunner(JobRunnerKey, JobRunner) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
registerJobRunner(JobRunnerKey, JobRunner) - Method in class com.atlassian.scheduler.core.util.JobRunnerRegistry
resolveClass(ObjectStreamClass) - Method in class com.atlassian.scheduler.core.util.ClassLoaderAwareObjectInputStream
RunDetailsDao - Interface in com.atlassian.scheduler.core.spi: Service provided by the host application to persist RunDetails objects.
RunDetailsImpl - Class in com.atlassian.scheduler.core.status
RunDetailsImpl(Date, RunOutcome, long, String) - Constructor for class com.atlassian.scheduler.core.status.RunDetailsImpl
runMode - Variable in class com.atlassian.scheduler.core.status.AbstractJobDetails
RunningJob - Interface in com.atlassian.scheduler.core: Represents a particular instance of a running job.
RunningJobImpl - Class in com.atlassian.scheduler.core.impl
RunningJobImpl(Date, JobId, JobConfig) - Constructor for class com.atlassian.scheduler.core.impl.RunningJobImpl

S

schedule - Variable in class com.atlassian.scheduler.core.status.AbstractJobDetails
scheduleJob(JobId, JobConfig) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
scheduleJobWithGeneratedId(JobConfig) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
scheduleJobWithGeneratedId(JobConfig) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
schedulerRunMode - Variable in class com.atlassian.scheduler.core.JobLauncher
schedulerService - Variable in class com.atlassian.scheduler.core.JobLauncher
SchedulerServiceConfiguration - Interface in com.atlassian.scheduler.core.spi: Allows the host application to supply configuration parameters to the scheduler services.
SchedulerServiceController - Interface in com.atlassian.scheduler.core
serializeParameters(Map<String, Serializable>) - Method in class com.atlassian.scheduler.core.util.ParameterMapSerializer: Serializes the parameters to a byte array.
shutdown() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
shutdown() - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Permanent shutdown of the scheduler.
shutdownImpl() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Provided by the scheduler service to implement AbstractSchedulerService.shutdown() requests.
SimpleJobDetails - Class in com.atlassian.scheduler.core.status: A simple, concrete implementation of JobDetails that has the parameter map present.
SimpleJobDetails(JobId, JobRunnerKey, RunMode, Schedule, Date, byte[], Map<String, Serializable>) - Constructor for class com.atlassian.scheduler.core.status.SimpleJobDetails
standby() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
standby() - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Places the scheduler into standby mode.
standbyImpl() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Provided by the scheduler service to implement AbstractSchedulerService.standby() requests.
start() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
start() - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Starts the scheduler if it had never been started or had been placed in SchedulerServiceController.standby() mode.
startImpl() - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Provided by the scheduler service to implement AbstractSchedulerService.start() requests.

T

TimeIntervalQuantizer - Class in com.atlassian.scheduler.core.util: Tool for quantizing millisecond time intervals to a broader resolution while guarding against sign overflows.
TimeIntervalQuantizer() - Constructor for class com.atlassian.scheduler.core.util.TimeIntervalQuantizer
toString() - Method in class com.atlassian.scheduler.core.impl.RunningJobImpl
toString() - Method in class com.atlassian.scheduler.core.JobLauncher
toString() - Method in class com.atlassian.scheduler.core.status.AbstractJobDetails
toString() - Method in class com.atlassian.scheduler.core.status.RunDetailsImpl

U

unregisterJobRunner(JobRunnerKey) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService
unregisterJobRunner(JobRunnerKey) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
unregisterJobRunner(JobRunnerKey) - Method in class com.atlassian.scheduler.core.util.JobRunnerRegistry
unscheduleJob(JobId) - Method in class com.atlassian.scheduler.core.DelegatingSchedulerService
UnusableJobDetails - Class in com.atlassian.scheduler.core.status: Concrete implementation of JobDetails that always throws an exception when the parameters are accessed.
UnusableJobDetails(JobId, JobRunnerKey, RunMode, Schedule, Date, byte[], Throwable) - Constructor for class com.atlassian.scheduler.core.status.UnusableJobDetails

V

valueOf(String) - Static method in enum com.atlassian.scheduler.core.LifecycleAwareSchedulerService.State: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.scheduler.core.util.CronExpressionQuantizer.Randomize: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.atlassian.scheduler.core.LifecycleAwareSchedulerService.State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.scheduler.core.util.CronExpressionQuantizer.Randomize: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitUntilIdle(long, TimeUnit) - Method in class com.atlassian.scheduler.core.AbstractSchedulerService: Waits for up to timeout units for any currently executing jobs to complete.
waitUntilIdle(long, TimeUnit) - Method in interface com.atlassian.scheduler.core.SchedulerServiceController: Waits for up to timeout units for any currently executing jobs to complete.

A B C D E F G H I J L M N P Q R S T U V W