org.springframework.data.gemfire.mapping

Class MappingPdxSerializer

java.lang.Object

org.springframework.data.gemfire.mapping.MappingPdxSerializer

All Implemented Interfaces:

org.apache.geode.pdx.PdxSerializer, Aware, ApplicationContextAware

public class MappingPdxSerializer
extends Object
implements org.apache.geode.pdx.PdxSerializer, ApplicationContextAware

GemFire PdxSerializer implementation that uses a Spring Data GemFire GemfireMappingContext to read and write entities.

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

ApplicationContext, ApplicationContextAware, ConversionService, EntityInstantiator, PersistentEntity, PersistentPropertyAccessor, PersistentEntityParameterValueProvider, SpELContext, PdxReader, PdxSerializer, PdxWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
MappingPdxSerializer() Creates a new MappingPdxSerializer using the default GemfireMappingContext and DefaultConversionService.
MappingPdxSerializer(GemfireMappingContext mappingContext, ConversionService conversionService) Creates a new MappingPdxSerializer using the given GemfireMappingContext and ConversionService.

Method Summary

Modifier and Type	Method and Description
static MappingPdxSerializer	create(GemfireMappingContext mappingContext, ConversionService conversionService) Factory method to construct a new instance of the MappingPdxSerializer initialized with the given GemfireMappingContext and Spring ConversionService.
Object	fromData(Class<?> type, org.apache.geode.pdx.PdxReader reader)
protected ConversionService	getConversionService()
protected org.apache.geode.pdx.PdxSerializer	getCustomSerializer(Class<?> type) Looks up and returns a custom PdxSerializer based on the class type of the object to (de)serialize.
protected Map<Class<?>,org.apache.geode.pdx.PdxSerializer>	getCustomSerializers()
protected EntityInstantiators	getGemfireInstantiators()
protected EntityInstantiator	getInstantiatorFor(PersistentEntity entity) Looks up and returns an EntityInstantiator to construct and initialize an instance of the object defined by the given PersistentEntity (meta-data).
protected GemfireMappingContext	getMappingContext()
protected GemfirePersistentEntity<?>	getPersistentEntity(Class<?> entityType) Looks up and returns the PersistentEntity meta-data for the given entity Class type.
protected GemfirePersistentEntity<?>	getPersistentEntity(Object entity) Looks up and returns the PersistentEntity meta-data for the given entity object.
void	setApplicationContext(ApplicationContext applicationContext)
void	setCustomSerializers(Map<Class<?>,org.apache.geode.pdx.PdxSerializer> customSerializers) Configures custom PDX serializers to use for specific class types.
void	setGemfireInstantiators(Map<Class<?>,EntityInstantiator> gemfireInstantiators) Configures the EntityInstantiators used to create the instances read by this PdxSerializer.
boolean	toData(Object value, org.apache.geode.pdx.PdxWriter writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

MappingPdxSerializer

public MappingPdxSerializer()

Creates a new MappingPdxSerializer using the default GemfireMappingContext and DefaultConversionService.

See Also:

DefaultConversionService, GemfireMappingContext

MappingPdxSerializer

public MappingPdxSerializer(GemfireMappingContext mappingContext,
                            ConversionService conversionService)

Creates a new MappingPdxSerializer using the given GemfireMappingContext and ConversionService.

Parameters:

mappingContext - must not be null.

conversionService - must not be null.

Method Detail

create

public static MappingPdxSerializer create(GemfireMappingContext mappingContext,
                                          ConversionService conversionService)

Factory method to construct a new instance of the MappingPdxSerializer initialized with the given GemfireMappingContext and Spring ConversionService. If either the GemfireMappingContext or Spring ConversionService are null, then this factory method will construct default instances of each.

Parameters:

mappingContext - GemfireMappingContext used by this PdxSerializer to handle mappings between application domain object types and PDX Serialization meta-data/data.

conversionService - Spring's ConversionService used to convert PDX deserialized data to application object property types.

Returns:

an initialized instance of the MappingPdxSerializer.

See Also:

ConversionService, MappingPdxSerializer

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getConversionService

protected ConversionService getConversionService()

setCustomSerializers

public void setCustomSerializers(Map<Class<?>,org.apache.geode.pdx.PdxSerializer> customSerializers)

Configures custom PDX serializers to use for specific class types.

Parameters:

customSerializers - a mapping of domain object class types and their corresponding PDX serializer.

getCustomSerializers

protected Map<Class<?>,org.apache.geode.pdx.PdxSerializer> getCustomSerializers()

setGemfireInstantiators

public void setGemfireInstantiators(Map<Class<?>,EntityInstantiator> gemfireInstantiators)

Configures the EntityInstantiators used to create the instances read by this PdxSerializer.

Parameters:

gemfireInstantiators - must not be null.

getGemfireInstantiators

protected EntityInstantiators getGemfireInstantiators()

getMappingContext

protected GemfireMappingContext getMappingContext()

fromData

public Object fromData(Class<?> type,
                       org.apache.geode.pdx.PdxReader reader)

Specified by:

fromData in interface org.apache.geode.pdx.PdxSerializer

toData

public boolean toData(Object value,
                      org.apache.geode.pdx.PdxWriter writer)

Specified by:

toData in interface org.apache.geode.pdx.PdxSerializer

getCustomSerializer

protected org.apache.geode.pdx.PdxSerializer getCustomSerializer(Class<?> type)

Looks up and returns a custom PdxSerializer based on the class type of the object to (de)serialize.

Parameters:

type - the Class type of the object to (de)serialize.

Returns:

a "custom" PdxSerializer for the given class type or null if no custom PdxSerializer for the given class type was registered.

See Also:

getCustomSerializers(), PdxSerializer

getInstantiatorFor

protected EntityInstantiator getInstantiatorFor(PersistentEntity entity)

Looks up and returns an EntityInstantiator to construct and initialize an instance of the object defined by the given PersistentEntity (meta-data).

Parameters:

entity - the PersistentEntity object used to lookup the custom EntityInstantiator.

Returns:

an EntityInstantiator for the given PersistentEntity.

See Also:

EntityInstantiator, PersistentEntity

getPersistentEntity

protected GemfirePersistentEntity<?> getPersistentEntity(Object entity)

Looks up and returns the PersistentEntity meta-data for the given entity object.

Parameters:

entity - actual persistent entity, application domain object.

Returns:

the PersistentEntity meta-data for the given entity object.

See Also:

GemfirePersistentEntity, getPersistentEntity(Class)

getPersistentEntity

protected GemfirePersistentEntity<?> getPersistentEntity(Class<?> entityType)

Looks up and returns the PersistentEntity meta-data for the given entity Class type.

Parameters:

entityType - Class type of the actual persistent entity, application domain object Class.

Returns:

the PersistentEntity meta-data for the given entity Class type.

See Also:

GemfirePersistentEntity, getMappingContext()