- getAt() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
Return the scheduled execution date for a schedule of type date.
- getAverageProcessingTime() - Method in interface org.apache.sling.event.jobs.Statistics
-
The average processing time of a job - this only counts finished jobs.
- getAverageProcessingTime() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
The average processing time of a job - this only counts finished jobs.
- getAverageWaitingTime() - Method in interface org.apache.sling.event.jobs.Statistics
-
The average waiting time of a job in the queue.
- getAverageWaitingTime() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
The average waiting time of a job in the queue.
- getConfiguration() - Method in interface org.apache.sling.event.jobs.Queue
-
Get the corresponding configuration.
- getCreated() - Method in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains a calendar object
specifying the date and time when this job has been created.
- getCreatedInstance() - Method in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains the Sling instance ID
of the instance where this job has been created.
- getDayOfMonth() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
If the job is scheduled monthly, returns the day of the month
- getDayOfWeek() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
If the job is scheduled weekly, returns the day of the week
- getExpression() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
If the schedule is a cron expression, return the expression.
- getFinishedDate() - Method in interface org.apache.sling.event.jobs.Job
-
If the job is cancelled or succeeded, this method will return the finish date.
- getFinishedProgressStep() - Method in interface org.apache.sling.event.jobs.Job
-
If the job is in processing, return the optional information
about the finished steps.
- getHourOfDay() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
Return the hour of the day for daily and weekly scheduled jobs
- getId() - Method in interface org.apache.sling.event.jobs.Job
-
Unique job ID.
- getJob(String, Map<String, Object>) - Method in interface org.apache.sling.event.jobs.JobManager
-
Find a job - either queued or active.
- getJobById(String) - Method in interface org.apache.sling.event.jobs.JobManager
-
Return a job based on the unique id.
- getJobProperties() - Method in interface org.apache.sling.event.jobs.ScheduledJobInfo
-
Return the optional job topics.
- getJobState() - Method in interface org.apache.sling.event.jobs.Job
-
Get the job state
- getJobTopic() - Method in interface org.apache.sling.event.jobs.ScheduledJobInfo
-
Return the job topic.
- getLastActivatedJobDate() - Method in interface org.apache.sling.event.jobs.jmx.StatisticsMBean
-
- getLastActivatedJobTime() - Method in interface org.apache.sling.event.jobs.Statistics
-
The time a job has been started last.
- getLastActivatedJobTime() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
The time a job has been started last.
- getLastFinishedJobDate() - Method in interface org.apache.sling.event.jobs.jmx.StatisticsMBean
-
- getLastFinishedJobTime() - Method in interface org.apache.sling.event.jobs.Statistics
-
The time a job has been finished/failed/cancelled last.
- getLastFinishedJobTime() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
The time a job has been finished/failed/cancelled last.
- getMaxParallel() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the max number of parallel processes.
- getMaxRetries() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the max number of retries, -1 for endless retry!
- getMessage() - Method in interface org.apache.sling.event.jobs.consumer.JobExecutionResult
-
Return the optional message.
- getMinuteOfHour() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
Return the minute of the hour for daily, weekly and hourly scheduled jobs.
- getMonthOfYear() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
If the job is scheduled yearly, returns the month of the year
- getName() - Method in interface org.apache.sling.event.jobs.jmx.StatisticsMBean
-
- getName() - Method in interface org.apache.sling.event.jobs.Queue
-
Get the queue name.
- getNextScheduledExecution() - Method in interface org.apache.sling.event.jobs.ScheduledJobInfo
-
Return the next scheduled execution date.
- getNumberOfActiveJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of jobs currently in processing.
- getNumberOfCancelledJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of permanently failing or cancelled jobs.
- getNumberOfCancelledJobs() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
Number of permanently failing or cancelled jobs.
- getNumberOfFailedJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of failing jobs.
- getNumberOfFailedJobs() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
Number of failing jobs.
- getNumberOfFinishedJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of successfully finished jobs.
- getNumberOfFinishedJobs() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
Number of successfully finished jobs.
- getNumberOfJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
- getNumberOfProcessedJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of already processed jobs.
- getNumberOfProcessedJobs() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
Number of already processed jobs.
- getNumberOfQueuedJobs() - Method in interface org.apache.sling.event.jobs.Statistics
-
Number of jobs currently waiting in a queue.
- getNumberOfRetries() - Method in interface org.apache.sling.event.jobs.Job
-
The property to track the retry maximum retry count for jobs.
- getOwnThreadPoolSize() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the size for the optional thread pool for this queue.
- getProcessingStarted() - Method in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains a calendar object
specifying the date and time when this job has been started.
- getProgressETA() - Method in interface org.apache.sling.event.jobs.Job
-
If the job is in processing, return the optional ETA for this job.
- getProgressLog() - Method in interface org.apache.sling.event.jobs.Job
-
This method returns the optional progress log from the last job
processing.
- getProgressStepCount() - Method in interface org.apache.sling.event.jobs.Job
-
If the job is in processing, return the optional progress step
count if available.
- getProperty(String) - Method in interface org.apache.sling.event.jobs.Job
-
Get the value of a property.
- getProperty(String, Class<T>) - Method in interface org.apache.sling.event.jobs.Job
-
Get a named property and convert it into the given type.
- getProperty(String, T) - Method in interface org.apache.sling.event.jobs.Job
-
Get a named property and convert it into the given type.
- getPropertyNames() - Method in interface org.apache.sling.event.jobs.Job
-
Get all property names.
- getQueue(String) - Method in interface org.apache.sling.event.jobs.JobManager
-
Return a queue with a specific name (if running)
- getQueueName() - Method in interface org.apache.sling.event.jobs.Job
-
The name of the job queue processing this job.
- getQueueNames() - Method in interface org.apache.sling.event.jobs.jmx.QueuesMBean
-
- getQueues() - Method in interface org.apache.sling.event.jobs.JobManager
-
Return an iterator for all available queues.
- getRanking() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Get the ranking of this configuration.
- getResultMessage() - Method in interface org.apache.sling.event.jobs.Job
-
This method returns the message from the last job processing, regardless
whether the processing failed, succeeded or was cancelled.
- getRetryCount() - Method in interface org.apache.sling.event.jobs.Job
-
On first execution the value of this property is zero.
- getRetryDelayInMs() - Method in interface org.apache.sling.event.jobs.consumer.JobExecutionResult
-
Return the retry delay in ms
- getRetryDelayInMs() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the retry delay in ms
- getScheduledJobs() - Method in interface org.apache.sling.event.jobs.JobManager
-
Return all available job schedules.
- getScheduledJobs(String, long, Map<String, Object>...) - Method in interface org.apache.sling.event.jobs.JobManager
-
Return all matching available job schedules.
- getSchedules() - Method in interface org.apache.sling.event.jobs.ScheduledJobInfo
-
Get all schedules for this job
- getStartDate() - Method in interface org.apache.sling.event.jobs.jmx.StatisticsMBean
-
- getStartTime() - Method in interface org.apache.sling.event.jobs.Statistics
-
The time this service has been started
- getState(String) - Method in interface org.apache.sling.event.jobs.Queue
-
For monitoring purposes and possible extensions from the different
queue types.
- getStateInfo() - Method in interface org.apache.sling.event.jobs.Queue
-
Return some information about the current state of the queue.
- getStatistics() - Method in interface org.apache.sling.event.jobs.JobManager
-
Return statistics information about all queues.
- getStatistics() - Method in interface org.apache.sling.event.jobs.Queue
-
Return statistics information about this queue.
- getTargetInstance() - Method in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains the Sling instance ID
of the instance where this job should be processed.
- getThreadPriority() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the thread priority for the job thread
- getTopic() - Method in interface org.apache.sling.event.jobs.Job
-
The job topic.
- getTopic() - Method in interface org.apache.sling.event.jobs.TopicStatistics
-
The topic this statistics is about.
- getTopics() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
The list of topics this queue is bound to.
- getTopicStatistics() - Method in interface org.apache.sling.event.jobs.JobManager
-
Return statistics information about job topics.
- getType() - Method in interface org.apache.sling.event.jobs.QueueConfiguration
-
Return the queue type.
- getType() - Method in interface org.apache.sling.event.jobs.ScheduleInfo
-
Return the scheduling type
- process(Job) - Method in interface org.apache.sling.event.jobs.consumer.JobConsumer
-
Execute the job.
- process(Job, JobExecutionContext) - Method in interface org.apache.sling.event.jobs.consumer.JobExecutor
-
Execute the job.
- properties(Map<String, Object>) - Method in interface org.apache.sling.event.jobs.JobBuilder
-
Set the optional configuration properties for the job.
- PROPERTY_FINISHED_DATE - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains the finished date once a job is marked as finished.
- PROPERTY_JOB_ASYNC_HANDLER - Static variable in interface org.apache.sling.event.jobs.consumer.JobConsumer
-
Job property containing an asynchronous handler.
- PROPERTY_JOB_CREATED - Static variable in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains a calendar object
specifying the date and time when this job has been created.
- PROPERTY_JOB_CREATED_INSTANCE - Static variable in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains the Sling instance ID
of the instance where this job has been created.
- PROPERTY_JOB_DESCRIPTION - Static variable in interface org.apache.sling.event.jobs.Job
-
This is an optional property containing a human readable description for
the job
- PROPERTY_JOB_PROGRESS_ETA - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains the optional ETA for a job.
- PROPERTY_JOB_PROGRESS_LOG - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains the optional output log of a job consumer.
- PROPERTY_JOB_PROGRESS_STEP - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains optional progress information about a job,
the number of completed steps.
- PROPERTY_JOB_PROGRESS_STEPS - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains optional progress information about a job,
the number of steps the job consumer will perform.
- PROPERTY_JOB_QUEUE_NAME - Static variable in interface org.apache.sling.event.jobs.Job
-
The name of the job queue processing this job.
- PROPERTY_JOB_RETRIES - Static variable in interface org.apache.sling.event.jobs.Job
-
The property to track the retry maximum retry count for jobs.
- PROPERTY_JOB_RETRY_COUNT - Static variable in interface org.apache.sling.event.jobs.Job
-
The property to track the retry count for jobs.
- PROPERTY_JOB_RETRY_DELAY - Static variable in interface org.apache.sling.event.jobs.Job
-
The property to set a retry delay.
- PROPERTY_JOB_STARTED_TIME - Static variable in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains a calendar object
specifying the date and time when this job has been started.
- PROPERTY_JOB_TARGET_INSTANCE - Static variable in interface org.apache.sling.event.jobs.Job
-
This property is set by the job handling and contains the Sling instance ID
of the instance where this job should be processed.
- PROPERTY_JOB_TITLE - Static variable in interface org.apache.sling.event.jobs.Job
-
This is an optional property containing a human readable title for
the job
- PROPERTY_RESULT_MESSAGE - Static variable in interface org.apache.sling.event.jobs.Job
-
This property contains the optional result message of a job consumer.
- PROPERTY_TOPICS - Static variable in interface org.apache.sling.event.jobs.consumer.JobConsumer
-
Service registration property defining the jobs this consumer is able to process.
- PROPERTY_TOPICS - Static variable in interface org.apache.sling.event.jobs.consumer.JobExecutor
-
Service registration property defining the jobs this executor is able to process.