Uses of Class
org.springframework.batch.core.JobParameters

Packages that use JobParameters

Package	Description
org.springframework.batch.core	Core domain context for Spring Batch covering jobs, steps, configuration and execution abstractions.
org.springframework.batch.core.converter	Support classes for implementations of the batch APIs.
org.springframework.batch.core.job	Specific implementations of job concerns.
org.springframework.batch.core.launch	Interfaces and simple implementations of launch concerns.
org.springframework.batch.core.launch.support	Support classes for use in bootstrap and launch implementations or configurations.
org.springframework.batch.core.repository	Interfaces and generic implementations of repository concerns.
org.springframework.batch.core.repository.dao	Specific implementations of dao concerns.
org.springframework.batch.core.repository.support	Specific implementations of repository concerns.
org.springframework.batch.core.step.job
org.springframework.batch.test

Uses of JobParameters in org.springframework.batch.core

Methods in org.springframework.batch.core that return JobParameters

Modifier and Type	Method and Description
JobParameters	StepExecution.getJobParameters() Convenience method to get the current job parameters.
JobParameters	JobExecution.getJobParameters()
JobParameters	JobParametersIncrementer.getNext(JobParameters parameters) Increment the provided parameters.
JobParameters	JobParametersBuilder.toJobParameters() Conversion method that takes the current state of this builder and returns it as a JobruntimeParameters object.

Methods in org.springframework.batch.core with parameters of type JobParameters

Modifier and Type	Method and Description
String	DefaultJobKeyGenerator.generateKey(JobParameters source) Generates the job key to be used based on the JobParameters instance provided.
JobParameters	JobParametersIncrementer.getNext(JobParameters parameters) Increment the provided parameters.
void	JobParametersValidator.validate(JobParameters parameters) Check the parameters meet whatever requirements are appropriate, and throw an exception if not.

Constructors in org.springframework.batch.core with parameters of type JobParameters

Constructor and Description
JobExecution(JobInstance job, JobParameters jobParameters) Constructor for transient (unsaved) instances.
JobExecution(JobInstance job, Long id, JobParameters jobParameters) Because a JobExecution isn't valid unless the job is set, this constructor is the only valid one from a modeling point of view.
JobExecution(Long id, JobParameters jobParameters)
JobParametersBuilder(JobParameters jobParameters) Copy constructor.

Uses of JobParameters in org.springframework.batch.core.converter

Methods in org.springframework.batch.core.converter that return JobParameters

Modifier and Type	Method and Description
JobParameters	JobParametersConverter.getJobParameters(Properties properties) Get a new JobParameters instance.
JobParameters	DefaultJobParametersConverter.getJobParameters(Properties props) Check for suffix on keys and use those to decide how to convert the value.

Methods in org.springframework.batch.core.converter with parameters of type JobParameters

Modifier and Type	Method and Description
Properties	JobParametersConverter.getProperties(JobParameters params) The inverse operation: get a Properties instance.
Properties	DefaultJobParametersConverter.getProperties(JobParameters params) Use the same suffixes to create properties (omitting the string suffix because it is the default).

Uses of JobParameters in org.springframework.batch.core.job

Methods in org.springframework.batch.core.job with parameters of type JobParameters

Modifier and Type	Method and Description
void	DefaultJobParametersValidator.validate(JobParameters parameters) Check the parameters meet the specification provided.
void	CompositeJobParametersValidator.validate(JobParameters parameters) Validates the JobParameters according to the injected JobParameterValidators Validation stops and exception is thrown on first validation error

Uses of JobParameters in org.springframework.batch.core.launch

Methods in org.springframework.batch.core.launch with parameters of type JobParameters

Modifier and Type	Method and Description
JobExecution	JobLauncher.run(Job job, JobParameters jobParameters) Start a job execution for the given Job and JobParameters .

Uses of JobParameters in org.springframework.batch.core.launch.support

Methods in org.springframework.batch.core.launch.support that return JobParameters

Modifier and Type	Method and Description
JobParameters	ScheduledJobParametersFactory.getJobParameters(Properties props)
JobParameters	RunIdIncrementer.getNext(JobParameters parameters) Increment the run.id parameter (starting with 1).

Methods in org.springframework.batch.core.launch.support with parameters of type JobParameters

Modifier and Type	Method and Description
JobParameters	RunIdIncrementer.getNext(JobParameters parameters) Increment the run.id parameter (starting with 1).
Properties	ScheduledJobParametersFactory.getProperties(JobParameters params) Convert schedule date to Date, and assume all other parameters can be represented by their default string value.
JobExecution	SimpleJobLauncher.run(Job job, JobParameters jobParameters) Run the provided job with the given JobParameters.

