Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent documentation about aborting a job [BATCH-2654] #949

Closed
spring-issuemaster opened this issue Nov 22, 2017 · 1 comment
Closed

Inconsistent documentation about aborting a job [BATCH-2654] #949

spring-issuemaster opened this issue Nov 22, 2017 · 1 comment

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Nov 22, 2017

caio amaral opened BATCH-2654 and commented

The Javadoc from JobOperator#abandon(long) states that an ABANDONED job execution can be restarted.

* An abandoned job execution can be
* restarted, but a stopping one cannot.

https://github.com/spring-projects/spring-batch/blob/4.0.0.RC1/spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java

The HTML documentation says that the job cannot be restarted.

4.6.6 Aborting a Job
...
 A job execution whose status is ABANDONED will not be restarted by the framework.

https://docs.spring.io/spring-batch/4.0.x/reference/html/job.html#aborting-a-job

The actual behavior is that the ABANDONED job cannot be restarted, and STOPPING job can be restart.(It seems an strange decision to me, but it is not the point of this ticket)
So the HTML documentation is correct and the Javadoc needs to be fixed.

Also, there is a small error on the HTML, as it refers to JobService instead of JobOperator.

There is a utility in Spring Batch Admin JobService to abort a job execution.

Affects: 3.0.8, 4.0.0.RC1

Referenced from: commits 8a223e3, 5d883a3

Backported to: 3.0.9

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Nov 22, 2017

Michael Minella commented

Good catch. This has been updated. Also, the JobService is a component in Spring Batch Admin so that piece is accurate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.