Spring Batch: get list of defined jobs at runtime

Question

Is it possible to get a list of defined jobs in Spring Batch at runtime without using db? Maybe it's possible to get this metadata from jobRepository bean or some similar object?

What do you mean by "defined jobs"? Jobs in the local application context? Jobs in the job repository? Some other definition? — Michael Minella, Sep 04 '15 at 15:24
I mean all jobs which I defined in my local application context — Vladyslav Sheruda, Sep 04 '15 at 15:25
You can do that with something as simple as `context.getBeanNamesForType(Job.class)`. — Michael Minella, Sep 04 '15 at 15:32
It will not work, as job is not a regular bean and you can find it in context or via getBean(jobName) — Vladyslav Sheruda, Sep 04 '15 at 15:35
Sure it is. A Job is no different than any other bean in your context. — Michael Minella, Sep 04 '15 at 15:56
Hm, you right, I thought that spring-batch job is something like resource.. And when use this context.getBeanNamesForType(Job.class) I'm always getting empty array. But the problem is that I used another context. My fault. Thanks for your reply. — Vladyslav Sheruda, Sep 04 '15 at 16:22

Tunaki · Accepted Answer · 2015-09-04T14:52:39.650

5

It is possible to retrieve the list of all job names using JobExplorer.getJobNames().

You first have to define the jobExplorer bean using JobExplorerFactoryBean:

<bean id="jobExplorer" class="org.springframework.batch.core.explore.support.JobExplorerFactoryBean">
    <property name="dataSource" ref="dataSource"/>
</bean>

and then you can inject this bean when you need it.

edited Sep 04 '15 at 14:52

answered Sep 04 '15 at 14:49

Tunaki

132,869
46
340
423

It works, but it use db. Is there way to find it without db? – Vladyslav Sheruda Sep 04 '15 at 15:26

score 2 · Answer 2 · answered Mar 07 '17 at 13:58

I use these code to list and execute jobs

private String jobName = "";
    private JobLauncher jobLauncher = null;
    private String selectedJob;
    private String statusJob = "Exit Status : ";
    private Job job;
    ApplicationContext context;
    private String[] lstJobs;

    /**
     * Execute
     */
    public ExecuteJobBean() {
        this.context = ApplicationContextProvider.getApplicationContext();
        this.lstJobs = context.getBeanNamesForType(Job.class);


        if (jobLauncher == null)
            jobLauncher = (JobLauncher) context.getBean("jobLauncher");
    }

    /**
     * Execute
     */
    public void executeJob() {

        setJob((Job) context.getBean(this.selectedJob));

        try {
            statusJob = "Exit Status : ";
            JobParameters jobParameters = new JobParametersBuilder().addLong("time", System.currentTimeMillis()).toJobParameters();
            JobExecution execution = jobLauncher.run(getJob(), jobParameters);
            this.statusJob = execution.getStatus() + ", ";
        } catch (Exception e) {
            e.printStackTrace();
            this.statusJob = "Error, " + e.getMessage();
        }
        this.statusJob += " Done!!";
    }

score 2 · Answer 3 · answered Sep 13 '18 at 06:35

2

To list jobs defined as beans, you can just let the spring context inject them for you all the bean types of type Job into a list as below:

@Autowired
private List<? extends Job> jobs;

..
//You can then launch you job given a name.

answered Sep 13 '18 at 06:35

kosgeinsky

508
3
21

Works for me, the @Autowired ListableJobLocator jobLocator; jobLocator.getJobNames(); suggestion from another answer did not return any job in my case. – nn4l Mar 03 '20 at 11:13

score 1 · Answer 4 · answered Oct 26 '16 at 17:40

1

Alternative strategy to get list of job names that are configured as beans one can use the ListableJobLocator.

@Autowired
ListableJobLocator jobLocator;

....

jobLocator.getJobNames();

This does not require a job repository.

answered Oct 26 '16 at 17:40

anojan

43
1
5

Spring Batch: get list of defined jobs at runtime

4 Answers4