Uses of Class
org.springframework.batch.core.JobParameters
Packages that use JobParameters
Package
Description
Core domain context for Spring Batch covering jobs, steps, configuration and execution
abstractions.
Support classes for implementations of the batch APIs.
Interfaces and related classes to support meta data browsing.
Specific implementations of explorer concerns.
Specific implementations of job concerns.
Interfaces and simple implementations of launch concerns.
Support classes for use in bootstrap and launch implementations or configurations.
Interfaces and generic implementations of repository concerns.
Specific implementations of dao concerns.
Specific implementations of repository concerns.
JobStep
and related components.Message based job launching components.
Utility classes for batch job/step testing.
-
Uses of JobParameters in org.springframework.batch.core
Methods in org.springframework.batch.core that return JobParametersModifier and TypeMethodDescriptionJobExecution.getJobParameters()
StepExecution.getJobParameters()
Convenience method to get the current job parameters.JobParametersIncrementer.getNext
(JobParameters parameters) Increments the provided parameters.JobParametersBuilder.toJobParameters()
Conversion method that takes the current state of this builder and returns it as aJobParameters
object.Methods in org.springframework.batch.core with parameters of type JobParametersModifier and TypeMethodDescriptionJobParametersBuilder.addJobParameters
(JobParameters jobParameters) Copy job parameters into the current state.DefaultJobKeyGenerator.generateKey
(JobParameters source) Generates the job key to be used based on theJobParameters
instance provided.JobParametersIncrementer.getNext
(JobParameters parameters) Increments the provided parameters.void
JobParametersValidator.validate
(JobParameters parameters) Check that the parameters meet whatever requirements are appropriate, and throw an exception if not.Constructors in org.springframework.batch.core with parameters of type JobParametersModifierConstructorDescriptionJobExecution
(Long id, JobParameters jobParameters) Constructor that accepts the job executionid
andJobParameters
.JobExecution
(JobInstance job, Long id, JobParameters jobParameters) Because a JobExecution is not valid unless the job is set, this constructor is the only valid one from a modeling point of view.JobExecution
(JobInstance job, JobParameters jobParameters) Constructor for transient (unsaved) instances.JobParametersBuilder
(JobParameters jobParameters) Copy constructor.JobParametersBuilder
(JobParameters jobParameters, JobExplorer jobExplorer) Copy constructor. -
Uses of JobParameters in org.springframework.batch.core.converter
Methods in org.springframework.batch.core.converter that return JobParametersModifier and TypeMethodDescriptionDefaultJobParametersConverter.getJobParameters
(Properties properties) JobParametersConverter.getJobParameters
(Properties properties) Get a newJobParameters
instance.Methods in org.springframework.batch.core.converter with parameters of type JobParametersModifier and TypeMethodDescriptionDefaultJobParametersConverter.getProperties
(JobParameters jobParameters) JobParametersConverter.getProperties
(JobParameters params) The inverse operation: get aProperties
instance. -
Uses of JobParameters in org.springframework.batch.core.explore
Methods in org.springframework.batch.core.explore with parameters of type JobParametersModifier and TypeMethodDescriptiondefault JobInstance
JobExplorer.getJobInstance
(String jobName, JobParameters jobParameters) -
Uses of JobParameters in org.springframework.batch.core.explore.support
Methods in org.springframework.batch.core.explore.support with parameters of type JobParametersModifier and TypeMethodDescriptionSimpleJobExplorer.getJobInstance
(String jobName, JobParameters jobParameters) -
Uses of JobParameters in org.springframework.batch.core.job
Methods in org.springframework.batch.core.job with parameters of type JobParametersModifier and TypeMethodDescriptionvoid
CompositeJobParametersValidator.validate
(JobParameters parameters) Validates the JobParameters according to the injected JobParameterValidators Validation stops and exception is thrown on first validation errorvoid
DefaultJobParametersValidator.validate
(JobParameters parameters) Check the parameters meet the specification provided. -
Uses of JobParameters in org.springframework.batch.core.launch
Methods in org.springframework.batch.core.launch with parameters of type JobParametersModifier and TypeMethodDescriptiondefault JobInstance
JobOperator.getJobInstance
(String jobName, JobParameters jobParameters) JobLauncher.run
(Job job, JobParameters jobParameters) Start a job execution for the givenJob
andJobParameters
. -
Uses of JobParameters in org.springframework.batch.core.launch.support
Methods in org.springframework.batch.core.launch.support that return JobParametersModifier and TypeMethodDescriptionDataFieldMaxValueJobParametersIncrementer.getNext
(JobParameters 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 JobParametersModifier and TypeMethodDescriptionSimpleJobOperator.getJobInstance
(String jobName, JobParameters jobParameters) DataFieldMaxValueJobParametersIncrementer.getNext
(JobParameters jobParameters) RunIdIncrementer.getNext
(JobParameters parameters) Increment the run.id parameter (starting with 1).TaskExecutorJobLauncher.run
(Job job, JobParameters jobParameters) Run the provided job with the givenJobParameters
. -
Uses of JobParameters in org.springframework.batch.core.repository
Methods in org.springframework.batch.core.repository with parameters of type JobParametersModifier and TypeMethodDescriptionJobRepository.createJobExecution
(String jobName, JobParameters jobParameters) JobRepository.createJobInstance
(String jobName, JobParameters jobParameters) Create a newJobInstance
with the name and job parameters provided.default JobInstance
JobRepository.getJobInstance
(String jobName, JobParameters jobParameters) 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 JobParametersModifier and TypeMethodDescriptionprotected JobParameters
JdbcJobExecutionDao.getJobParameters
(Long executionId) Methods in org.springframework.batch.core.repository.dao with parameters of type JobParametersModifier and TypeMethodDescriptionJdbcJobInstanceDao.createJobInstance
(String jobName, JobParameters jobParameters) In this JDBC implementation a job instance id is obtained by asking the jobInstanceIncrementer (which is likely a sequence) for the next long value, and then passing the Id and parameter values into an INSERT statement.JobInstanceDao.createJobInstance
(String jobName, JobParameters jobParameters) Create a JobInstance with given name and parameters.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.JobInstanceDao.getJobInstance
(String jobName, JobParameters jobParameters) Find the job instance that matches the given name and parameters. -
Uses of JobParameters in org.springframework.batch.core.repository.support
Methods in org.springframework.batch.core.repository.support with parameters of type JobParametersModifier and TypeMethodDescriptionSimpleJobRepository.createJobExecution
(String jobName, JobParameters jobParameters) SimpleJobRepository.createJobInstance
(String jobName, JobParameters jobParameters) SimpleJobRepository.getJobInstance
(String jobName, JobParameters jobParameters) 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 JobParametersModifier and TypeMethodDescriptionDefaultJobParametersExtractor.getJobParameters
(Job job, StepExecution stepExecution) JobParametersExtractor.getJobParameters
(Job job, StepExecution stepExecution) Extract job parameters from the step execution, for example from the execution context or other properties. -
Uses of JobParameters in org.springframework.batch.integration.launch
Methods in org.springframework.batch.integration.launch that return JobParametersConstructors in org.springframework.batch.integration.launch with parameters of type JobParameters -
Uses of JobParameters in org.springframework.batch.test
Methods in org.springframework.batch.test that return JobParametersMethods in org.springframework.batch.test with parameters of type JobParametersModifier and TypeMethodDescriptionstatic JobExecution
MetaDataInstanceFactory.createJobExecution
(String jobName, Long instanceId, Long executionId, JobParameters jobParameters) Create aJobExecution
with the parameters provided.static StepExecution
MetaDataInstanceFactory.createStepExecution
(JobParameters jobParameters) Create aStepExecution
and all its parent entities with default values, but using theJobParameters
provided.static StepExecution
MetaDataInstanceFactory.createStepExecution
(JobParameters jobParameters, ExecutionContext executionContext) Create aStepExecution
and all its parent entities with default values, but using theExecutionContext
andJobParameters
provided.JobLauncherTestUtils.launchJob
(JobParameters jobParameters) Launch the entire job, including all stepsJobLauncherTestUtils.launchStep
(String stepName, JobParameters jobParameters) Launch just the specified step in a surrounding single-step job of typeSimpleJob
namedStepRunner.JOB_NAME
.JobLauncherTestUtils.launchStep
(String stepName, JobParameters jobParameters, ExecutionContext jobExecutionContext) Launch just the specified step in a surrounding single-step job of typeSimpleJob
namedStepRunner.JOB_NAME
.StepRunner.launchStep
(Step step, JobParameters jobParameters) Launch just the specified step in a surrounding single-step job of typeSimpleJob
namedStepRunner.JOB_NAME
.StepRunner.launchStep
(Step step, JobParameters jobParameters, ExecutionContext jobExecutionContext) Launch just the specified step in a surrounding single-step job of typeSimpleJob
namedStepRunner.JOB_NAME
.