spring-batch StepExecutionListener 源码

  • 2022-08-16
  • 浏览 (382)

spring-batch StepExecutionListener 代码

文件路径:/spring-batch-core/src/main/java/org/springframework/batch/core/StepExecutionListener.java

/*
 * Copyright 2006-2022 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;

import org.springframework.lang.Nullable;

/**
 * Listener interface for the lifecycle of a {@link Step}.
 *
 * @author Lucas Ward
 * @author Dave Syer
 * @author Mahmoud Ben Hassine
 * @author Parikshit Dutta
 */
public interface StepExecutionListener extends StepListener {

	/**
	 * Initialize the state of the listener with the {@link StepExecution} from the
	 * current scope.
	 * @param stepExecution instance of {@link StepExecution}.
	 */
	default void beforeStep(StepExecution stepExecution) {
	}

	/**
	 * Give a listener a chance to modify the exit status from a step. The value returned
	 * is combined with the normal exit status by using
	 * {@link ExitStatus#and(ExitStatus)}.
	 *
	 * Called after execution of the step's processing logic (whether successful or
	 * failed). Throwing an exception in this method has no effect, as it is only logged.
	 * @param stepExecution a {@link StepExecution} instance.
	 * @return an {@link ExitStatus} to combine with the normal value. Return {@code null}
	 * (the default) to leave the old value unchanged.
	 */
	@Nullable
	default ExitStatus afterStep(StepExecution stepExecution) {
		return null;
	}

}

相关信息

spring-batch 源码目录

相关文章

spring-batch BatchStatus 源码

spring-batch ChunkListener 源码

spring-batch DefaultJobKeyGenerator 源码

spring-batch Entity 源码

spring-batch ExitStatus 源码

spring-batch ItemProcessListener 源码

spring-batch ItemReadListener 源码

spring-batch ItemWriteListener 源码

spring-batch Job 源码

spring-batch JobExecution 源码

0  赞