org.springframework.data.gemfire.mapping

Class MappingPdxSerializer

java.lang.Object

org.springframework.data.gemfire.mapping.MappingPdxSerializer

All Implemented Interfaces:

com.gemstone.gemfire.pdx.PdxSerializer, Aware, ApplicationContextAware

public class MappingPdxSerializer
extends Object
implements com.gemstone.gemfire.pdx.PdxSerializer, ApplicationContextAware

GemFire PdxSerializer implementation using the Spring Data GemFire GemfireMappingContext to read and write entities from/to GemFire PDX bytes.

Since:

1.2.0

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

PdxReader, PdxSerializer, PdxWriter, ApplicationContext, ApplicationContextAware, ConversionService, EntityInstantiator, PersistentEntity, PersistentProperty, PersistentPropertyAccessor, ConvertingPropertyAccessor, PersistentEntityParameterValueProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappingPdxSerializer.ExcludeAllTypesFilter
static class	MappingPdxSerializer.ExcludeComGemstoneGemFireTypesFilter
static class	MappingPdxSerializer.ExcludeJavaTypesFilter
static class	MappingPdxSerializer.ExcludeNullTypesFilter
static class	MappingPdxSerializer.ExcludeOrgSpringFrameworkTypesFilter

Constructor Summary

Constructors

Constructor and Description
MappingPdxSerializer() Constructs a new instance of MappingPdxSerializer using a default GemfireMappingContext and DefaultConversionService.
MappingPdxSerializer(GemfireMappingContext mappingContext, ConversionService conversionService) Constructs a new instance of MappingPdxSerializer initialized with the given GemfireMappingContext and ConversionService.

Method Summary

