A B C E F G H I J M O R S T U V W

A

aborted(String) - Static method in class com.atlassian.scheduler.JobRunnerResponse

Creates a response that indicates the request was aborted.

B

build() - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Returns the completed exception.

builder() - Static method in exception com.atlassian.scheduler.cron.CronSyntaxException

Returns a builder for constructing a CronSyntaxExpression.

C

calculateNextRunTime(Schedule) - Method in interface com.atlassian.scheduler.SchedulerService

Returns the next time that a job with the given schedule would be expected to run.

cause(Throwable) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the cause of the exception.

com.atlassian.scheduler - package com.atlassian.scheduler

Major component interfaces and supporting classes for the atlassian-scheduler API.

com.atlassian.scheduler.config - package com.atlassian.scheduler.config

API classes related to the configuration of scheduled jobs.

com.atlassian.scheduler.cron - package com.atlassian.scheduler.cron

Tools for working with cron expressions, including validation and translatable errors.

com.atlassian.scheduler.status - package com.atlassian.scheduler.status

API classes related to the current status of a job or the results of running one.

com.atlassian.scheduler.util - package com.atlassian.scheduler.util

Utility classes for internal use by the API.

compareTo(JobId) - Method in class com.atlassian.scheduler.config.JobId

compareTo(JobRunnerKey) - Method in class com.atlassian.scheduler.config.JobRunnerKey

copy(Date) - Static method in class com.atlassian.scheduler.util.Safe

Make a defensive copy of a mutable Date.

copy(byte[]) - Static method in class com.atlassian.scheduler.util.Safe

Make a defensive copy of a byte array.

copy(Map<String, Serializable>) - Static method in class com.atlassian.scheduler.util.Safe

Make a defensive copy of a possibly mutable map.

cronExpression(String) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the cron expression that caused the exception.

CronExpressionValidator - Interface in com.atlassian.scheduler.cron

CronScheduleInfo - Class in com.atlassian.scheduler.config

The description of a cron expression schedule.

CronSyntaxException - Exception in com.atlassian.scheduler.cron

Signals that there is a syntax error in a given cron expression.

CronSyntaxException.Builder - Class in com.atlassian.scheduler.cron

A builder for constructing a CronSyntaxException.

E

equals(Object) - Method in class com.atlassian.scheduler.config.CronScheduleInfo

equals(Object) - Method in class com.atlassian.scheduler.config.IntervalScheduleInfo

equals(Object) - Method in class com.atlassian.scheduler.config.JobConfig

equals(Object) - Method in class com.atlassian.scheduler.config.JobId

equals(Object) - Method in class com.atlassian.scheduler.config.JobRunnerKey

equals(Object) - Method in class com.atlassian.scheduler.config.Schedule

equals(Object) - Method in class com.atlassian.scheduler.JobRunnerResponse

errorCode(ErrorCode) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the error code for the exception.

ErrorCode - Enum in com.atlassian.scheduler.cron

Clarifies the reason for failure when a cron expression cannot be parsed.

errorOffset(int) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the error code for the exception.

F

failed(String) - Static method in class com.atlassian.scheduler.JobRunnerResponse

Creates a response that indicates the request has failed.

failed(Throwable) - Static method in class com.atlassian.scheduler.JobRunnerResponse

Creates a response that indicates the request has failed.

forCronExpression(String) - Static method in class com.atlassian.scheduler.config.Schedule

Creates a new schedule for the given cron expression.

forCronExpression(String, TimeZone) - Static method in class com.atlassian.scheduler.config.Schedule

Creates a new schedule for the given cron expression.

forInterval(long, Date) - Static method in class com.atlassian.scheduler.config.Schedule

Creates a new schedule that will run periodically with the given interval.

forJobRunnerKey(JobRunnerKey) - Static method in class com.atlassian.scheduler.config.JobConfig

Creates a new job configuration for the specified job runner key.

G

getCronExpression() - Method in class com.atlassian.scheduler.config.CronScheduleInfo

getCronExpression() - Method in exception com.atlassian.scheduler.cron.CronSyntaxException

Returns the cron expression that could not be parsed.

getCronScheduleInfo() - Method in class com.atlassian.scheduler.config.Schedule

Returns a representation of the cron settings that were used to create this schedule.

getDurationInMillis() - Method in interface com.atlassian.scheduler.status.RunDetails

Returns the duration (in milliseconds) that the job took to complete.

getErrorCode() - Method in exception com.atlassian.scheduler.cron.CronSyntaxException

Returns the error code identifying the underlying cause of the parse failure.

getErrorOffset() - Method in exception com.atlassian.scheduler.cron.CronSyntaxException

Returns the 0-based index of the character at which the parse error was identified.

getFirstRunTime() - Method in class com.atlassian.scheduler.config.IntervalScheduleInfo

getIntervalInMillis() - Method in class com.atlassian.scheduler.config.IntervalScheduleInfo

getIntervalScheduleInfo() - Method in class com.atlassian.scheduler.config.Schedule

Returns a representation of the simple settings that were used to create this schedule.

getJobConfig() - Method in interface com.atlassian.scheduler.JobRunnerRequest

