001/*
002 * Copyright 2006-2010 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core.step.job;
017
018import org.springframework.batch.core.Job;
019import org.springframework.batch.core.JobParameters;
020import org.springframework.batch.core.StepExecution;
021
022/**
023 * Strategy interface for translating a {@link StepExecution} into
024 * {@link JobParameters}.
025 * 
026 * @author Dave Syer
027 * 
028 */
029public interface JobParametersExtractor {
030
031        /**
032         * Extract job parameters from the step execution, for example from the
033         * execution context or other properties.
034         *
035         * @param job a {@link Job}
036         * @param stepExecution a {@link StepExecution}
037         *
038         * @return some {@link JobParameters}
039         */
040        JobParameters getJobParameters(Job job, StepExecution stepExecution);
041
042}