Merge pull request #129 from dturanski/gemfire

* gemfire:
  pulled system.out from StepScopeIntegrationTests.java
  fixed maven build issues
  added GemfireItemWriter
This commit is contained in:
Michael Minella
2013-02-28 11:45:10 -06:00
8 changed files with 378 additions and 5 deletions

View File

@@ -190,7 +190,7 @@
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-commons-core</artifactId>
<artifactId>spring-data-commons</artifactId>
<optional>true</optional>
</dependency>
<dependency>
@@ -203,6 +203,16 @@
<artifactId>spring-data-neo4j</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-gemfire</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.codehaus.woodstox</groupId>
<artifactId>woodstox-core-asl</artifactId>

View File

@@ -0,0 +1,84 @@
/*
* Copyright 2002-2013 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;
import java.util.List;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.convert.converter.Converter;
import org.springframework.util.Assert;
/**
* A base class to implement any {@link ItemWriter} that writes to a key value store
* using a {@link Converter} to derive a key from an item
*
* @author David Turanski
* @since 2.2
*
*/
public abstract class KeyValueItemWriter<K, V> implements ItemWriter<V>, InitializingBean {
protected Converter<V, K> itemKeyMapper;
protected boolean delete;
/* (non-Javadoc)
* @see org.springframework.batch.item.ItemWriter#write(java.util.List)
*/
@Override
public void write(List<? extends V> items) throws Exception {
if (items == null) {
return;
}
for (V item : items) {
K key = itemKeyMapper.convert(item);
writeKeyValue(key, item);
}
}
/**
* Subclasses implement this method to write each item to key value store
* @param key the key
* @param value the item
*/
protected abstract void writeKeyValue(K key, V value);
/**
* afterPropertiesSet() hook
*/
protected abstract void init();
/**
* Set the {@link Converter} to use to derive the key from the item
* @param itemKeyMapper
*/
public void setItemKeyMapper(Converter<V, K> itemKeyMapper) {
this.itemKeyMapper = itemKeyMapper;
}
/**
* Sets the delete flag to have the item writer perform deletes
* @param delete
*/
public void setDelete(boolean delete) {
this.delete = delete;
}
/* (non-Javadoc)
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
*/
@Override
public void afterPropertiesSet() throws Exception {
Assert.notNull(itemKeyMapper, "itemKeyMapper requires a Converter type.");
init();
}
}

View File

@@ -0,0 +1,40 @@
/*
* Copyright 2002-2013 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;
import org.springframework.core.convert.converter.Converter;
import org.springframework.expression.Expression;
import org.springframework.expression.ExpressionParser;
import org.springframework.expression.spel.standard.SpelExpressionParser;
/**
* An implementation of {@link Converter} that uses SpEL to map a Value to a key
* @author David Turanski
* @since 2.2
*/
public class SpELItemKeyMapper<K,V> implements Converter<V,K> {
private final ExpressionParser parser = new SpelExpressionParser();
private final Expression parsedExpression;
public SpELItemKeyMapper(String keyExpression) {
parsedExpression = parser.parseExpression(keyExpression);
}
/* (non-Javadoc)
* @see org.springframework.batch.item.ItemKeyMapper#mapKey(java.lang.Object)
*/
@SuppressWarnings("unchecked")
@Override
public K convert(V item) {
return (K) parsedExpression.getValue(item);
}
}

View File

@@ -0,0 +1,55 @@
/*
* Copyright 2002-2013 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.data;
import org.springframework.batch.item.KeyValueItemWriter;
import org.springframework.data.gemfire.GemfireTemplate;
import org.springframework.util.Assert;
/**
* An {@ link ItemWriter} that stores items in GemFire
*
* @author David Turanski
* @since 2.2
*
*/
public class GemfireItemWriter<K,V> extends KeyValueItemWriter<K,V> {
private GemfireTemplate gemfireTemplate;
/**
* @param gemfireTemplate the {@link GemfireTemplate} to set
*/
public void setTemplate(GemfireTemplate gemfireTemplate) {
this.gemfireTemplate = gemfireTemplate;
}
/* (non-Javadoc)
* @see org.springframework.batch.item.KeyValueItemWriter#writeKeyValue(java.lang.Object, java.lang.Object)
*/
@Override
protected void writeKeyValue(K key, V value) {
if (delete) {
gemfireTemplate.remove(key);
} else {
gemfireTemplate.put(key, value);
}
}
/* (non-Javadoc)
* @see org.springframework.batch.item.KeyValueItemWriter#init()
*/
@Override
protected void init() {
Assert.notNull(gemfireTemplate, "A GemfireTemplate is required.");
}
}

View File

