View Javadoc

1   /*
2    * Copyright 2006-2010 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.step.job;
17  
18  import org.springframework.batch.core.Job;
19  import org.springframework.batch.core.JobParameters;
20  import org.springframework.batch.core.StepExecution;
21  
22  /**
23   * Strategy interface for translating a {@link StepExecution} into
24   * {@link JobParameters}.
25   * 
26   * @author Dave Syer
27   * 
28   */
29  public interface JobParametersExtractor {
30  
31  	/**
32  	 * Extract job parameters from the step execution, for example from the
33  	 * execution context or other properties.
34  	 *
35  	 * @param job a {@link Job}
36  	 * @param stepExecution a {@link StepExecution}
37  	 *
38  	 * @return some {@link JobParameters}
39  	 */
40  	JobParameters getJobParameters(Job job, StepExecution stepExecution);
41  
42  }