IN PROGRESS - issue BATCH-7: Remove transaction synchronization and state management from input/output sources (formerly buffering)

http://jira.springframework.org/browse/BATCH-7

Added ItemStream as base interface for ItemReader/Writer.
This commit is contained in:
dsyer
2008-01-30 18:42:48 +00:00
parent 11708012b5
commit bebab9c8d2
42 changed files with 340 additions and 235 deletions

View File

@@ -26,7 +26,6 @@ import org.hibernate.StatelessSession;
import org.springframework.batch.io.Skippable;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.reader.AbstractItemReader;
import org.springframework.batch.item.stream.GenericStreamContext;
@@ -58,7 +57,7 @@ import org.springframework.util.StringUtils;
* @author Dave Syer
*/
public class HibernateCursorItemReader extends AbstractItemReader implements ItemReader, ItemStream,
Skippable, InitializingBean, DisposableBean, ResourceLifecycle {
Skippable, InitializingBean, DisposableBean {
private static final String RESTART_DATA_ROW_NUMBER_KEY = ClassUtils
.getShortName(HibernateCursorItemReader.class)

View File

@@ -33,7 +33,6 @@ import org.springframework.batch.io.Skippable;
import org.springframework.batch.io.support.AbstractTransactionalIoSource;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.KeyedItemReader;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.statistics.StatisticsProvider;
@@ -117,7 +116,7 @@ import org.springframework.util.StringUtils;
* @author Peter Zozom
*/
public class JdbcCursorItemReader extends AbstractTransactionalIoSource
implements KeyedItemReader, ResourceLifecycle, DisposableBean,
implements KeyedItemReader, DisposableBean,
InitializingBean, ItemStream, StatisticsProvider, Skippable {
private static Log log = LogFactory.getLog(JdbcCursorItemReader.class);

View File

@@ -21,7 +21,6 @@ import java.util.List;
import org.springframework.batch.io.support.AbstractTransactionalIoSource;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.KeyedItemReader;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.repeat.synch.BatchTransactionSynchronizationManager;
import org.springframework.beans.factory.DisposableBean;
@@ -51,7 +50,7 @@ import org.springframework.util.Assert;
* @since 1.0
*/
public class DrivingQueryItemReader extends AbstractTransactionalIoSource
implements KeyedItemReader, ResourceLifecycle, InitializingBean,
implements KeyedItemReader, InitializingBean,
DisposableBean, ItemStream {
private boolean initialized = false;

View File

@@ -33,7 +33,6 @@ import org.springframework.batch.io.exception.BatchEnvironmentException;
import org.springframework.batch.io.support.AbstractTransactionalIoSource;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.item.writer.ItemTransformer;
@@ -61,7 +60,7 @@ import org.springframework.util.Assert;
* @author Dave Syer
*/
public class FlatFileItemWriter extends AbstractTransactionalIoSource implements
ItemWriter, ResourceLifecycle, ItemStream, StatisticsProvider, InitializingBean,
ItemWriter, ItemStream, StatisticsProvider, InitializingBean,
DisposableBean {
private static final String LINE_SEPARATOR = System.getProperty("line.separator");

View File

@@ -31,7 +31,6 @@ import org.springframework.batch.io.file.transform.AbstractLineTokenizer;
import org.springframework.batch.io.file.transform.DelimitedLineTokenizer;
import org.springframework.batch.io.file.transform.LineTokenizer;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.reader.AbstractItemReader;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
@@ -171,11 +170,10 @@ public class SimpleFlatFileItemReader extends AbstractItemReader implements Item
}
/**
* Close and null out the reader.
*
* @see ResourceLifecycle
* Close and null out the delegate line reader.
* @throws Exception
*/
public void close() {
public void close() throws Exception {
try {
if (reader != null) {
log.debug("Closing flat file for reading: "+resource);

View File

@@ -16,13 +16,12 @@
package org.springframework.batch.io.file.separator;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ResourceLifecycle;
/**
* @author Dave Syer
*
*/
public interface LineReader extends ResourceLifecycle, ItemReader {
public interface LineReader extends ItemReader {
/**
* @return

View File

@@ -27,7 +27,6 @@ import java.util.Iterator;
import org.springframework.batch.io.exception.BatchEnvironmentException;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.reader.AbstractItemReader;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.core.io.Resource;
@@ -56,7 +55,7 @@ import org.springframework.util.Assert;
* @author Dave Syer
* @author Rob Harrop
*/
public class ResourceLineReader extends AbstractItemReader implements LineReader, ResourceLifecycle, ItemReader,
public class ResourceLineReader extends AbstractItemReader implements LineReader, ItemReader,
DisposableBean {
private static final Collection DEFAULT_COMMENTS = Collections.singleton("#");

View File

@@ -20,6 +20,7 @@ import java.util.Set;
import org.hibernate.SessionFactory;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.stream.ItemStreamAdapter;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.RepeatContext;
import org.springframework.batch.repeat.RepeatInterceptor;
@@ -44,7 +45,7 @@ import org.springframework.util.Assert;
* @author Dave Syer
*
*/
public class HibernateAwareItemWriter implements ItemWriter, RepeatInterceptor,
public class HibernateAwareItemWriter extends ItemStreamAdapter implements ItemWriter, RepeatInterceptor,
InitializingBean {
/**

View File

@@ -19,7 +19,6 @@ import org.springframework.batch.io.xml.stax.FragmentEventReader;
import org.springframework.batch.io.xml.stax.TransactionalEventReader;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.reader.AbstractItemReader;
import org.springframework.batch.item.stream.GenericStreamContext;
@@ -43,7 +42,7 @@ import org.springframework.util.Assert;
*
* @author Robert Kasanicky
*/
public class StaxEventItemReader extends AbstractItemReader implements ItemReader, ResourceLifecycle,
public class StaxEventItemReader extends AbstractItemReader implements ItemReader,
Skippable, ItemStream, StatisticsProvider, InitializingBean, DisposableBean {
public static final String READ_COUNT_STATISTICS_NAME = "StaxEventReaderItemReader.readCount";

View File

@@ -18,7 +18,6 @@ import org.springframework.batch.io.support.FileUtils;
import org.springframework.batch.io.xml.stax.NoStartEndDocumentStreamWriter;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.ResourceLifecycle;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.repeat.synch.BatchTransactionSynchronizationManager;
@@ -42,7 +41,7 @@ import org.springframework.util.CollectionUtils;
* @author Peter Zozom
*
*/
public class StaxEventItemWriter implements ItemWriter, ResourceLifecycle, ItemStream,
public class StaxEventItemWriter implements ItemWriter, ItemStream,
StatisticsProvider, InitializingBean, DisposableBean {
// default encoding

View File

@@ -38,7 +38,7 @@ import org.springframework.batch.item.reader.AbstractItemReader;
* @author Lucas Ward
* @since 1.0
*/
public interface ItemReader {
public interface ItemReader extends ItemStream {
/**
* Reads a piece of input data and advance to the next one. Implementations
@@ -51,9 +51,4 @@ public interface ItemReader {
*/
Object read() throws Exception;
/**
* Close the reader, freeing any resources that may have been allocated
* since the first call to read().
*/
void close() throws Exception;
}

View File

@@ -35,6 +35,16 @@ package org.springframework.batch.item;
*
*/
public interface ItemStream {
void open() throws Exception;
/**
* Close the reader, freeing any resources that may have been allocated
* since the first call to read().
*
* @throws Exception if an underlying resource is unavailable
*/
void close() throws Exception;
/**
* Get {@link StreamContext} representing this object's current state.

View File

@@ -25,7 +25,7 @@ package org.springframework.batch.item;
* @author Dave Syer
* @author Lucas Ward
*/
public interface ItemWriter {
public interface ItemWriter extends ItemStream {
/**
* Process the supplied data element. Will be called multiple times during a
@@ -38,10 +38,4 @@ public interface ItemWriter {
*/
public void write(Object item) throws Exception;
/**
* Close the writer, allowing all allocated resources to be cleaned up.
*
* @throws Exception
*/
void close() throws Exception;
}

View File

@@ -1,37 +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.item;
/**
* Common interface for classes that require initialisation before they can be
* used and need to free resources after they are no longer used.
*/
public interface ResourceLifecycle {
/**
* This method should be invoked by clients at the start of processing to
* allow initialisation of resources.
*
*/
public void open();
/**
* This method should be invoked by clients after the completion of each
* step and the implementing class should close all managed resources.
*
*/
public void close();
}

View File

@@ -17,19 +17,13 @@
package org.springframework.batch.item.reader;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.stream.ItemStreamAdapter;
/**
* Base class for {@link ItemReader} implementations.
* @author Dave Syer
*
*/
public abstract class AbstractItemReader implements ItemReader {
/**
* Do nothing.
* @see org.springframework.batch.item.ItemReader#close()
*/
public void close() throws Exception {
}
public abstract class AbstractItemReader extends ItemStreamAdapter implements ItemReader {
}

View File

@@ -16,7 +16,11 @@
package org.springframework.batch.item.reader;
import java.util.Properties;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.support.AbstractMethodInvokingDelegator;
/**
@@ -35,10 +39,33 @@ public class ItemReaderAdapter extends AbstractMethodInvokingDelegator implement
/**
* Do nothing.
*
* @see org.springframework.batch.item.ItemReader#close()
* @see org.springframework.batch.item.ItemStream#open()
*/
public void open() throws Exception {
// no-op
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#close()
*/
public void close() throws Exception {
// no-op
}
/**
* Return empty {@link StreamContext}.
* @see org.springframework.batch.item.ItemStream#getRestartData()
*/
public StreamContext getRestartData() {
return new GenericStreamContext(new Properties());
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#restoreFrom(org.springframework.batch.item.StreamContext)
*/
public void restoreFrom(StreamContext data) {
}

View File

@@ -1,31 +0,0 @@
/*
* Copyright 2006-2008 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.item.writer;
import org.springframework.batch.item.ItemWriter;
/**
* Abstract {@link ItemWriter} that allows for base classes to only
* implement the close method if they need it.
*
* @author Lucas Ward
*
*/
public abstract class AbstractItemWriter implements ItemWriter{
public void close() throws Exception {
}
}

View File

@@ -11,13 +11,14 @@ import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.item.stream.ItemStreamAdapter;
/**
* Runs a collection of ItemProcessors in fixed-order sequence.
*
* @author Robert Kasanicky
*/
public class CompositeItemWriter implements ItemWriter, ItemStream {
public class CompositeItemWriter extends ItemStreamAdapter implements ItemWriter, ItemStream {
private static final String SEPARATOR = "#";
@@ -38,13 +39,8 @@ public class CompositeItemWriter implements ItemWriter, ItemStream {
*/
public StreamContext getRestartData() {
Properties props = createCompoundProperties(new PropertiesExtractor() {
public Properties extractProperties(Object o) {
if (o instanceof ItemStream) {
return ((ItemStream) o).getRestartData().getProperties();
}
else {
return null;
}
public Properties extractProperties(ItemStream o) {
return o.getRestartData().getProperties();
}
});
return new GenericStreamContext(props);
@@ -105,7 +101,7 @@ public class CompositeItemWriter implements ItemWriter, ItemStream {
Properties stats = new Properties();
int index = 0;
for (Iterator iterator = delegates.listIterator(); iterator.hasNext();) {
Properties writerStats = extractor.extractProperties(iterator.next());
Properties writerStats = extractor.extractProperties((ItemStream) iterator.next());
if (writerStats != null) {
for (Iterator iterator2 = writerStats.entrySet().iterator(); iterator2.hasNext();) {
Map.Entry entry = (Map.Entry) iterator2.next();
@@ -123,7 +119,7 @@ public class CompositeItemWriter implements ItemWriter, ItemStream {
* null.
*/
private interface PropertiesExtractor {
Properties extractProperties(Object o);
Properties extractProperties(ItemStream o);
}
public void close() throws Exception {

View File

@@ -7,6 +7,7 @@ import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.item.stream.ItemStreamAdapter;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
@@ -17,7 +18,7 @@ import org.springframework.util.Assert;
* @author Dave Syer
* @author Robert Kasanicky
*/
public class DelegatingItemWriter implements ItemWriter, ItemStream, Skippable, InitializingBean {
public class DelegatingItemWriter extends ItemStreamAdapter implements ItemWriter, Skippable, InitializingBean {
private ItemWriter writer;

View File

@@ -16,7 +16,11 @@
package org.springframework.batch.item.writer;
import java.util.Properties;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.support.AbstractMethodInvokingDelegator;
@@ -34,13 +38,35 @@ public class ItemWriterAdapter extends AbstractMethodInvokingDelegator implement
invokeDelegateMethodWithArgument(item);
}
/*
* No-op, can't call more than one method.
*
* (non-Javadoc)
* @see org.springframework.batch.item.ItemWriter#close()
*/
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#open()
*/
public void open() throws Exception {
// no-op
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#close()
*/
public void close() throws Exception {
// no-op
}
/**
* Return empty {@link StreamContext}.
* @see org.springframework.batch.item.ItemStream#getRestartData()
*/
public StreamContext getRestartData() {
return new GenericStreamContext(new Properties());
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#restoreFrom(org.springframework.batch.item.StreamContext)
*/
public void restoreFrom(StreamContext data) {
}

View File

@@ -16,7 +16,11 @@
package org.springframework.batch.item.writer;
import java.util.Properties;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.support.AbstractMethodInvokingDelegator;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
@@ -66,7 +70,35 @@ public class PropertyExtractingDelegatingItemWriter extends AbstractMethodInvoki
this.fieldsUsedAsTargetMethodArguments = fieldsUsedAsMethodArguments;
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#open()
*/
public void open() throws Exception {
// no-op
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#close()
*/
public void close() throws Exception {
// no-op
}
/**
* Return empty {@link StreamContext}.
* @see org.springframework.batch.item.ItemStream#getRestartData()
*/
public StreamContext getRestartData() {
return new GenericStreamContext(new Properties());
}
/**
* Do nothing.
* @see org.springframework.batch.item.ItemStream#restoreFrom(org.springframework.batch.item.StreamContext)
*/
public void restoreFrom(StreamContext data) {
}
}

View File

@@ -22,7 +22,7 @@ import java.util.Map;
import junit.framework.TestCase;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.writer.AbstractItemWriter;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.RepeatContext;
import org.springframework.batch.repeat.RepeatInterceptor;
@@ -41,12 +41,13 @@ public class HibernateAwareItemWriterTests extends TestCase {
public void flush() throws DataAccessException {
list.add("flush");
}
public void clear() {
list.add("clear");
list.add("clear");
};
}
private class StubItemWriter implements ItemWriter, RepeatInterceptor {
private class StubItemWriter extends AbstractItemWriter implements RepeatInterceptor {
public void write(Object item) {
list.add(item);
}
@@ -70,13 +71,10 @@ public class HibernateAwareItemWriterTests extends TestCase {
public void open(RepeatContext context) {
list.add(context);
}
public void close() throws Exception {
}
}
HibernateAwareItemWriter writer = new HibernateAwareItemWriter();
final List list = new ArrayList();
private RepeatContextSupport context;
@@ -93,15 +91,16 @@ public class HibernateAwareItemWriterTests extends TestCase {
writer.setHibernateTemplate(new HibernateTemplateWrapper());
list.clear();
}
/* (non-Javadoc)
/*
* (non-Javadoc)
* @see junit.framework.TestCase#tearDown()
*/
protected void tearDown() throws Exception {
Map map = TransactionSynchronizationManager.getResourceMap();
for (Iterator iterator = map.keySet().iterator(); iterator.hasNext();) {
String key = (String) iterator.next();
TransactionSynchronizationManager.unbindResource(key);
TransactionSynchronizationManager.unbindResource(key);
}
}
@@ -116,10 +115,10 @@ public class HibernateAwareItemWriterTests extends TestCase {
try {
writer.afterPropertiesSet();
fail("Expected IllegalArgumentException");
} catch (IllegalArgumentException e) {
}
catch (IllegalArgumentException e) {
// expected
assertTrue("Wrong message for exception: " + e.getMessage(), e
.getMessage().indexOf("delegate") >= 0);
assertTrue("Wrong message for exception: " + e.getMessage(), e.getMessage().indexOf("delegate") >= 0);
}
}
@@ -136,7 +135,7 @@ public class HibernateAwareItemWriterTests extends TestCase {
/**
* Test method for
* {@link org.springframework.batch.io.support.HibernateAwareItemWriter#write(java.lang.Object)}.
* @throws Exception
* @throws Exception
*/
public void testWrite() throws Exception {
writer.write("foo");
@@ -158,7 +157,8 @@ public class HibernateAwareItemWriterTests extends TestCase {
try {
writer.close(context);
fail("Expected RuntimeException");
} catch (RuntimeException e) {
}
catch (RuntimeException e) {
assertEquals("bar", e.getMessage());
}
assertEquals(2, list.size());
@@ -169,7 +169,7 @@ public class HibernateAwareItemWriterTests extends TestCase {
/**
* Test method for
* {@link org.springframework.batch.io.support.HibernateAwareItemWriter#write(java.lang.Object)}.
* @throws Exception
* @throws Exception
*/
public void testWriteAndCloseWithFailure() throws Exception {
final RuntimeException ex = new RuntimeException("bar");
@@ -182,7 +182,8 @@ public class HibernateAwareItemWriterTests extends TestCase {
try {
writer.close(context);
fail("Expected RuntimeException");
} catch (RuntimeException e) {
}
catch (RuntimeException e) {
assertEquals("bar", e.getMessage());
}
assertEquals(3, list.size());

View File

@@ -8,11 +8,10 @@ import java.util.Properties;
import junit.framework.TestCase;
import org.easymock.MockControl;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.ItemWriter;
import org.springframework.batch.item.StreamContext;
import org.springframework.batch.item.stream.GenericStreamContext;
import org.springframework.batch.item.writer.CompositeItemWriter;
import org.springframework.batch.item.stream.ItemStreamAdapter;
import org.springframework.batch.statistics.StatisticsProvider;
/**
@@ -62,14 +61,9 @@ public class CompositeItemWriterTests extends TestCase {
* All Restartable processors should be restarted, not-Restartable processors should be ignored.
*/
public void testRestart() {
//this mock with undefined behavior makes sure not-Restartable processor is ignored
MockControl p1c = MockControl.createStrictControl(ItemWriter.class);
final ItemWriter p1 = (ItemWriter) p1c.getMock();
final ItemWriter p2 = new ItemWriterStub();
final ItemWriter p3 = new ItemWriterStub();
List itemProcessors = new ArrayList(){{
add(p1);
add(p2);
add(p3);
}};
@@ -120,7 +114,7 @@ public class CompositeItemWriterTests extends TestCase {
* Stub for testing restart. Checks the restart data received is the same that was returned by
* <code>getRestartData()</code>
*/
private static class ItemWriterStub implements ItemWriter, ItemStream, StatisticsProvider {
private static class ItemWriterStub extends ItemStreamAdapter implements ItemWriter, StatisticsProvider {
private static final String RESTART_KEY = "restartData";
private static final String STATS_KEY = "stats";

View File

@@ -19,9 +19,9 @@ package org.springframework.batch.repeat.support;
import java.util.HashSet;
import java.util.Set;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.RepeatCallback;
import org.springframework.batch.repeat.RepeatContext;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.callback.ItemReaderRepeatCallback;
import org.springframework.core.task.SimpleAsyncTaskExecutor;