Returns the job's configuration, such as its schedule and parameters.

getJobDetails(JobId) - Method in interface com.atlassian.scheduler.SchedulerService

Retrieves the details for the specified job ID.

getJobId() - Method in interface com.atlassian.scheduler.JobRunnerRequest

Returns the job ID that was used to schedule this job.

getJobId() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the job ID that was used to schedule this job, or the one that was generated for it if the job was scheduled without specifying one.

getJobRunnerKey() - Method in class com.atlassian.scheduler.config.JobConfig

getJobRunnerKey() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the job runner key that was specified when this job was scheduled.

getJobRunnerKeysForAllScheduledJobs() - Method in interface com.atlassian.scheduler.SchedulerService

Returns all of the job runner keys that have been used to schedule jobs, regardless of whether or not JobRunners are currently registered for them.

getJobsByJobRunnerKey(JobRunnerKey) - Method in interface com.atlassian.scheduler.SchedulerService

Retrieves the job details for all jobs with the given job runner key.

getLastRunForJob(JobId) - Method in interface com.atlassian.scheduler.SchedulerHistoryService

Returns the result of the most recent attempt to run this job.

getLastSuccessfulRunForJob(JobId) - Method in interface com.atlassian.scheduler.SchedulerHistoryService

Returns the result of the most recent successful run of this job.

getMessage() - Method in class com.atlassian.scheduler.JobRunnerResponse

getMessage() - Method in interface com.atlassian.scheduler.status.RunDetails

Returns any additional message that the job would like to report about this job run.

getNextRunTime() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the next time at which this job will run, if known.

getParameters() - Method in class com.atlassian.scheduler.config.JobConfig

getParameters() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the configured runtime parameters for this job.

getRegisteredJobRunnerKeys() - Method in interface com.atlassian.scheduler.SchedulerService

Returns all of the job runner keys that currently have registered job runners, regardless of whether or not any jobs have actually been scheduled for them.

getRunMode() - Method in class com.atlassian.scheduler.config.JobConfig

getRunMode() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the configured run mode that was specified when this job was scheduled.

getRunOutcome() - Method in class com.atlassian.scheduler.JobRunnerResponse

getRunOutcome() - Method in interface com.atlassian.scheduler.status.RunDetails

Returns the overall result of the job

getSchedule() - Method in class com.atlassian.scheduler.config.JobConfig

getSchedule() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns the schedule that the Job will run under.

getStartTime() - Method in interface com.atlassian.scheduler.JobRunnerRequest

Returns the time at which the job was started.

getStartTime() - Method in interface com.atlassian.scheduler.status.RunDetails

Returns the starting time of this job run.

getTimeZone() - Method in class com.atlassian.scheduler.config.CronScheduleInfo

getType() - Method in class com.atlassian.scheduler.config.Schedule

Returns the Schedule.Type of this schedule.

getValue() - Method in exception com.atlassian.scheduler.cron.CronSyntaxException

Returns the value that caused the exception to be thrown, if that information is available.

H

hashCode() - Method in class com.atlassian.scheduler.config.CronScheduleInfo

hashCode() - Method in class com.atlassian.scheduler.config.IntervalScheduleInfo

hashCode() - Method in class com.atlassian.scheduler.config.JobConfig

hashCode() - Method in class com.atlassian.scheduler.config.JobId

hashCode() - Method in class com.atlassian.scheduler.config.JobRunnerKey

hashCode() - Method in class com.atlassian.scheduler.config.Schedule

hashCode() - Method in class com.atlassian.scheduler.JobRunnerResponse

I

IntervalScheduleInfo - Class in com.atlassian.scheduler.config

The description of an Schedule.forInterval(long, Date) interval schedule}.

isCancellationRequested() - Method in interface com.atlassian.scheduler.JobRunnerRequest

Returns true if the job runner should terminate its activities as gracefully as possible and exit; false to continue running normally.

isRunnable() - Method in interface com.atlassian.scheduler.status.JobDetails

Returns true if this job could be successfully run at this time.

isValid(String) - Method in interface com.atlassian.scheduler.cron.CronExpressionValidator

Returns true if the cron expression can be parsed successfully.

J

JobConfig - Class in com.atlassian.scheduler.config

Configuration options available when scheduling a job to be run.

JobDetails - Interface in com.atlassian.scheduler.status

All the static details for a given scheduled job.

JobId - Class in com.atlassian.scheduler.config

A wrapper to distinguish job IDs from simple strings and to make it easier to avoid confusing them with job runner keys.

JobRunner - Interface in com.atlassian.scheduler

Invoked by the SchedulerService when it is time for a scheduled job to run.

JobRunnerKey - Class in com.atlassian.scheduler.config

A wrapper to distinguish job runner keys from simple strings and to make it easier to avoid confusing them with Job IDs

JobRunnerRequest - Interface in com.atlassian.scheduler

Represents a request to run a job, providing information such as the job's configuration and intended start time.

JobRunnerResponse - Class in com.atlassian.scheduler

An object that represents the result of a call to JobRunner.runJob(JobRunnerRequest).

M

