Skip to content

Commit

Permalink
DATAKV-87 - Polished implementation of configurability of Map type on…
Browse files Browse the repository at this point in the history
… @EnableMapRepositories.

Removed the MapKeyValueAdapterFactory in favor of using instantiating MapKeyValueAdapters directly. Reverted additional hook in KeyValueRepositoryConfigurationExtension as we now rather use inner bean definitions.

Original pull request: #2.
  • Loading branch information
odrotbohm committed Dec 5, 2014
1 parent b16a454 commit bc88cb4
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 332 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
import java.util.Collections;
import java.util.Map;

import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.keyvalue.core.KeyValueAdapter;
import org.springframework.data.keyvalue.core.mapping.context.KeyValueMappingContext;
import org.springframework.data.keyvalue.repository.KeyValueRepository;
import org.springframework.data.keyvalue.repository.query.SpelQueryCreator;
Expand Down Expand Up @@ -136,32 +136,20 @@ public void registerBeansForRoot(BeanDefinitionRegistry registry, RepositoryConf
if (getDefaultKeyValueTemplateRef().equals(keyValueTemplateName)
&& !registry.containsBeanDefinition(keyValueTemplateName)) {

registerTemplateInfrastructure(registry, configurationSource);
RootBeanDefinition beanDefinition = getDefaultKeyValueTemplateBeanDefinition(configurationSource);
AbstractBeanDefinition beanDefinition = getDefaultKeyValueTemplateBeanDefinition(configurationSource);

if (beanDefinition != null) {
registerIfNotAlreadyRegistered(beanDefinition, registry, keyValueTemplateName, configurationSource.getSource());
}
}
}

/**
* Register infrastructure components such as {@link KeyValueAdapter} required for default template.
*
* @param registry
* @param configurationSource
*/
protected void registerTemplateInfrastructure(BeanDefinitionRegistry registry,
RepositoryConfigurationSource configurationSource) {
// nothing to register by default
}