@@ -0,0 +1,34 @@
/*
* Copyright 2002-2013 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.data;
import org.springframework.batch.item.SpELItemKeyMapper;
import org.springframework.util.Assert;
/**
* A convenient {@link GemfireItemWriter} implementation that uses a {@ link SpELItemKeyMapper}
*
* @author David Turanski
* @since 2.2
*/
public class SpELMappingGemfireItemWriter<K,V> extends GemfireItemWriter<K, V>{
/**
* A constructor that accepts a SpEL expression used to derive the key
* @param keyExpression
*/
SpELMappingGemfireItemWriter(String keyExpression) {
super();
Assert.hasText(keyExpression,"a valid keyExpression is required.");
setItemKeyMapper(new SpELItemKeyMapper<K, V>(keyExpression));
}
}

View File

@@ -0,0 +1,133 @@
package org.springframework.batch.item.data;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;
import java.util.ArrayList;
import java.util.List;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.batch.item.SpELItemKeyMapper;
import org.springframework.data.gemfire.GemfireTemplate;
import org.springframework.core.convert.converter.Converter;
@SuppressWarnings({ "rawtypes", "serial", "unchecked" })
public class GemfireItemWriterTests {
private GemfireItemWriter writer;
@Mock
private GemfireTemplate template;
//private PlatformTransactionManager transactionManager = new ResourcelessTransactionManager();
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
writer = new GemfireItemWriter();
writer.setTemplate(template);
writer.setItemKeyMapper(new SpELItemKeyMapper<String, Foo>("bar.val"));
writer.afterPropertiesSet();
}
@Test
public void testAfterPropertiesSet() throws Exception {
writer = new GemfireItemWriter();
try {
writer.afterPropertiesSet();
fail("Expected exception was not thrown");
} catch (IllegalArgumentException iae) {
}
writer.setTemplate(template);
try {
writer.afterPropertiesSet();
fail("Expected exception was not thrown");
} catch (IllegalArgumentException iae) {
}
writer.setItemKeyMapper(new SpELItemKeyMapper<Object, Object>("foo"));
writer.afterPropertiesSet();
}
@Test
public void testBasicWrite() throws Exception {
List<Foo> items = new ArrayList<Foo>() {
{
add(new Foo(new Bar("val1")));
add(new Foo(new Bar("val2")));
}
};
writer.write(items);
verify(template).put("val1", items.get(0));
verify(template).put("val2", items.get(1));
}
@Test
public void testBasicDelete() throws Exception {
List<Foo> items = new ArrayList<Foo>() {
{
add(new Foo(new Bar("val1")));
add(new Foo(new Bar("val2")));
}
};
writer.setDelete(true);
writer.write(items);
verify(template).remove("val1");
verify(template).remove("val2");
}
@Test
public void testWriteWithCustomItemKeyMapper() throws Exception {
List<Foo> items = new ArrayList<Foo>() {
{
add(new Foo(new Bar("val1")));
add(new Foo(new Bar("val2")));
}
};
writer = new GemfireItemWriter();
writer.setTemplate(template);
writer.setItemKeyMapper(new Converter<Foo, String>() {
@Override
public String convert(Foo item) {
String index = item.bar.val.replaceAll("val", "");
return "item" + index;
}
});
writer.afterPropertiesSet();
writer.write(items);
verify(template).put("item1", items.get(0));
verify(template).put("item2", items.get(1));
}
@Test
public void testWriteNoTransactionNoItems() throws Exception {
writer.write(null);
verifyZeroInteractions(template);
}
static class Foo {
public Bar bar;
public Foo(Bar bar) {
this.bar = bar;
}
}
static class Bar {
public String val;
public Bar(String b1) {
this.val = b1;
}
}
}

View File

@@ -152,6 +152,11 @@
<name>Apache Foundation Snapshot Repository</name>
<url>http://people.apache.org/maven-snapshot-repository/</url>
</repository>
<repository>
<id>springsource-milestone</id>
<name>SpringSource Milestone Repository</name>
<url>https://repo.springsource.org/libs-milestone/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
@@ -691,8 +696,8 @@
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-commons-core</artifactId>
<version>1.4.0.RC1</version>
<artifactId>spring-data-commons</artifactId>
<version>1.5.0.RELEASE</version>
<optional>true</optional>
</dependency>
<dependency>
@@ -710,7 +715,19 @@
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-neo4j</artifactId>
<version>2.1.0.RELEASE</version>
<version>2.2.0.RELEASE</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-gemfire</artifactId>
<version>1.3.0.M1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-redis</artifactId>
<version>1.0.3.RELEASE</version>
<optional>true</optional>
</dependency>
</dependencies>

View File

@@ -232,7 +232,7 @@
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-commons-core</artifactId>
<artifactId>spring-data-commons</artifactId>
<optional>true</optional>
</dependency>
<dependency>