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

PdxSerializer implementation using the Spring Data for Apache Geode GemfireMappingContext to read (deserialize) and write (serialize) entities from and to PDX.

Since:

1.2.0

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MappingPdxSerializer.PdxSerializerResolver
static class	MappingPdxSerializer.PdxSerializerResolvers
static class	MappingPdxSerializer.TypeFilters

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COM_GEMSTONE_GEMFIRE_PACKAGE_NAME
protected static String	JAVA_PACKAGE_NAME
protected static String	ORG_APACHE_GEODE_PACKAGE_NAME
protected static String	ORG_SPRINGFRAMEWORK_PACKAGE_NAME

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, org.apache.geode.pdx.PdxReader pdxReader) Deserializes (reads) an Object of type from PDX using the PdxReader.
protected ConversionService	getConversionService() Returns a reference to the configured ConversionService used to convert data store types to application domain object types.
protected Map<?,org.apache.geode.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 EntityInstantiators	getEntityInstantiators() Returns the configured EntityInstantiators handling instantiation for GemFire persistent entities.
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 Predicate<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	register(MappingPdxSerializer.PdxSerializerResolver pdxSerializerResolver) Registers the given MappingPdxSerializer.PdxSerializerResolver, which will be used to resolve a custom PdxSerializer for a entity property.
protected org.apache.geode.pdx.PdxSerializer	resolveCustomPdxSerializer(PersistentProperty<?> property) Returns a custom PdxSerializer for the given PersistentEntity PersistentProperty.
protected EntityInstantiator	resolveEntityInstantiator(PersistentEntity entity) Looks up and returns a registered EntityInstantiator used to construct and initialize an instance of an object defined by the given PersistentEntity (meta-data).
void	setApplicationContext(ApplicationContext applicationContext) Configures a reference to the Spring ApplicationContext.
void	setCustomPdxSerializers(Map<?,org.apache.geode.pdx.PdxSerializer> customPdxSerializers) Configures custom PDX serializers used to customize the serialization for specific application domain types.
void	setEntityInstantiators(EntityInstantiators entityInstantiators) Configures the EntityInstantiators used to create the instances read by this PdxSerializer.
void	setEntityInstantiators(Map<Class<?>,EntityInstantiator> gemfireInstantiators) Configures the EntityInstantiators used to create the instances read by this PdxSerializer.
void	setExcludeTypeFilters(Predicate<Class<?>> excludeTypeFilters) Sets the type filters used to exclude (a.k.a. filter) types serializable by this PDX serializer.
void	setIncludeTypeFilters(Predicate<Class<?>> includeTypeFilters) Sets the type filters used to include types serializable by this PDX serializer.
boolean	toData(Object value, org.apache.geode.pdx.PdxWriter pdxWriter) Serialize (write) the given Object to PDX.

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_PACKAGE_NAME

protected static final String JAVA_PACKAGE_NAME

See Also:

Constant Field Values

COM_GEMSTONE_GEMFIRE_PACKAGE_NAME

protected static final String COM_GEMSTONE_GEMFIRE_PACKAGE_NAME

See Also:

Constant Field Values

ORG_APACHE_GEODE_PACKAGE_NAME

protected static final String ORG_APACHE_GEODE_PACKAGE_NAME

See Also:

Constant Field Values

ORG_SPRINGFRAMEWORK_PACKAGE_NAME

protected static final String ORG_SPRINGFRAMEWORK_PACKAGE_NAME

See Also:

Constant Field Values

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

@NonNull
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

@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   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

@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   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

@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   GemfireMappingContext mappingContext,
                                                   @Nullable
                                                   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

Configures a reference to the Spring ApplicationContext.

Specified by:

setApplicationContext in interface ApplicationContextAware

Parameters:

applicationContext - reference to the Spring ApplicationContext.

Throws:

BeansException

See Also:

ApplicationContext

getConversionService

@NonNull
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<?,org.apache.geode.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

getCustomPdxSerializers

@NonNull
protected Map<?,org.apache.geode.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

setEntityInstantiators

public void setEntityInstantiators(@NonNull
                                   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

setEntityInstantiators

public void setEntityInstantiators(@NonNull
                                   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, Map

getEntityInstantiators

protected EntityInstantiators getEntityInstantiators()

Returns the configured EntityInstantiators handling instantiation for GemFire persistent entities.

Returns:

the configured EntityInstantiators handling instantiation for GemFire persistent entities.

See Also:

EntityInstantiators

getLogger

@NonNull
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:

Logger

getMappingContext

@NonNull
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(@NonNull
                                                         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(@NonNull
                                                         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(@Nullable
                                  Predicate<Class<?>> excludeTypeFilters)

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

Parameters:

excludeTypeFilters - type filters used to exclude/filter types serializable by this PDX serializer.

See Also:

Predicate

setIncludeTypeFilters

public void setIncludeTypeFilters(@Nullable
                                  Predicate<Class<?>> includeTypeFilters)

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

Parameters:

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

See Also:

Predicate

getTypeFilters

protected Predicate<Class<?>> getTypeFilters()

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

Returns:

the resolved type filter.

See Also:

Predicate

register

public void register(@NonNull
                     MappingPdxSerializer.PdxSerializerResolver pdxSerializerResolver)

Registers the given MappingPdxSerializer.PdxSerializerResolver, which will be used to resolve a custom PdxSerializer for a entity property. The strategy, or criteria used to resolve the custom PdxSerializer is up to the individual resolve and can be based on things like the property type, or fully-qualified property name, etc.

Parameters:

pdxSerializerResolver - MappingPdxSerializer.PdxSerializerResolver used to resolve a custom PdxSerializer for a entity property.

fromData

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

Deserializes (reads) an Object of type from PDX using the PdxReader.

Specified by:

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

Parameters:

type - desired Class type of the Object; must not be null.

pdxReader - PdxReader used to deserialize the PDX bytes back into an Object of the desired Class type; must not be null.

Returns:

an Object of Class type deserialized from PDX or null if an Object of Class type cannot be deserialized from PDX.

See Also:

PdxReader, doFromData(Class, PdxReader), getTypeFilters(), Class, Object

toData

public boolean toData(@Nullable
                      Object value,
                      @NonNull
                      org.apache.geode.pdx.PdxWriter pdxWriter)

Serialize (write) the given Object to PDX.

Specified by:

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

Parameters:

value - Object to serialize.

pdxWriter - PdxWriter used to serialize the given Object to PDX.

Returns:

a boolean value indicating whether this PdxSerializer was able to serialize the given Object to PDX.

See Also:

PdxWriter, doToData(Object, PdxWriter), getTypeFilters(), Object

resolveCustomPdxSerializer

@Nullable
protected org.apache.geode.pdx.PdxSerializer resolveCustomPdxSerializer(@NonNull
                                                                                  PersistentProperty<?> property)

Returns a custom PdxSerializer for the given PersistentEntity PersistentProperty.

Parameters:

property - PersistentProperty of the entity used to resolve a custom PdxSerializer.

Returns:

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

See Also:

PersistentProperty, PdxSerializer, getCustomPdxSerializers()

resolveEntityInstantiator

protected EntityInstantiator resolveEntityInstantiator(@NonNull
                                                       PersistentEntity entity)

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

Parameters:

entity - PersistentEntity object used to lookup a custom, registered EntityInstantiator for the entity.

Returns:

an EntityInstantiator for the given PersistentEntity.

See Also:

EntityInstantiator, PersistentEntity