/**
* Get the default {@link RootBeanDefinition} for {@link org.springframework.data.keyvalue.core.KeyValueTemplate}.
*
* @return {@literal null} to explicitly not register a template.
*/
protected RootBeanDefinition getDefaultKeyValueTemplateBeanDefinition(
protected AbstractBeanDefinition getDefaultKeyValueTemplateBeanDefinition(
RepositoryConfigurationSource configurationSource) {
return null;
}
Expand Down
59 changes: 40 additions & 19 deletions src/main/java/org/springframework/data/map/MapKeyValueAdapter.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,30 +34,51 @@
*/
public class MapKeyValueAdapter extends AbstractKeyValueAdapter {

private final Map<Serializable, Map<Serializable, Object>> data;

@SuppressWarnings("rawtypes")//
private final Class<? extends Map> mapType;
private final Class<? extends Map> keySpaceMapType;
private final Map<Serializable, Map<Serializable, Object>> store;

/**
* Create new instance of {@link MapKeyValueAdapter} using {@link ConcurrentHashMap}.
* Create new {@link MapKeyValueAdapter} using {@link ConcurrentHashMap} as backing store type.
*/
public MapKeyValueAdapter() {
this(new ConcurrentHashMap<Serializable, Map<Serializable, Object>>());
this(ConcurrentHashMap.class);
}

/**
* Creates a new {@link MapKeyValueAdapter} using the given {@link Map} as backing store.
*
* @param mapType must not be {@literal null}.
*/
@SuppressWarnings("rawtypes")
public MapKeyValueAdapter(Class<? extends Map> mapType) {
this(CollectionFactory.<Serializable, Map<Serializable, Object>> createMap(mapType, 100), mapType);
}

/**
* Create new instance of {@link MapKeyValueAdapter} using given dataStore for persistence.
*
* @param dataStore must not be {@literal null}.
* @param store must not be {@literal null}.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public MapKeyValueAdapter(Map<Serializable, Map<Serializable, Object>> dataStore) {
public MapKeyValueAdapter(Map<Serializable, Map<Serializable, Object>> store) {
this(store, (Class<? extends Map>) ClassUtils.getUserClass(store));
}

/**
* Creates a new {@link MapKeyValueAdapter} with the given store and type to be used when creating key spaces.
*
* @param store must not be {@literal null}.
* @param keySpaceMapType must not be {@literal null}.
*/
@SuppressWarnings("rawtypes")
private MapKeyValueAdapter(Map<Serializable, Map<Serializable, Object>> store, Class<? extends Map> keySpaceMapType) {

Assert.notNull(dataStore, "Cannot initilalize adapter with 'null' datastore.");
Assert.notNull(store, "Store must not be null.");
Assert.notNull(keySpaceMapType, "Map type to be used for key spaces must not be null!");

this.data = dataStore;
this.mapType = (Class<? extends Map>) ClassUtils.getUserClass(dataStore);
this.store = store;
this.keySpaceMapType = keySpaceMapType;
}

/*
Expand All @@ -67,8 +88,8 @@ public MapKeyValueAdapter(Map<Serializable, Map<Serializable, Object>> dataStore
@Override
public Object put(Serializable id, Object item, Serializable keyspace) {

Assert.notNull(id, "Cannot add item with 'null' id.");
Assert.notNull(keyspace, "Cannot add item for 'null' collection.");
Assert.notNull(id, "Cannot add item with null id.");
Assert.notNull(keyspace, "Cannot add item for null collection.");

return getKeySpaceMap(keyspace).put(id, item);
}
Expand All @@ -89,7 +110,7 @@ public boolean contains(Serializable id, Serializable keyspace) {
@Override
public Object get(Serializable id, Serializable keyspace) {

Assert.notNull(id, "Cannot get item with 'null' id.");
Assert.notNull(id, "Cannot get item with null id.");
return getKeySpaceMap(keyspace).get(id);
}

Expand All @@ -100,7 +121,7 @@ public Object get(Serializable id, Serializable keyspace) {
@Override
public Object delete(Serializable id, Serializable keyspace) {

Assert.notNull(id, "Cannot delete item with 'null' id.");
Assert.notNull(id, "Cannot delete item with null id.");
return getKeySpaceMap(keyspace).remove(id);
}

Expand Down Expand Up @@ -128,7 +149,7 @@ public void deleteAllOf(Serializable keyspace) {
*/
@Override
public void clear() {
data.clear();
store.clear();
}

/*
Expand All @@ -148,19 +169,19 @@ public void destroy() throws Exception {
*/
protected Map<Serializable, Object> getKeySpaceMap(Serializable keyspace) {

Assert.notNull(keyspace, "Collection must not be 'null' for lookup.");
Assert.notNull(keyspace, "Collection must not be null for lookup.");

Map<Serializable, Object> map = data.get(keyspace);
Map<Serializable, Object> map = store.get(keyspace);

if (map != null) {
return map;
}

addMapForKeySpace(keyspace);
return data.get(keyspace);
return store.get(keyspace);
}

private void addMapForKeySpace(Serializable keyspace) {
data.put(keyspace, CollectionFactory.<Serializable, Object> createMap(mapType, 1000));
store.put(keyspace, CollectionFactory.<Serializable, Object> createMap(keySpaceMapType, 1000));
}
}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@
import java.util.concurrent.ConcurrentHashMap;

import org.springframework.beans.factory.FactoryBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Import;
import org.springframework.data.keyvalue.core.KeyValueOperations;
import org.springframework.data.keyvalue.core.KeyValueTemplate;
import org.springframework.data.keyvalue.repository.config.QueryCreatorType;
import org.springframework.data.keyvalue.repository.query.SpelQueryCreator;
import org.springframework.data.keyvalue.repository.support.KeyValueRepositoryFactoryBean;
Expand Down Expand Up @@ -126,7 +128,9 @@

/**
* Configures the {@link Map} structure used for data storage. Defaults to {@link ConcurrentHashMap}. Will be ignored
* in favor of existing {@link KeyValueOperations} definition.
* in case an explicit bean for the {@link KeyValueTemplate} is available in the {@link ApplicationContext}.
*
* @see #keyValueTemplateRef()
*/
@SuppressWarnings("rawtypes")
Class<? extends Map> mapType() default ConcurrentHashMap.class;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,14 @@

import java.util.Map;

import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConstructorArgumentValues;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.config.ParsingUtils;
import org.springframework.data.keyvalue.core.KeyValueTemplate;
import org.springframework.data.keyvalue.repository.config.KeyValueRepositoryConfigurationExtension;
import org.springframework.data.map.MapKeyValueAdapter;
import org.springframework.data.map.MapKeyValueAdapterFactory;
import org.springframework.data.repository.config.RepositoryConfigurationSource;

/**
Expand Down Expand Up @@ -67,43 +64,24 @@ protected String getDefaultKeyValueTemplateRef() {
* @see org.springframework.data.keyvalue.repository.config.KeyValueRepositoryConfigurationExtension#getDefaultKeyValueTemplateBeanDefinition()
*/
@Override
protected RootBeanDefinition getDefaultKeyValueTemplateBeanDefinition(
protected AbstractBeanDefinition getDefaultKeyValueTemplateBeanDefinition(
RepositoryConfigurationSource configurationSource) {

ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
BeanDefinitionBuilder adapterBuilder = BeanDefinitionBuilder.rootBeanDefinition(MapKeyValueAdapter.class);
adapterBuilder.addConstructorArgValue(getMapTypeToUse(configurationSource));

GenericBeanDefinition referencingMapKeyValueAdapterBeanDefintion = new GenericBeanDefinition();
referencingMapKeyValueAdapterBeanDefintion.setBeanClass(MapKeyValueAdapter.class);
referencingMapKeyValueAdapterBeanDefintion.setAutowireMode(AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE);
BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(KeyValueTemplate.class);
builder
.addConstructorArgValue(ParsingUtils.getSourceBeanDefinition(adapterBuilder, configurationSource.getSource()));
builder.setRole(BeanDefinition.ROLE_SUPPORT);

constructorArgumentValues.addGenericArgumentValue(referencingMapKeyValueAdapterBeanDefintion);

RootBeanDefinition keyValueTemplateDefinition = new RootBeanDefinition(KeyValueTemplate.class);
keyValueTemplateDefinition.setConstructorArgumentValues(constructorArgumentValues);
keyValueTemplateDefinition.setRole(BeanDefinition.ROLE_APPLICATION);

return keyValueTemplateDefinition;
return ParsingUtils.getSourceBeanDefinition(builder, configurationSource.getSource());
}

@Override
@SuppressWarnings({ "unchecked", "rawtypes" })
protected void registerTemplateInfrastructure(BeanDefinitionRegistry registry,
RepositoryConfigurationSource configurationSource) {

Class<? extends Map> type = (Class<? extends Map>) ((AnnotationMetadata) configurationSource.getSource())
.getAnnotationAttributes(EnableMapRepositories.class.getName()).get("mapType");

ConstructorArgumentValues mapAdapterFactoryArgs = new ConstructorArgumentValues();
mapAdapterFactoryArgs.addGenericArgumentValue(type);
RootBeanDefinition mapAdapterFactory = new RootBeanDefinition(MapKeyValueAdapterFactory.class,
mapAdapterFactoryArgs, null);

registry.registerBeanDefinition("mapKeyValueAdapterFactory", mapAdapterFactory);

RootBeanDefinition mapKeyValueAdapter = new RootBeanDefinition(MapKeyValueAdapter.class);
mapKeyValueAdapter.setFactoryBeanName("mapKeyValueAdapterFactory");
mapKeyValueAdapter.setFactoryMethodName("getAdapter");
private static Class<? extends Map> getMapTypeToUse(RepositoryConfigurationSource source) {

registry.registerBeanDefinition("mapKeyValueAdapter", mapAdapterFactory);
return (Class<? extends Map>) ((AnnotationMetadata) source.getSource()).getAnnotationAttributes(
EnableMapRepositories.class.getName()).get("mapType");
}
}
Loading

0 comments on commit bc88cb4

Please sign in to comment.