Uses of JobParameters in org.springframework.batch.core.repository

Methods in org.springframework.batch.core.repository with parameters of type JobParameters

Modifier and Type	Method and Description
JobExecution	JobRepository.createJobExecution(String jobName, JobParameters jobParameters) Create a JobExecution for a given Job and JobParameters.
JobExecution	JobRepository.getLastJobExecution(String jobName, JobParameters jobParameters)
boolean	JobRepository.isJobInstanceExists(String jobName, JobParameters jobParameters) Check if an instance of this job already exists with the parameters provided.

Uses of JobParameters in org.springframework.batch.core.repository.dao

Methods in org.springframework.batch.core.repository.dao that return JobParameters

Modifier and Type	Method and Description
protected JobParameters	JdbcJobExecutionDao.getJobParameters(Long executionId)

Methods in org.springframework.batch.core.repository.dao with parameters of type JobParameters

Modifier and Type	Method and Description
JobInstance	MapJobInstanceDao.createJobInstance(String jobName, JobParameters jobParameters)
JobInstance	JobInstanceDao.createJobInstance(String jobName, JobParameters jobParameters) Create a JobInstance with given name and parameters.
JobInstance	JdbcJobInstanceDao.createJobInstance(String jobName, JobParameters jobParameters) In this jdbc implementation a job id is obtained by asking the jobIncrementer (which is likely a sequence) for the next long value, and then passing the Id and parameter values into an INSERT statement.
JobInstance	MapJobInstanceDao.getJobInstance(String jobName, JobParameters jobParameters)
JobInstance	JobInstanceDao.getJobInstance(String jobName, JobParameters jobParameters) Find the job instance that matches the given name and parameters.
JobInstance	JdbcJobInstanceDao.getJobInstance(String jobName, JobParameters jobParameters) The job table is queried for any jobs that match the given identifier, adding them to a list via the RowMapper callback.

Uses of JobParameters in org.springframework.batch.core.repository.support

Methods in org.springframework.batch.core.repository.support with parameters of type JobParameters

Modifier and Type	Method and Description
JobExecution	SimpleJobRepository.createJobExecution(String jobName, JobParameters jobParameters)
JobExecution	SimpleJobRepository.getLastJobExecution(String jobName, JobParameters jobParameters)
boolean	SimpleJobRepository.isJobInstanceExists(String jobName, JobParameters jobParameters)

Uses of JobParameters in org.springframework.batch.core.step.job

Methods in org.springframework.batch.core.step.job that return JobParameters

Modifier and Type	Method and Description
JobParameters	JobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution) Extract job parameters from the step execution, for example from the execution context or other properties.
JobParameters	DefaultJobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution)

Uses of JobParameters in org.springframework.batch.test

Methods in org.springframework.batch.test that return JobParameters

Modifier and Type	Method and Description
JobParameters	JobLauncherTestUtils.getUniqueJobParameters()
protected JobParameters	AbstractJobTests.getUniqueJobParameters() Deprecated.

Methods in org.springframework.batch.test with parameters of type JobParameters

Modifier and Type	Method and Description
static JobExecution	MetaDataInstanceFactory.createJobExecution(String jobName, Long instanceId, Long executionId, JobParameters jobParameters) Create a JobExecution with the parameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(JobParameters jobParameters) Create a StepExecution and all its parent entities with default values, but using the JobParameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(JobParameters jobParameters, ExecutionContext executionContext) Create a StepExecution and all its parent entities with default values, but using the ExecutionContext and JobParameters provided.
JobExecution	JobLauncherTestUtils.launchJob(JobParameters jobParameters) Launch the entire job, including all steps
protected JobExecution	AbstractJobTests.launchJob(JobParameters jobParameters) Deprecated. Launch the entire job, including all steps
JobExecution	StepRunner.launchStep(Step step, JobParameters jobParameters) Launch just the specified step as its own job.
JobExecution	StepRunner.launchStep(Step step, JobParameters jobParameters, ExecutionContext jobExecutionContext) Launch just the specified step as its own job.
JobExecution	JobLauncherTestUtils.launchStep(String stepName, JobParameters jobParameters) Launch just the specified step in the job.
JobExecution	AbstractJobTests.launchStep(String stepName, JobParameters jobParameters) Deprecated. Launch just the specified step in the job.
JobExecution	JobLauncherTestUtils.launchStep(String stepName, JobParameters jobParameters, ExecutionContext jobExecutionContext) Launch just the specified step in the job.
JobExecution	AbstractJobTests.launchStep(String stepName, JobParameters jobParameters, ExecutionContext jobExecutionContext) Deprecated. Launch just the specified step in the job.