SimpleJobService (Spring Batch Admin 1.2.1.RELEASE API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.batch.admin.service
Class SimpleJobService

java.lang.Object
  org.springframework.batch.admin.service.SimpleJobService

All Implemented Interfaces:: JobService, DisposableBean

public class SimpleJobService
extends Object
implements JobService, DisposableBean
extends Object
implements JobService, DisposableBean

Implementation of JobService that delegates most of its work to other off-the-shelf components.

Author:: Dave Syer

Constructor Summary
`SimpleJobService(SearchableJobInstanceDao jobInstanceDao, SearchableJobExecutionDao jobExecutionDao, SearchableStepExecutionDao stepExecutionDao, JobRepository jobRepository, JobLauncher jobLauncher, ListableJobLocator jobLocator, ExecutionContextDao executionContextDao)`

Method Summary
`JobExecution`	`abandon(Long jobExecutionId)` Mark the `JobExecution` as ABANDONED.
`int`	`countJobExecutions()` Count the maximum number of executions that could be returned by `JobService.listJobExecutions(int, int)`.
`int`	`countJobExecutionsForJob(String name)` Count the job executions in the repository for a job.
`int`	`countJobInstances(String name)` Count the number of `job instances` in the repository for a given job name.
`int`	`countJobs()` Count the total number of jobs that can be returned by `JobService.listJobs(int, int)`.
`int`	`countStepExecutionsForStep(String jobName, String stepName)` Count the step executions in the repository for a given step name (or pattern).
`void`	`destroy()` Stop all the active jobs and wait for them (up to a time out) to finish processing.
`JobExecution`	`getJobExecution(Long jobExecutionId)` Get a `JobExecution` by id.
`Collection<JobExecution>`	`getJobExecutionsForJobInstance(String name, Long jobInstanceId)` Get all the job executions for a given job instance.
`JobInstance`	`getJobInstance(long jobInstanceId)` Get a `job instance` by id.
`JobParameters`	`getLastJobParameters(String jobName)` Get the last `JobParameters` used to execute a job successfully.
`StepExecution`	`getStepExecution(Long jobExecutionId, Long stepExecutionId)` Locate a `StepExecution` from its id and that of its parent `JobExecution`.
`Collection<StepExecution>`	`getStepExecutions(Long jobExecutionId)` Get the `step executions` for a given job execution (by id).
`Collection<String>`	`getStepNamesForJob(String jobName)` Get the names of the steps in a job (or a historical list of recent execution names if the Job is not launchable).
`boolean`	`isIncrementable(String jobName)` Check if a job has a `JobParametersIncrementer`.
`boolean`	`isLaunchable(String jobName)` Convenience method to determine if a job is available for launching.
`JobExecution`	`launch(String jobName, JobParameters jobParameters)` Launch a job with the parameters provided.
`Collection<JobExecution>`	`listJobExecutions(int start, int count)` List the `job executions` in descending order of creation (usually close to execution order).
`Collection<JobExecution>`	`listJobExecutionsForJob(String jobName, int start, int count)` List the `job executions` for a job in descending order of creation (usually close to execution order).
`Collection<JobInstance>`	`listJobInstances(String jobName, int start, int count)` List the `job instances` in descending order of creation (usually close to order of execution).
`Collection<String>`	`listJobs(int start, int count)` Query the job names in the system, either launchable or not.
`Collection<StepExecution>`	`listStepExecutionsForStep(String jobName, String stepName, int start, int count)` List the `step executions` for a step in descending order of creation (usually close to execution order).
`void`	`removeInactiveExecutions()` Check all the active executions and see if they are still actually running.
`JobExecution`	`restart(Long jobExecutionId)` Launch a job with the parameters provided.
`void`	`setShutdownTimeout(int shutdownTimeout)` Timeout for shutdown waiting for jobs to finish processing.
`JobExecution`	`stop(Long jobExecutionId)` Send a signal to a job execution to stop processing.
`int`	`stopAll()` Send a stop signal to all running job executions.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SimpleJobService

public SimpleJobService(SearchableJobInstanceDao jobInstanceDao,
                        SearchableJobExecutionDao jobExecutionDao,
                        SearchableStepExecutionDao stepExecutionDao,
                        JobRepository jobRepository,
                        JobLauncher jobLauncher,
                        ListableJobLocator jobLocator,
                        ExecutionContextDao executionContextDao)

Method Detail

setShutdownTimeout

public void setShutdownTimeout(int shutdownTimeout)

Timeout for shutdown waiting for jobs to finish processing.

Parameters:: shutdownTimeout - in milliseconds (default 60 secs)