org.springframework.batch.core.job.SimpleJob.java Source code

Introduction

Here is the source code for org.springframework.batch.core.job.SimpleJob.java

Source

/*
 * Copyright 2006-2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.batch.core.job;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobInterruptedException;
import org.springframework.batch.core.StartLimitExceededException;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.repository.JobRestartException;
import org.springframework.batch.core.step.StepLocator;

/**
 * Simple implementation of {@link Job} interface providing the ability to run a
 * {@link JobExecution}. Sequentially executes a job by iterating through its
 * list of steps.  Any {@link Step} that fails will fail the job.  The job is
 * considered complete when all steps have been executed.
 *
 * @author Lucas Ward
 * @author Dave Syer
 * @author Michael Minella
 */
public class SimpleJob extends AbstractJob {

    private List<Step> steps = new ArrayList<>();

    /**
     * Default constructor for job with null name
     */
    public SimpleJob() {
        this(null);
    }

    /**
     * @param name the job name.
     */
    public SimpleJob(String name) {
        super(name);
    }

    /**
     * Public setter for the steps in this job. Overrides any calls to
     * {@link #addStep(Step)}.
     *
     * @param steps the steps to execute
     */
    public void setSteps(List<Step> steps) {
        this.steps.clear();
        this.steps.addAll(steps);
    }

    /**
     * Convenience method for clients to inspect the steps for this job.
     *
     * @return the step names for this job
     */
    @Override
    public Collection<String> getStepNames() {
        List<String> names = new ArrayList<>();
        for (Step step : steps) {
            names.add(step.getName());

            if (step instanceof StepLocator) {
                names.addAll(((StepLocator) step).getStepNames());
            }
        }
        return names;
    }

    /**
     * Convenience method for adding a single step to the job.
     *
     * @param step a {@link Step} to add
     */
    public void addStep(Step step) {
        this.steps.add(step);
    }

    /*
     * (non-Javadoc)
     *
     * @see
     * org.springframework.batch.core.job.AbstractJob#getStep(java.lang.String)
     */
    @Override
    public Step getStep(String stepName) {
        for (Step step : this.steps) {
            if (step.getName().equals(stepName)) {
                return step;
            } else if (step instanceof StepLocator) {
                Step result = ((StepLocator) step).getStep(stepName);
                if (result != null) {
                    return result;
                }
            }
        }
        return null;
    }

    /**
     * Handler of steps sequentially as provided, checking each one for success
     * before moving to the next. Returns the last {@link StepExecution}
     * successfully processed if it exists, and null if none were processed.
     *
     * @param execution the current {@link JobExecution}
     *
     * @see AbstractJob#handleStep(Step, JobExecution)
     */
    @Override
    protected void doExecute(JobExecution execution)
            throws JobInterruptedException, JobRestartException, StartLimitExceededException {

        StepExecution stepExecution = null;
        for (Step step : steps) {
            stepExecution = handleStep(step, execution);
            if (stepExecution.getStatus() != BatchStatus.COMPLETED) {
                //
                // Terminate the job if a step fails
                //
                break;
            }
        }

        //
        // Update the job status to be the same as the last step
        //
        if (stepExecution != null) {
            if (logger.isDebugEnabled()) {
                logger.debug("Upgrading JobExecution status: " + stepExecution);
            }
            execution.upgradeStatus(stepExecution.getStatus());
            execution.setExitStatus(stepExecution.getExitStatus());
        }
    }

}