MAXIMUM_MESSAGE_LENGTH - Static variable in interface com.atlassian.scheduler.status.RunDetails

The maximum length that is permitted for the message string returned in a JobRunnerResponse.

O

of(String) - Static method in class com.atlassian.scheduler.config.JobId

Wraps the provided string as a JobId.

of(String) - Static method in class com.atlassian.scheduler.config.JobRunnerKey

Wraps the provided string as a JobRunnerKey.

R

registerJobRunner(JobRunnerKey, JobRunner) - Method in interface com.atlassian.scheduler.SchedulerService

Registers the job runner for a given job runner key.

RunDetails - Interface in com.atlassian.scheduler.status

A report of the result from a specific attempt to run a job.

runJob(JobRunnerRequest) - Method in interface com.atlassian.scheduler.JobRunner

Called by the SchedulerService when it is time for a job to run.

RunMode - Enum in com.atlassian.scheduler.config

Represents how a Job will be run by the scheduler.

runOnce(Date) - Static method in class com.atlassian.scheduler.config.Schedule

Creates a new schedule that will run once at the specified time.

RunOutcome - Enum in com.atlassian.scheduler.status

Indicates what the result was the last time that this job attempted to fire.

S

Safe - Class in com.atlassian.scheduler.util

Static utility methods for things like null-testing and defensive copies.

Schedule - Class in com.atlassian.scheduler.config

Represents a schedule used to run a job at particular times.

Schedule.Type - Enum in com.atlassian.scheduler.config

scheduleJob(JobId, JobConfig) - Method in interface com.atlassian.scheduler.SchedulerService

Schedules a job with the given job ID.

scheduleJobWithGeneratedId(JobConfig) - Method in interface com.atlassian.scheduler.SchedulerService

Schedules a "dynamic" job by generating a new unique job ID.

SchedulerHistoryService - Interface in com.atlassian.scheduler

Allows you to retrieve data about previous runs of a job.

SchedulerRuntimeException - Exception in com.atlassian.scheduler

Indicates a problem interacting with the SchedulerService.

SchedulerRuntimeException(String) - Constructor for exception com.atlassian.scheduler.SchedulerRuntimeException

SchedulerRuntimeException(String, Throwable) - Constructor for exception com.atlassian.scheduler.SchedulerRuntimeException

SchedulerService - Interface in com.atlassian.scheduler

Scheduler service for Atlassian products and their plugins.

SchedulerServiceException - Exception in com.atlassian.scheduler

Indicates a problem interacting with the SchedulerService.

SchedulerServiceException(String) - Constructor for exception com.atlassian.scheduler.SchedulerServiceException

SchedulerServiceException(String, Throwable) - Constructor for exception com.atlassian.scheduler.SchedulerServiceException

success() - Static method in class com.atlassian.scheduler.JobRunnerResponse

Creates a successful response with no additional message.

success(String) - Static method in class com.atlassian.scheduler.JobRunnerResponse

Creates a successful response with the specified message.

T

toMessage(String) - Method in enum com.atlassian.scheduler.cron.ErrorCode

Renders the standard message for this error code and offending value.

toString() - Method in class com.atlassian.scheduler.config.CronScheduleInfo

toString() - Method in class com.atlassian.scheduler.config.IntervalScheduleInfo

toString() - Method in class com.atlassian.scheduler.config.JobConfig

toString() - Method in class com.atlassian.scheduler.config.JobId

toString() - Method in class com.atlassian.scheduler.config.JobRunnerKey

toString() - Method in class com.atlassian.scheduler.config.Schedule

toString() - Method in class com.atlassian.scheduler.JobRunnerResponse

U

unregisterJobRunner(JobRunnerKey) - Method in interface com.atlassian.scheduler.SchedulerService

Unregisters the specified job runner.

unscheduleJob(JobId) - Method in interface com.atlassian.scheduler.SchedulerService

Unschedules a previously scheduled job ID.

V

validate(String) - Method in interface com.atlassian.scheduler.cron.CronExpressionValidator

Validates that a cron expression can be successfully parsed.

value(String) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the value that caused the exception.

value(char) - Method in class com.atlassian.scheduler.cron.CronSyntaxException.Builder

Sets the value that caused the exception.

valueOf(String) - Static method in enum com.atlassian.scheduler.config.RunMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.scheduler.config.Schedule.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.scheduler.cron.ErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.scheduler.status.RunOutcome

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.scheduler.config.RunMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.scheduler.config.Schedule.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.scheduler.cron.ErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.scheduler.status.RunOutcome

Returns an array containing the constants of this enum type, in the order they are declared.

W

withParameters(Map<String, Serializable>) - Method in class com.atlassian.scheduler.config.JobConfig

Returns a copy of this job config that will use the specified parameters instead of what it currently uses.

withRunMode(RunMode) - Method in class com.atlassian.scheduler.config.JobConfig

Returns a copy of this job config that will use the specified run mode instead of what it currently uses.

withSchedule(Schedule) - Method in class com.atlassian.scheduler.config.JobConfig

Returns a copy of this job config that will use the specified schedule instead of what it currently uses.

A B C E F G H I J M O R S T U V W