Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

IN PROGRESS - BATCH-518: clean up the *Or* repository methods

Browse Source 
saveOrUpdate(StepExecution) split to save and update
This commit is contained in:
robokaso
2008-07-28 10:56:35 +00:00
parent da3eb280c0
commit e9d2d90764
10 changed files with 66 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
spring-batch-core/src/main/java/org/springframework/batch/core/repository/JobRepository.java
View File

@@ -39,8 +39,8 @@ public interface JobRepository {
/**
* Find or create a {@link JobExecution} for a given {@link Job} and
* {@link JobParameters}. If the {@link Job} was already executed with
* these {@link JobParameters}, its persisted values (including ID) will be
* {@link JobParameters}. If the {@link Job} was already executed with these
* {@link JobParameters}, its persisted values (including ID) will be
* returned in a new {@link JobInstance}, associated with the
* {@link JobExecution}. If no previous instance is found, the execution
* will be associated with a new {@link JobInstance}
@@ -63,7 +63,7 @@ public interface JobRepository {
JobRestartException, JobInstanceAlreadyCompleteException;
/**
* Update the {@link JobExecution}.
* Update the {@link JobExecution}.
*
* Preconditions: {@link JobExecution} must contain a valid
* {@link JobInstance} and be saved (have an id assigned).
@@ -73,25 +73,29 @@ public interface JobRepository {
void updateJobExecution(JobExecution jobExecution);
/**
* Save or update a {@link StepExecution}. If no ID is found a new instance
* will be created (and saved). If an ID does exist it will be updated. It
* is not advisable that an ID be assigned before calling this method.
* Instead, it should be left blank, to be assigned by a
* {@link JobRepository}. The {@link ExecutionContext} of the
* {@link StepExecution} is <em>not</em> saved: see
* {@link #saveOrUpdateExecutionContext(StepExecution)}.
* Save the {@link StepExecution}. ID will be assigned - it is not advisable
* that an ID be assigned before calling this method. Instead, it should be
* left blank, to be assigned by a {@link JobRepository}. The
* {@link ExecutionContext} of the {@link StepExecution} is <em>not</em>
* saved: see {@link #saveOrUpdateExecutionContext(StepExecution)}.
*
* Preconditions: {@link StepExecution} must have a valid {@link Step}.
*
* @param stepExecution
*/
void saveOrUpdate(StepExecution stepExecution);
void save(StepExecution stepExecution);
/**
* Update the {@link StepExecution}.
*
* Preconditions: {@link StepExecution} must be saved (have an id assigned).
*
* @param stepExecution
*/
void update(StepExecution stepExecution);
/**
* Save the {@link ExecutionContext} of the given {@link StepExecution}.
* Implementations are allowed to ensure that the {@link StepExecution} is
* already saved by calling {@link #saveOrUpdate(StepExecution)} before
* saving the {@link ExecutionContext}.
*
* @param stepExecution the {@link StepExecution} containing the
* {@link ExecutionContext} to be saved.

37
spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/SimpleJobRepository.java
View File

@@ -213,27 +213,34 @@ public class SimpleJobRepository implements JobRepository {
}
/**
* Save or Update the given StepExecution. If it's id is null, it will be
* saved and an id will be set, otherwise it will be updated. It should be
* noted that assigning an ID randomly will likely cause an exception
* depending on the StepDao implementation.
* Save the {@link StepExecution}.
*
* @param stepExecution to be saved.
* @throws IllegalArgumentException if stepExecution is null.
* Preconditions: step name must be given and associated
* {@link JobExecution} must already be saved (have an id assigned).
*/
public void saveOrUpdate(StepExecution stepExecution) {
public void save(StepExecution stepExecution) {
validateStepExecution(stepExecution);
stepExecutionDao.saveStepExecution(stepExecution);
}
/**
* Update the {@link StepExecution}.
*
* Preconditions: step name must be given and associated
* {@link JobExecution} must already be saved (have an id assigned).
*/
public void update(StepExecution stepExecution) {
validateStepExecution(stepExecution);
Assert.notNull(stepExecution.getId(), "StepExecution must already be saved (have an id assigned)");
stepExecutionDao.updateStepExecution(stepExecution);
}
private void validateStepExecution(StepExecution stepExecution) {
Assert.notNull(stepExecution, "StepExecution cannot be null.");
Assert.notNull(stepExecution.getStepName(), "StepExecution's step name cannot be null.");
Assert.notNull(stepExecution.getJobExecutionId(), "StepExecution must belong to persisted JobExecution");
if (stepExecution.getId() == null) {
stepExecutionDao.saveStepExecution(stepExecution);
}
else {
// existing execution, update
stepExecutionDao.updateStepExecution(stepExecution);
}
}
/*

5
spring-batch-core/src/main/java/org/springframework/batch/core/step/AbstractStep.java
View File

@@ -181,6 +181,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
UnexpectedJobExecutionException {
stepExecution.setStartTime(new Date());
stepExecution.setStatus(BatchStatus.STARTED);
getJobRepository().save(stepExecution);
ExitStatus exitStatus = ExitStatus.FAILED;
Exception commitException = null;
@@ -205,7 +206,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
exitStatus = exitStatus.and(getCompositeListener().afterStep(stepExecution));
try {
getJobRepository().saveOrUpdate(stepExecution);
getJobRepository().update(stepExecution);
getJobRepository().saveOrUpdateExecutionContext(stepExecution);
}
catch (Exception e) {
@@ -235,7 +236,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
stepExecution.setEndTime(new Date());
try {
getJobRepository().saveOrUpdate(stepExecution);
getJobRepository().update(stepExecution);
}
catch (Exception e) {
if (commitException == null) {

3
spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ItemOrientedStep.java
View File

@@ -222,7 +222,6 @@ public class ItemOrientedStep extends AbstractStep {
*/
protected ExitStatus doExecute(final StepExecution stepExecution) throws Exception {
stream.update(stepExecution.getExecutionContext());
getJobRepository().saveOrUpdate(stepExecution);
getJobRepository().saveOrUpdateExecutionContext(stepExecution);
itemHandler.mark();
@@ -402,7 +401,7 @@ public class ItemOrientedStep extends AbstractStep {
if (fatalException.hasException()) {
// Try and give the system a chance to update the stepExecution with
// the failure status.
getJobRepository().saveOrUpdate(stepExecution);
getJobRepository().update(stepExecution);
}
}

2
spring-batch-core/src/test/java/org/springframework/batch/core/job/SimpleJobTests.java
View File

@@ -499,7 +499,7 @@ public class SimpleJobTests extends TestCase {
passedInStepContext = new ExecutionContext(stepExecution.getExecutionContext());
stepExecution.getExecutionContext().putString("stepKey", "stepValue");
stepExecution.getJobExecution().getExecutionContext().putString("jobKey", "jobValue");
jobRepository.saveOrUpdate(stepExecution);
jobRepository.save(stepExecution);
jobRepository.saveOrUpdateExecutionContext(stepExecution);
if (exception instanceof RuntimeException) {

8
spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/SimpleJobRepositoryIntegrationTests.java
View File

@@ -112,7 +112,7 @@ public class SimpleJobRepositoryIntegrationTests extends AbstractTransactionalDa
JobExecution firstJobExec = jobRepository.createJobExecution(job, jobParameters);
StepExecution firstStepExec = new StepExecution(step.getName(), firstJobExec);
jobRepository.updateJobExecution(firstJobExec);
jobRepository.saveOrUpdate(firstStepExec);
jobRepository.save(firstStepExec);
assertEquals(1, jobRepository.getStepExecutionCount(firstJobExec.getJobInstance(), step));
assertEquals(firstStepExec, jobRepository.getLastStepExecution(firstJobExec.getJobInstance(), step));
@@ -122,7 +122,7 @@ public class SimpleJobRepositoryIntegrationTests extends AbstractTransactionalDa
firstStepExec.setStartTime(new Date(5));
firstStepExec.setStatus(BatchStatus.FAILED);
firstStepExec.setEndTime(new Date(6));
jobRepository.saveOrUpdate(firstStepExec);
jobRepository.update(firstStepExec);
firstJobExec.setStatus(BatchStatus.FAILED);
firstJobExec.setEndTime(new Date(7));
jobRepository.updateJobExecution(firstJobExec);
@@ -131,7 +131,7 @@ public class SimpleJobRepositoryIntegrationTests extends AbstractTransactionalDa
JobExecution secondJobExec = jobRepository.createJobExecution(job, jobParameters);
StepExecution secondStepExec = new StepExecution(step.getName(), secondJobExec);
jobRepository.updateJobExecution(secondJobExec);
jobRepository.saveOrUpdate(secondStepExec);
jobRepository.save(secondStepExec);
assertEquals(2, jobRepository.getStepExecutionCount(secondJobExec.getJobInstance(), step));
assertEquals(secondStepExec, jobRepository.getLastStepExecution(secondJobExec.getJobInstance(), step));
@@ -153,7 +153,7 @@ public class SimpleJobRepositoryIntegrationTests extends AbstractTransactionalDa
StepExecution stepExec = new StepExecution(step.getName(), jobExec);
stepExec.setExecutionContext(ctx);
jobRepository.saveOrUpdate(stepExec);
jobRepository.save(stepExec);
jobRepository.saveOrUpdateExecutionContext(stepExec);
StepExecution retrievedStepExec = jobRepository.getLastStepExecution(jobExec.getJobInstance(), step);

2
spring-batch-core/src/test/java/org/springframework/batch/core/repository/support/SimpleJobRepositoryTests.java
View File

@@ -142,7 +142,7 @@ public class SimpleJobRepositoryTests extends TestCase {
// failure scenario -- no step id set.
try {
jobRepository.saveOrUpdate(stepExecution);
jobRepository.save(stepExecution);
fail();
}
catch (Exception ex) {

15
spring-batch-core/src/test/java/org/springframework/batch/core/step/JobRepositorySupport.java
View File

@@ -47,12 +47,6 @@ public class JobRepositorySupport implements JobRepository {
*/
public void saveOrUpdate(StepExecution stepExecution) {
}
/* (non-Javadoc)
* @see org.springframework.batch.core.repository.JobRepository#saveOrUpdateExecutionContext(org.springframework.batch.core.domain.StepExecution)
*/
public void saveOrUpdateExecutionContext(StepExecution stepExecution) {
}
/* (non-Javadoc)
* @see org.springframework.batch.container.common.repository.JobRepository#update(org.springframework.batch.container.common.domain.Job)
@@ -76,4 +70,13 @@ public class JobRepositorySupport implements JobRepository {
return null;
}
public void save(StepExecution stepExecution) {
}
public void update(StepExecution stepExecution) {
}
public void saveOrUpdateExecutionContext(StepExecution stepExecution) {
}
}

2
spring-batch-integration/src/main/java/org/springframework/batch/integration/job/MessageOrientedStep.java
View File

@@ -111,7 +111,7 @@ public class MessageOrientedStep extends AbstractStep {
else {
executionContext.putString(WAITING, "true");
// TODO: need these two lines to be atomic
getJobRepository().saveOrUpdate(stepExecution);
getJobRepository().update(stepExecution);
requestChannel.send(new GenericMessage<JobExecutionRequest>(request));
waitForReply(request.getJobId());
}

6
spring-batch-integration/src/test/java/org/springframework/batch/integration/JobRepositorySupport.java
View File

@@ -72,4 +72,10 @@ public class JobRepositorySupport implements JobRepository {
public void saveOrUpdateExecutionContext(StepExecution stepExecution) {
}
public void save(StepExecution stepExecution) {
}
public void update(StepExecution stepExecution) {
}
}