RESOLVED - issue BATCH-274: Support Callable<ExitStatus>

Added CallablTaskletAdapter (also removed dependency on backport concurrent)
This commit is contained in:
dsyer
2008-07-17 12:15:54 +00:00
parent 609c7005e9
commit 06d781a950
13 changed files with 139 additions and 246 deletions

View File

@@ -1,40 +0,0 @@
/*
* Copyright 2006-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.batch.core.step;
import org.springframework.batch.core.StepExecution;
import edu.emory.mathcs.backport.java.util.concurrent.Semaphore;
/**
* An implementation of the {@link StepExecutionSynchronizer} that uses Backport Concurrent Utilities.
*
* @author Dave Syer
* @author Ben Hale
*/
class BackportConcurrentStepExecutionSynchronizer implements StepExecutionSynchronizer {
private Semaphore semaphore = new Semaphore(1);
public void lock(StepExecution stepExecution) throws InterruptedException {
semaphore.acquire();
}
public void release(StepExecution stepExecution) {
semaphore.release();
}
}

View File

@@ -16,33 +16,19 @@
package org.springframework.batch.core.step;
import org.springframework.core.JdkVersion;
import org.springframework.util.ClassUtils;
/**
* A factory that properly determines which version of the {@link StepExecutionSynchronizer} to return based on the
* availabilty of Java 5 or Backport Concurrent.
* A factory for {@link StepExecutionSynchronizer} which simply creates one from
* java.util.concurrent components.
*
* @author Ben Hale
* @author Dave Syer
*/
public class StepExecutionSynchronizerFactory {
/** Whether the backport-concurrent library is present on the classpath */
private static final boolean backportConcurrentAvailable = ClassUtils.isPresent(
"edu.emory.mathcs.backport.java.util.concurrent.Semaphore", StepExecutionSynchronizerFactory.class
.getClassLoader());
private final StepExecutionSynchronizer synchronizer;
public StepExecutionSynchronizerFactory() {
if (JdkVersion.isAtLeastJava15()) {
synchronizer = new JdkConcurrentStepExecutionSynchronizer();
} else if (backportConcurrentAvailable) {
synchronizer = new BackportConcurrentStepExecutionSynchronizer();
} else {
throw new IllegalStateException("Cannot create StepExecutionSynchronizer - "
+ "neither JDK 1.5 nor backport-concurrent available on the classpath");
}
synchronizer = new JdkConcurrentStepExecutionSynchronizer();
}
public StepExecutionSynchronizer getStepExecutionSynchronizer() {

View File

@@ -0,0 +1,60 @@
/*
* Copyright 2006-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.batch.core.step.tasklet;
import java.util.concurrent.Callable;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
/**
* Adapts a {@link Callable}&lt;{@link ExitStatus}&gt; to the
* {@link Tasklet} interface.
*
* @author Dave Syer
*
*/
public class CallableTaskletAdapter implements Tasklet, InitializingBean {
private Callable<ExitStatus> callable;
/**
* Public setter for the {@link Callable}.
* @param callable the {@link Callable} to set
*/
public void setCallable(Callable<ExitStatus> callable) {
this.callable = callable;
}
/**
* Assert that the callable is set.
*
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
*/
public void afterPropertiesSet() throws Exception {
Assert.notNull(callable);
}
/**
* Execute the provided Callable and return its {@link ExitStatus}.
* @see org.springframework.batch.core.step.tasklet.Tasklet#execute()
*/
public ExitStatus execute() throws Exception {
return callable.call();
}
}

View File

@@ -0,0 +1,54 @@
/*
* Copyright 2006-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.batch.core.step.tasklet;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import java.util.concurrent.Callable;
import org.junit.Test;
import org.springframework.batch.repeat.ExitStatus;
public class CallableTaskletAdapterTests {
private CallableTaskletAdapter adapter = new CallableTaskletAdapter();
/**
* Test method for {@link org.springframework.batch.core.step.tasklet.CallableTaskletAdapter#execute()}.
* @throws Exception
*/
@Test
public void testExecute() throws Exception {
adapter.setCallable(new Callable<ExitStatus>() {
public ExitStatus call() throws Exception {
return ExitStatus.FINISHED;
}
});
assertEquals(ExitStatus.FINISHED, adapter.execute());
}
@Test
public void testAfterPropertiesSet() throws Exception {
try {
adapter.afterPropertiesSet();
fail("Expected IllegalArgumentException");
}
catch (IllegalArgumentException e) {
// expected
}
}
}

View File

@@ -15,16 +15,17 @@
*/
package org.springframework.batch.core.step.tasklet;
import org.springframework.batch.core.step.tasklet.TaskletAdapter;
import org.springframework.batch.repeat.ExitStatus;
import static org.junit.Assert.assertEquals;
import junit.framework.TestCase;
import org.junit.Before;
import org.junit.Test;
import org.springframework.batch.repeat.ExitStatus;
/**
* @author Dave Syer
*
*/
public class TaskletAdapterTests extends TestCase {
public class TaskletAdapterTests {
private TaskletAdapter tasklet = new TaskletAdapter();
private Object result = null;
@@ -40,7 +41,8 @@ public class TaskletAdapterTests extends TestCase {
/* (non-Javadoc)
* @see junit.framework.TestCase#setUp()
*/
protected void setUp() throws Exception {
@Before
public void setUp() throws Exception {
tasklet.setTargetObject(this);
tasklet.setTargetMethod("execute");
}
@@ -49,6 +51,7 @@ public class TaskletAdapterTests extends TestCase {
* Test method for {@link org.springframework.batch.core.step.tasklet.TaskletAdapter#execute()}.
* @throws Exception
*/
@Test
public void testExecuteWithExitStatus() throws Exception {
assertEquals(ExitStatus.NOOP, tasklet.execute());
}
@@ -56,6 +59,7 @@ public class TaskletAdapterTests extends TestCase {
/**
* Test method for {@link org.springframework.batch.core.step.tasklet.TaskletAdapter#mapResult(java.lang.Object)}.
*/
@Test
public void testMapResultWithNull() throws Exception {
tasklet.setTargetMethod("process");
assertEquals(ExitStatus.FINISHED, tasklet.execute());
@@ -63,7 +67,8 @@ public class TaskletAdapterTests extends TestCase {
/**
* Test method for {@link org.springframework.batch.core.step.tasklet.TaskletAdapter#mapResult(java.lang.Object)}.
*/
*/
@Test
public void testMapResultWithNonNull() throws Exception {
tasklet.setTargetMethod("process");
this.result = "foo";