Summer.Batch.Core Namespace Reference

Namespaces

Classes

class  BatchStatus
 Statuses of a batch execution. More...
 
class  DefaultJobKeyGenerator
 Default implementation of the IJobKeyGenerator<JobParameters> interface. More...
 
class  Entity
 Batch Domain Entity class. Any class that should be uniquely identifiable from another should subclass from Entity. More information on this pattern and the difference between Entities and Value Objects can be found in Domain Driven Design by Eric Evans. More...
 
class  ExitStatus
 Value object used to carry information about the status of a job or step execution. ExitStatus is immutable and therefore thread-safe. More...
 
interface  IJob
 A Job's contract. More...
 
interface  IJobExecutionListener
 Provide callbacks at specific points in the lifecycle of an IJob. Implementations can be stateful if they are careful to either ensure thread safety, or to use one instance of a listener per job, assuming that job instances themselves are not used by more than one thread. More...
 
interface  IJobKeyGenerator
 Strategy interface for the generation of the key used in identifying unique JobInstance . More...
 
interface  IJobParametersIncrementer
 Interface for obtaining the next JobParameters in a sequence. More...
 
interface  IJobParametersValidator
 Strategy interface for an IJobto use in validating its parameters for an execution. More...
 
interface  IStep
 Batch domain interface representing the configuration of a step. As with the Job, an IStep is meant to explicitly represent the configuration of a step by a developer, but also the ability to execute the step. More...
 
interface  IStepExecutionListener
 Listener interface for the lifecycle of an IStep. More...
 
interface  IStepListener
 Marker interface that acts as a parent to all step domain listeners, such as IStepExecutionListener. More...
 
class  JobExecution
 Batch domain object representing the execution of a job. More...
 
class  JobExecutionException
 Root of exception hierarchy for checked exceptions in job and step execution. Clients of the Job should expect to have to catch and deal with these exceptions because they signal a user error, or an inconsistent state between the user's instructions and the data. More...
 
class  JobInstance
 Batch domain object representing a uniquely identifiable job run. JobInstance can be restarted multiple times in case of execution failure and it's lifecycle ends with first successful execution. More...
 
class  JobInterruptedException
 Exception to indicate the the job has been interrupted. The exception state indicated is not normally recoverable by batch application clients, but internally it is useful to force a check. The exception will often be wrapped in a runtime exception (usually UnexpectedJobExecutionException before reaching the client. More...
 
class  JobParameter
 Domain representation of a parameter to a batch job. Only the following types can be parameters: String, Long, Date, and Double. The identifying flag is used to indicate if the parameter is to be used as part of the identification of a job instance. as org.springframework.batch.core.JobParameter More...
 
class  JobParameters
 Value object representing runtime parameters to a batch job. Because the parameters have no individual meaning outside of the JobParameters they are contained within, it is a value object rather than an entity. It is also extremely important that a parameters object can be reliably compared to another for equality, in order to determine if one JobParameters object equals another. Furthermore, because these parameters will need to be persisted, it is vital that the types added are restricted. This class is immutable and therefore thread-safe. More...
 
class  JobParametersBuilder
 Helper class for creating JobParameters. Useful because all JobParameter objects are immutable, and must be instantiated separately to ensure typesafety. Once created, it can be used in the same was a StringBuilder (except, order is irrelevant), by adding various parameter types and creating a valid JobParameters once finished. Using the identifying flag indicates if the parameter will be used in the identification of a JobInstance. That flag defaults to true. More...
 
class  JobParametersInvalidException
 Exception for Job to signal that some JobParameters are invalid. More...
 
class  JobStarter
 Job starter. Used to start or re-start jobs More...
 
class  StartLimitExceededException
 Indicates the step's start limit has been exceeded. More...
 
class  StepConstants
 IStep constants. More...
 
class  StepContribution
 Represents a contribution to a StepExecution, buffering changes until they can be applied at a chunk boundary. More...
 
class  StepExecution
 Batch domain object representation the execution of a step. Unlike JobExecution, there are additional properties related the processing of items such as commit count, etc. More...
 
class  StepListenerConstant
 Constant holder for IStepListener interface. More...
 
class  UnexpectedJobExecutionException
 Indicates to the framework that a critical error has occurred and processing should immediately stop. More...