org.springframework.batch.core.job.flow.FlowExecutor Maven / Gradle / Ivy
/*
* Copyright 2006-2007 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
*
* http://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.flow;
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;
/**
* Context and execution strategy for {@link FlowJob} to allow it to delegate
* its execution step by step.
*
* @author Dave Syer
* @since 2.0
*/
public interface FlowExecutor {
/**
* @param step a {@link Step} to execute
* @return the exit status that drives the surrounding {@link Flow}
* @throws StartLimitExceededException
* @throws JobRestartException
* @throws JobInterruptedException
*/
String executeStep(Step step) throws JobInterruptedException, JobRestartException, StartLimitExceededException;
/**
* @return the current {@link JobExecution}
*/
JobExecution getJobExecution();
/**
* @return the latest {@link StepExecution} or null if there is none
*/
StepExecution getStepExecution();
/**
* Chance to clean up resources at the end of a flow (whether it completed
* successfully or not).
*
* @param result the final {@link FlowExecution}
*/
void close(FlowExecution result);
/**
* Handle any status changes that might be needed at the start of a state.
*/
void abandonStepExecution();
/**
* Handle any status changes that might be needed in the
* {@link JobExecution}.
*/
void updateJobExecutionStatus(FlowExecutionStatus status);
/**
* @return true if the flow is at the beginning of a restart
*/
boolean isRestart();
/**
* @param code the label for the exit status when a flow or sub-flow ends
*/
void addExitStatus(String code);
}