DATACMNS-322 - CdiRepositoryBean implements PassivationCapable.

To allow the CdiRepositoryBeans being used inside scoped CDI beans we need to implement PassivationCapable so that the CDI contain can serialize the bean instance and detect the contextual instance on deserialization. As the repositories are application scoped we simply consider a bean of a given type plus its qualifier annotations unique.

Author: odrotbohm

src/main/java/org/springframework/data/repository/cdi/CdiRepositoryBean.java

@@ -17,9 +17,11 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
 import javax.enterprise.context.ApplicationScoped;
@@ -29,24 +31,27 @@
 import javax.enterprise.inject.spi.Bean;
 import javax.enterprise.inject.spi.BeanManager;
 import javax.enterprise.inject.spi.InjectionPoint;
+import javax.enterprise.inject.spi.PassivationCapable;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
 
 /**
  * Base class for {@link Bean} wrappers.
  * 
  * @author Dirk Mahler
  * @author Oliver Gierke
  */
-public abstract class CdiRepositoryBean<T> implements Bean<T> {
+public abstract class CdiRepositoryBean<T> implements Bean<T>, PassivationCapable {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(CdiRepositoryBean.class);
 
 	private final Set<Annotation> qualifiers;
 	private final Class<T> repositoryType;
 	private final BeanManager beanManager;
+	private final String passivationId;
 
 	/**
 	 * Creates a new {@link CdiRepositoryBean}.
@@ -65,6 +70,30 @@ public CdiRepositoryBean(Set<Annotation> qualifiers, Class<T> repositoryType, Be
 		this.qualifiers = qualifiers;
 		this.repositoryType = repositoryType;
 		this.beanManager = beanManager;
+		this.passivationId = createPassivationId(qualifiers, repositoryType);
+	}
+
+	/**
+	 * Creates a unique identifier for the given repository type and the given annotations.
+	 * 
+	 * @param qualifiers must not be {@literal null} or contain {@literal null} values.
+	 * @param repositoryType must not be {@literal null}.
+	 * @return
+	 */
+	private final String createPassivationId(Set<Annotation> qualifiers, Class<?> repositoryType) {
+
+		List<String> qualifierNames = new ArrayList<String>(qualifiers.size());
+
+		for (Annotation qualifier : qualifiers) {
+			qualifierNames.add(qualifier.annotationType().getName());
+		}
+
+		Collections.sort(qualifierNames);
+
+		StringBuilder builder = new StringBuilder(StringUtils.collectionToDelimitedString(qualifierNames, ":"));
+		builder.append(":").append(repositoryType.getName());
+
+		return builder.toString();
 	}
 
 	/*
@@ -200,6 +229,14 @@ public Class<? extends Annotation> getScope() {
 		return ApplicationScoped.class;
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see javax.enterprise.inject.spi.PassivationCapable#getId()
+	 */
+	public String getId() {
+		return passivationId;
+	}
+
 	/**
 	 * Creates the actual component instance.
 	 * 

src/main/java/org/springframework/data/repository/cdi/CdiRepositoryExtensionSupport.java

@@ -124,13 +124,13 @@ protected Iterable<Entry<Class<?>, Set<Annotation>>> getRepositoryTypes() {
 		return repositoryTypes.entrySet();
 	}
 
-	private static class DefaultAnnotationLiteral extends AnnotationLiteral<Default> implements Default {
+	static class DefaultAnnotationLiteral extends AnnotationLiteral<Default> implements Default {
 
 		private static final long serialVersionUID = 511359421048623933L;
 		private static final DefaultAnnotationLiteral INSTANCE = new DefaultAnnotationLiteral();
 	}
 
-	private static class AnyAnnotationLiteral extends AnnotationLiteral<Any> implements Any {
+	static class AnyAnnotationLiteral extends AnnotationLiteral<Any> implements Any {
 
 		private static final long serialVersionUID = 7261821376671361463L;
 		private static final AnyAnnotationLiteral INSTANCE = new AnyAnnotationLiteral();

src/test/java/org/springframework/data/repository/cdi/CdiRepositoryBeanUnitTests.java

@@ -44,7 +44,11 @@
 @RunWith(MockitoJUnitRunner.class)
 public class CdiRepositoryBeanUnitTests {
 
+	static final String PASSIVATION_ID = "javax.enterprise.inject.Default:org.springframework.data.repository.cdi.CdiRepositoryBeanUnitTests$SampleRepository";
+
 	static final Set<Annotation> NO_ANNOTATIONS = Collections.emptySet();
+	static final Set<Annotation> SINGLE_ANNOTATION = Collections
+			.singleton((Annotation) new CdiRepositoryExtensionSupport.DefaultAnnotationLiteral());
 
 	@Mock
 	BeanManager beanManager;
@@ -110,6 +114,17 @@ public void scopeDefaultsToApplicationScoped() {
 		assertThat(bean.getScope(), equalTo((Class) ApplicationScoped.class));
 	}
 
+	/**
+	 * @see DATACMNS-322
+	 */
+	@Test
+	public void createsPassivationId() {
+
+		CdiRepositoryBean<SampleRepository> bean = new DummyCdiRepositoryBean<SampleRepository>(SINGLE_ANNOTATION,
+				SampleRepository.class, beanManager);
+		assertThat(bean.getId(), is(PASSIVATION_ID));
+	}
+
 	static class DummyCdiRepositoryBean<T> extends CdiRepositoryBean<T> {
 
 		public DummyCdiRepositoryBean(Set<Annotation> qualifiers, Class<T> repositoryType, BeanManager beanManager) {