Package ca.uhn.fhir.batch2.api

package ca.uhn.fhir.batch2.api

This package contains the APIs used in the Batch2 framework.

IJobCoordinator is the external facing API for the framework, used to start and stop jobs and inquire about status.
IJobMaintenanceService is a background processor that updates statistics and clean up stale data
IJobStepWorker is the interface that a job implementation would implement for its step workers. The first and last step would respectively use a sub-interface of IJobStepWorker: IFirstJobStepWorker is the first step and ILastJobStepWorker is the last
IJobDataSink is a callback API provided to step workers that they can supply data to for processing in subsequent steps.
IJobPersistence is an internal API providing storage for jobs.

Since:

6.0.0

Related Packages

Package	Description
ca.uhn.fhir.batch2	Our distributed batch processing library.

Class	Description
ChunkExecutionDetails<PT extends ca.uhn.fhir.model.api.IModelJson,IT extends ca.uhn.fhir.model.api.IModelJson>
IFirstJobStepWorker<PT extends ca.uhn.fhir.model.api.IModelJson,OT extends ca.uhn.fhir.model.api.IModelJson>
IJobCompletionHandler<PT extends ca.uhn.fhir.model.api.IModelJson>
IJobCoordinator
IJobDataSink<OT extends ca.uhn.fhir.model.api.IModelJson>
IJobInstance
IJobMaintenanceService
IJobParametersValidator<T extends ca.uhn.fhir.model.api.IModelJson>	This interface can be used to validate the parameters object supplied to start a job instance.
IJobPartitionProvider	Provides the list of PartitionedUrl that a job should run against.
IJobPersistence	Some of this is tested in ca.uhn.hapi.fhir.batch2.test.AbstractIJobPersistenceSpecificationTest This is a transactional interface, but we have pushed the declaration of calls that have @Transactional(propagation = Propagation.REQUIRES_NEW) down to the implementations since we have a synchronized wrapper that was double-creating the NEW transaction.
IJobPersistence.CreateResult
IJobPersistence.JobInstanceUpdateCallback	Callback to update a JobInstance within a locked transaction.
IJobStepWorker<PT extends ca.uhn.fhir.model.api.IModelJson,IT extends ca.uhn.fhir.model.api.IModelJson,OT extends ca.uhn.fhir.model.api.IModelJson>	This interface is implemented by step workers within the Batch2 framework.
ILastJobStepWorker<PT extends ca.uhn.fhir.model.api.IModelJson,IT extends ca.uhn.fhir.model.api.IModelJson>
IReductionStepExecutorService
IReductionStepWorker<PT extends ca.uhn.fhir.model.api.IModelJson,IT extends ca.uhn.fhir.model.api.IModelJson,OT extends ca.uhn.fhir.model.api.IModelJson>	Reduction step worker.
IWarningProcessor
IWorkChunkPersistence	Work Chunk api, implementing the WorkChunk state machine.
JobCompletionDetails<PT extends ca.uhn.fhir.model.api.IModelJson>
JobExecutionFailedException	This exception indicates an unrecoverable processing failure.
JobOperationResultJson
JobStepFailedException	When a step throws an Exception that is not a JobExecutionFailedException, the Smile Batch 2 framework will rethrow the exception as a JobStepFailedException.
RetryChunkLaterException	Exception that is thrown when a polling step needs to be retried at a later time.
RunOutcome	Return type for IJobStepWorker.run(StepExecutionDetails, IJobDataSink)
StepExecutionDetails<PT extends ca.uhn.fhir.model.api.IModelJson,IT extends ca.uhn.fhir.model.api.IModelJson>
VoidModel	Used as the input type for the first step