Modifier and Type	Method and Description
static MappingPdxSerializer	create(ConversionService conversionService) Factory method used to construct a new instance of MappingPdxSerializer initialized with the given ConversionService and a provided GemfireMappingContext.
static MappingPdxSerializer	create(GemfireMappingContext mappingContext) Factory method used to construct a new instance of MappingPdxSerializer initialized with the given mapping context supplying entity mapping meta-data, using a provided, default ConversionService.
static MappingPdxSerializer	create(GemfireMappingContext mappingContext, ConversionService conversionService) Factory method used to construct a new instance of MappingPdxSerializer initialized with the given mapping context and conversion service.
Object	fromData(Class<?> type, com.gemstone.gemfire.pdx.PdxReader reader)
protected ConversionService	getConversionService() Returns a reference to the configured ConversionService used to convert data store types to application domain object types.
protected com.gemstone.gemfire.pdx.PdxSerializer	getCustomPdxSerializer(PersistentProperty<?> property) Returns a custom PDX serializer for the given entity persistent property.
protected Map<?,com.gemstone.gemfire.pdx.PdxSerializer>	getCustomPdxSerializers() Returns a mapping of application domain types to custom PDX serializers used to customize the serialization for specific application domain types.
protected com.gemstone.gemfire.pdx.PdxSerializer	getCustomSerializer(Class<?> type) Deprecated. please use getCustomPdxSerializer(PersistentProperty) instead.
protected Map<Class<?>,com.gemstone.gemfire.pdx.PdxSerializer>	getCustomSerializers() Deprecated. please use getCustomPdxSerializers() instead.
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 org.slf4j.Logger	getLogger() Returns a reference to the configured Logger used to log messages about the functions of this PdxSerializer.
protected GemfireMappingContext	getMappingContext() Returns a reference to the configured mapping context used to handling mapping logic between GemFire persistent entities and application domain object types.
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.
protected Filter<Class<?>>	getTypeFilters() Returns the type filters used to filter types serializable by this PdxSerializer.
static MappingPdxSerializer	newMappingPdxSerializer() Factory method used to construct a new instance of MappingPdxSerializer initialized with a provided GemfireMappingContext and default ConversionService.
void	setApplicationContext(ApplicationContext applicationContext)
void	setCustomPdxSerializers(Map<?,com.gemstone.gemfire.pdx.PdxSerializer> customPdxSerializers) Configures custom PDX serializers used to customize the serialization for specific application domain types.
void	setCustomSerializers(Map<Class<?>,com.gemstone.gemfire.pdx.PdxSerializer> customSerializers) Deprecated. please use (setCustomPdxSerializers(Map) instead.
void	setExcludeTypeFilters(Filter<Class<?>> typeFilters) Sets the type filters used to exclude or filter types serializable by this PDX serializer.
void	setGemfireInstantiators(EntityInstantiators entityInstantiators) Configures the EntityInstantiators used to create the instances read by this PdxSerializer.
void	setGemfireInstantiators(Map<Class<?>,EntityInstantiator> gemfireInstantiators) Configures the EntityInstantiators used to create the instances read by this PdxSerializer.
void	setIncludeTypeFilters(Filter<Class<?>> typeFilters) Sets the type filters used to include or filter types serializable by this PDX serializer.
boolean	toData(Object value, com.gemstone.gemfire.pdx.PdxWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingPdxSerializer

public MappingPdxSerializer()

Constructs a new instance of MappingPdxSerializer using a default GemfireMappingContext and DefaultConversionService.

See Also:

newConversionService(), newMappingContext(), DefaultConversionService, GemfireMappingContext

MappingPdxSerializer

public MappingPdxSerializer(GemfireMappingContext mappingContext,
                            ConversionService conversionService)

Constructs a new instance of MappingPdxSerializer initialized with the given GemfireMappingContext and ConversionService.

Parameters:

mappingContext - GemfireMappingContext used by the MappingPdxSerializer to map between application domain object types and PDX serialized bytes based on the entity mapping meta-data.

conversionService - ConversionService used by the MappingPdxSerializer to convert PDX serialized data to application object property types.

Throws:

IllegalArgumentException - if either the GemfireMappingContext or the ConversionService is null.

Method Detail

newMappingPdxSerializer

public static MappingPdxSerializer newMappingPdxSerializer()

Factory method used to construct a new instance of MappingPdxSerializer initialized with a provided GemfireMappingContext and default ConversionService.

Returns:

a new instance of MappingPdxSerializer.

See Also:

create(GemfireMappingContext, ConversionService), newMappingContext(), newConversionService()

create

public static MappingPdxSerializer create(ConversionService conversionService)

Factory method used to construct a new instance of MappingPdxSerializer initialized with the given ConversionService and a provided GemfireMappingContext.

Parameters:

conversionService - ConversionService used to convert persistent values to entity properties.

Returns:

a new instance of MappingPdxSerializer initialized with the given ConversionService.

See Also:

ConversionService, create(GemfireMappingContext, ConversionService), newMappingContext()

create

public static MappingPdxSerializer create(GemfireMappingContext mappingContext)

Factory method used to construct a new instance of MappingPdxSerializer initialized with the given mapping context supplying entity mapping meta-data, using a provided, default ConversionService.

Parameters:

mappingContext - GemfireMappingContext used to supply entity mapping meta-data.

Returns:

a new instance of MappingPdxSerializer initialized with the given mapping context.

See Also:

GemfireMappingContext, create(GemfireMappingContext, ConversionService), newConversionService()

create

public static MappingPdxSerializer create(GemfireMappingContext mappingContext,
                                          ConversionService conversionService)

Factory method used to construct a new instance of MappingPdxSerializer initialized with the given mapping context and conversion service. If either the mapping context or the conversion service are null, then this factory method will provide default instances for each.

Parameters:

mappingContext - GemfireMappingContext used to map between application domain model object types and PDX serialized bytes based on the entity's mapping meta-data.

conversionService - ConversionService used to convert persistent values to entity properties.

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()

Returns a reference to the configured ConversionService used to convert data store types to application domain object types.

Returns:

a reference to the configured ConversionService.

See Also:

ConversionService

setCustomPdxSerializers

public void setCustomPdxSerializers(Map<?,com.gemstone.gemfire.pdx.PdxSerializer> customPdxSerializers)

Configures custom PDX serializers used to customize the serialization for specific application domain types.

Parameters:

customPdxSerializers - mapping containing custom PDX serializers used to customize the serialization of specific application domain types.

Throws:

IllegalArgumentException - if the custom PDX serializer mapping is null.

See Also:

PdxSerializer, Map

setCustomSerializers

@Deprecated
public void setCustomSerializers(Map<Class<?>,com.gemstone.gemfire.pdx.PdxSerializer> customSerializers)

Deprecated. please use (setCustomPdxSerializers(Map) instead.

getCustomPdxSerializers

protected Map<?,com.gemstone.gemfire.pdx.PdxSerializer> getCustomPdxSerializers()

Returns a mapping of application domain types to custom PDX serializers used to customize the serialization for specific application domain types.

Returns:

a mapping of application domain types to custom PDX serializers.

See Also:

PdxSerializer, Map

getCustomSerializers

@Deprecated
protected Map<Class<?>,com.gemstone.gemfire.pdx.PdxSerializer> getCustomSerializers()

Deprecated. please use getCustomPdxSerializers() instead.

getCustomPdxSerializer

protected com.gemstone.gemfire.pdx.PdxSerializer getCustomPdxSerializer(PersistentProperty<?> property)

Returns a custom PDX serializer for the given entity persistent property.

Parameters:

property - PersistentProperty of the entity used to lookup the custom PDX serializer.

Returns:

a custom PdxSerializer for the given entity PersistentProperty, or null if no custom PdxSerializer could be found.

See Also:

PdxSerializer

getCustomSerializer

@Deprecated
protected com.gemstone.gemfire.pdx.PdxSerializer getCustomSerializer(Class<?> type)

Deprecated. please use getCustomPdxSerializer(PersistentProperty) instead.

setGemfireInstantiators

public void setGemfireInstantiators(EntityInstantiators entityInstantiators)

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

Parameters:

entityInstantiators - EntityInstantiators used to create the instances read by this PdxSerializer; must not be null.

See Also:

EntityInstantiator

setGemfireInstantiators

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

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

Parameters:

gemfireInstantiators - mapping of types to EntityInstantiator objects; must not be null.

See Also:

EntityInstantiator, >>>>>>> 3ed1599... SGF-745 - Add ability to filter types de/serialized by the o.s.d.g.mapping.MappingPdxSerializer.

getGemfireInstantiators

protected EntityInstantiators getGemfireInstantiators()

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

getLogger

protected org.slf4j.Logger getLogger()

Returns a reference to the configured Logger used to log messages about the functions of this PdxSerializer.

Returns:

a reference to the configured Logger.

See Also:

Log

getMappingContext

protected GemfireMappingContext getMappingContext()

Returns a reference to the configured mapping context used to handling mapping logic between GemFire persistent entities and application domain object types.

Returns:

a reference to the configured mapping context for Pivotal GemFire.

See Also:

GemfireMappingContext

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()

setExcludeTypeFilters

public void setExcludeTypeFilters(Filter<Class<?>> typeFilters)

Sets the type filters used to exclude or filter types serializable by this PDX serializer. This operation is null-safe and rather than overriding the existing type filters, this set operation combines the given type filters with the exiting type filters joined by and.

Parameters:

typeFilters - type filters used to to exclude types serializable by this PDX serializer.

See Also:

Filter

setIncludeTypeFilters

public void setIncludeTypeFilters(Filter<Class<?>> typeFilters)

Sets the type filters used to include or filter types serializable by this PDX serializer. This operation is null-safe and rather than overriding the existing type filters, this set operation combines the given type filters with the exiting type filters joined by or.

Parameters:

typeFilters - type filters used to to include types serializable by this PDX serializer.

See Also:

Filter

getTypeFilters

protected Filter<Class<?>> getTypeFilters()

Returns the type filters used to filter types serializable by this PdxSerializer.

Returns:

the resolved type filter.

See Also:

Filter

fromData

public Object fromData(Class<?> type,
                       com.gemstone.gemfire.pdx.PdxReader reader)

Specified by:

fromData in interface com.gemstone.gemfire.pdx.PdxSerializer

toData

public boolean toData(Object value,
                      com.gemstone.gemfire.pdx.PdxWriter writer)

Specified by:

toData in interface com.gemstone.gemfire.pdx.PdxSerializer