Package org.apache.batchee.spi
Interface PersistenceManagerService
-
- All Superinterfaces:
BatchService
- All Known Implementing Classes:
JDBCPersistenceManagerService,JPAPersistenceManagerService,MemoryPersistenceManagerService
public interface PersistenceManagerService extends BatchService
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classPersistenceManagerService.TimestampType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcleanUp(long instanceId)voidcleanUp(Date until)RuntimeFlowInSplitExecutioncreateFlowInSplitExecution(javax.batch.runtime.JobInstance jobInstance, javax.batch.runtime.BatchStatus batchStatus)RuntimeJobExecutioncreateJobExecution(javax.batch.runtime.JobInstance jobInstance, Properties jobParameters, javax.batch.runtime.BatchStatus batchStatus)Create a JobExecutionjavax.batch.runtime.JobInstancecreateJobInstance(String name, String jobXml)Creates a JobIntanceJobStatuscreateJobStatus(long jobInstanceId)Create a JobStatusStepExecutionImplcreateStepExecution(long jobExecId, StepContextImpl stepContext)Create a StepExecutionStepStatuscreateStepStatus(long stepExecId)Create a StepStatusjavax.batch.runtime.JobInstancecreateSubJobInstance(String name)CheckpointDatagetCheckpointData(CheckpointDataKey key)longgetJobInstanceIdByExecutionId(long executionId)Set<String>getJobNames()JobStatusgetJobStatus(long instanceId)Get a JobStatusJobStatusgetJobStatusFromExecution(long executionId)longgetMostRecentExecutionId(long jobInstanceId)PropertiesgetParameters(long executionId)javax.batch.runtime.StepExecutiongetStepExecutionByStepExecutionId(long stepExecId)List<javax.batch.runtime.StepExecution>getStepExecutionsForJobExecution(long execid)StepStatusgetStepStatus(long instanceId, String stepName)Get a StepStatusInternalJobExecutionjobOperatorGetJobExecution(long jobExecutionId)List<InternalJobExecution>jobOperatorGetJobExecutions(long jobInstanceId)intjobOperatorGetJobInstanceCount(String jobName)JOB OPERATOR ONLY METHODSList<Long>jobOperatorGetJobInstanceIds(String jobName, int start, int count)Set<Long>jobOperatorGetRunningExecutions(String jobName)StringjobOperatorQueryJobExecutionBatchStatus(long key)StringjobOperatorQueryJobExecutionExitStatus(long key)TimestampjobOperatorQueryJobExecutionTimestamp(long key, PersistenceManagerService.TimestampType timetype)voidmarkJobStarted(long key, Timestamp startTS)voidsetCheckpointData(CheckpointDataKey key, CheckpointData value)voidupdateBatchStatusOnly(long executionId, javax.batch.runtime.BatchStatus batchStatus, Timestamp timestamp)voidupdateJobStatus(long instanceId, JobStatus jobStatus)Update a JobStatusvoidupdateStepExecution(long jobExecId, StepContextImpl stepContext)Update a StepExecutionvoidupdateStepStatus(long stepExecutionId, StepStatus stepStatus)Update a StepStatusvoidupdateWithFinalExecutionStatusesAndTimestamps(long key, javax.batch.runtime.BatchStatus batchStatus, String exitStatus, Timestamp updatets)-
Methods inherited from interface org.apache.batchee.spi.BatchService
init
-
-
-
-
Method Detail
-
jobOperatorGetJobInstanceCount
int jobOperatorGetJobInstanceCount(String jobName)
JOB OPERATOR ONLY METHODS
-
jobOperatorGetJobInstanceIds
List<Long> jobOperatorGetJobInstanceIds(String jobName, int start, int count)
-
jobOperatorQueryJobExecutionTimestamp
Timestamp jobOperatorQueryJobExecutionTimestamp(long key, PersistenceManagerService.TimestampType timetype)
-
jobOperatorQueryJobExecutionBatchStatus
String jobOperatorQueryJobExecutionBatchStatus(long key)
-
jobOperatorQueryJobExecutionExitStatus
String jobOperatorQueryJobExecutionExitStatus(long key)
-
getStepExecutionsForJobExecution
List<javax.batch.runtime.StepExecution> getStepExecutionsForJobExecution(long execid)
-
updateBatchStatusOnly
void updateBatchStatusOnly(long executionId, javax.batch.runtime.BatchStatus batchStatus, Timestamp timestamp)
-
markJobStarted
void markJobStarted(long key, Timestamp startTS)
-
updateWithFinalExecutionStatusesAndTimestamps
void updateWithFinalExecutionStatusesAndTimestamps(long key, javax.batch.runtime.BatchStatus batchStatus, String exitStatus, Timestamp updatets)
-
jobOperatorGetJobExecution
InternalJobExecution jobOperatorGetJobExecution(long jobExecutionId)
-
getParameters
Properties getParameters(long executionId) throws javax.batch.operations.NoSuchJobExecutionException
- Throws:
javax.batch.operations.NoSuchJobExecutionException
-
jobOperatorGetJobExecutions
List<InternalJobExecution> jobOperatorGetJobExecutions(long jobInstanceId)
-
getJobStatusFromExecution
JobStatus getJobStatusFromExecution(long executionId)
-
getJobInstanceIdByExecutionId
long getJobInstanceIdByExecutionId(long executionId) throws javax.batch.operations.NoSuchJobExecutionException- Throws:
javax.batch.operations.NoSuchJobExecutionException
-
createJobInstance
javax.batch.runtime.JobInstance createJobInstance(String name, String jobXml)
Creates a JobIntance- Parameters:
name- the job id from job.xmljobXml- the resolved job xml- Returns:
- the job instance
-
createJobExecution
RuntimeJobExecution createJobExecution(javax.batch.runtime.JobInstance jobInstance, Properties jobParameters, javax.batch.runtime.BatchStatus batchStatus)
Create a JobExecution- Parameters:
jobInstance- the parent job instancejobParameters- the parent job instance parametersbatchStatus- the current BatchStatus- Returns:
- the RuntimeJobExecution class for this JobExecution
-
createStepExecution
StepExecutionImpl createStepExecution(long jobExecId, StepContextImpl stepContext)
Create a StepExecution- Parameters:
jobExecId- the parent JobExecution idstepContext- the step context for this step execution- Returns:
- the StepExecution
-
updateStepExecution
void updateStepExecution(long jobExecId, StepContextImpl stepContext)Update a StepExecution- Parameters:
jobExecId- the parent JobExecution idstepContext- the step context for this step execution
-
createJobStatus
JobStatus createJobStatus(long jobInstanceId)
Create a JobStatus- Parameters:
jobInstanceId- the parent job instance id- Returns:
- the JobStatus
-
getJobStatus
JobStatus getJobStatus(long instanceId)
Get a JobStatus- Parameters:
instanceId- the parent job instance id- Returns:
- the JobStatus
-
updateJobStatus
void updateJobStatus(long instanceId, JobStatus jobStatus)Update a JobStatus- Parameters:
instanceId- the parent job instance idjobStatus- the job status to be updated
-
createStepStatus
StepStatus createStepStatus(long stepExecId)
Create a StepStatus- Parameters:
stepExecId- the parent step execution id- Returns:
- the StepStatus
-
getStepStatus
StepStatus getStepStatus(long instanceId, String stepName)
Get a StepStatusThe parent job instance id and this step name from the job xml are used to determine if the current step execution have previously run.
- Parameters:
instanceId- the parent job instance idstepName- the step name- Returns:
- the StepStatus
-
updateStepStatus
void updateStepStatus(long stepExecutionId, StepStatus stepStatus)Update a StepStatus- Parameters:
stepExecutionId- the parent step execution idstepStatus- the step status to be updated
-
setCheckpointData
void setCheckpointData(CheckpointDataKey key, CheckpointData value)
-
getCheckpointData
CheckpointData getCheckpointData(CheckpointDataKey key)
-
getMostRecentExecutionId
long getMostRecentExecutionId(long jobInstanceId)
-
createSubJobInstance
javax.batch.runtime.JobInstance createSubJobInstance(String name)
-
createFlowInSplitExecution
RuntimeFlowInSplitExecution createFlowInSplitExecution(javax.batch.runtime.JobInstance jobInstance, javax.batch.runtime.BatchStatus batchStatus)
-
getStepExecutionByStepExecutionId
javax.batch.runtime.StepExecution getStepExecutionByStepExecutionId(long stepExecId)
-
cleanUp
void cleanUp(long instanceId)
-
cleanUp
void cleanUp(Date until)
-
-