Class GroupAwareJob
- java.lang.Object
- org.springframework.batch.core.configuration.support.GroupAwareJob
- All Implemented Interfaces:
Job
public class GroupAwareJob extends java.lang.Object implements Job
AJob
that can optionally prepend a group name to another job's name, to make it fit a naming convention for type or origin. E.g. the source job might beovernightJob
and the groupfinanceDepartment
, which would result in aJob
with identical functionality but namedfinanceDepartment.overnightJob
. The use of a "." separator for elements is deliberate, since it is a "safe" character in a URL.- Author:
- Dave Syer, Mahmoud Ben Hassine
Constructor Summary
Constructors Constructor Description GroupAwareJob(java.lang.String groupName, Job delegate)
Create a newJob
with the given group name and delegate.GroupAwareJob(Job delegate)
Create a newJob
with the delegate and no group name.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
void
execute(JobExecution execution)
Run theJobExecution
and update the meta information like status and statistics as necessary.JobParametersIncrementer
getJobParametersIncrementer()
If clients need to generate new parameters for the next execution in a sequence they can use this incrementer.JobParametersValidator
getJobParametersValidator()
A validator for the job parameters of aJobExecution
.java.lang.String
getName()
Concatenates the group name and the delegate job name (joining with a ".").int
hashCode()
boolean
isRestartable()
Flag to indicate if this job can be restarted, at least in principle.java.lang.String
toString()
Method Detail
execute
public void execute(JobExecution execution)
Description copied from interface:Job
Run theJobExecution
and update the meta information like status and statistics as necessary. This method should not throw any exceptions for failed execution. Clients should be careful to inspect theJobExecution
status to determine success or failure.- Specified by:
execute
in interfaceJob
- Parameters:
execution
- aJobExecution
getName
public java.lang.String getName()
Concatenates the group name and the delegate job name (joining with a ".").- Specified by:
getName
in interfaceJob
- See Also:
Job.getName()
isRestartable
public boolean isRestartable()
Description copied from interface:Job
Flag to indicate if this job can be restarted, at least in principle.- Specified by:
isRestartable
in interfaceJob
- Returns:
- true if this job can be restarted after a failure
getJobParametersIncrementer
@Nullable public JobParametersIncrementer getJobParametersIncrementer()
Description copied from interface:Job
If clients need to generate new parameters for the next execution in a sequence they can use this incrementer. The return value may benull
, in the case that this job does not have a natural sequence.- Specified by:
getJobParametersIncrementer
in interfaceJob
- Returns:
- in incrementer to be used for creating new parameters
getJobParametersValidator
public JobParametersValidator getJobParametersValidator()
Description copied from interface:Job
A validator for the job parameters of aJobExecution
. Clients of a Job may need to validate the parameters for a launch, before or during the execution.- Specified by:
getJobParametersValidator
in interfaceJob
- Returns:
- a validator that can be used to check parameter values (never
null
)
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object