View Javadoc

1   /*
2    * Copyright 2006-2013 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.batch.core;
17  
18  
19  /**
20   * Listener interface for the lifecycle of a {@link Step}.
21   *
22   * @author Lucas Ward
23   * @author Dave Syer
24   *
25   */
26  public interface StepExecutionListener extends StepListener {
27  
28  	/**
29  	 * Initialize the state of the listener with the {@link StepExecution} from
30  	 * the current scope.
31  	 *
32  	 * @param stepExecution
33  	 */
34  	void beforeStep(StepExecution stepExecution);
35  
36  	/**
37  	 * Give a listener a chance to modify the exit status from a step. The value
38  	 * returned will be combined with the normal exit status using
39  	 * {@link ExitStatus#and(ExitStatus)}.
40  	 *
41  	 * Called after execution of step's processing logic (both successful or
42  	 * failed). Throwing exception in this method has no effect, it will only be
43  	 * logged.
44  	 *
45  	 * @return an {@link ExitStatus} to combine with the normal value. Return
46  	 * null to leave the old value unchanged.
47  	 */
48  	ExitStatus afterStep(StepExecution stepExecution);
49  }