Package org.springframework.session.data.gemfire.serialization.data.support

Class DataSerializableSessionSerializerInitializer

java.lang.Object

org.springframework.session.data.gemfire.serialization.data.support.DataSerializableSessionSerializerInitializer

All Implemented Interfaces:

org.apache.geode.cache.Declarable

public class DataSerializableSessionSerializerInitializer
extends Object
implements org.apache.geode.cache.Declarable

Register the custom Spring Session DataSerializableSessionSerializer with Apache Geode/Pivotal GemFire's DataSerialization framework as the DataSerializer used to handle de/serialization of the Session, the Session Attributes and any application domain model objects contained in the Session (if necessary).

Since:

2.1.1

See Also:

• Properties
• DataSerializable
• DataSerializer
• Cache
• CacheFactory
• Declarable
• GemFireCache
• Session
• GemFireOperationsSessionRepository
• GemFireHttpSessionConfiguration
• DataSerializableSessionSerializer

Constructor Summary

Constructors

Constructor	Description
DataSerializableSessionSerializerInitializer()	Default constructor used to construct a new, un-initialized instance of DataSerializableSessionSerializerInitializer.
DataSerializableSessionSerializerInitializer(org.apache.geode.cache.GemFireCache gemfireCache)	Constructs a new instance of DataSerializableSessionSerializerInitializer initialized with the given, non-required GemFireCache.

Method Summary

Modifier and Type	Method	Description
protected void	configureUseDataSerialization()	Configures Spring Session (for Apache Geode/Pivotal GemFire) to "use" Apache Geode/Pivotal GemFire's DataSerialization framework and Delta capable DataSerializable Session objects.
void	doInitialization()	Resolves the GemFireCache instance, configures Spring Session (for Apache Geode/Pivotal GemFire) to enable and use the DataSerialization framework and finally, registers the DataSerializers used by Spring Session and required by Apache Geode/Pivotal GemFire to de/serialize the Session objects as DataSerializable types.
protected Optional<org.apache.geode.cache.GemFireCache>	getGemFireCache()	Returns an Optional reference to the GemFireCache.
protected org.slf4j.Logger	getLogger()	Returns a reference to the configured Logger used to capture log events and messages.
void	initialize(org.apache.geode.cache.Cache cache, Properties parameters)
static DataSerializableSessionSerializerInitializer	of(org.apache.geode.cache.GemFireCache gemfireCache)	Factory method used to construct a new instance of DataSerializableSessionSerializerInitializer initialized with the given, non-required GemFireCache.
protected void	registerDataSerializableSessionSerializer()	Registers the DataSerializableSessionSerializer with Apache Geode/Pivotal GemFire in order to properly handle the Spring Session types.
protected org.apache.geode.cache.GemFireCache	resolveGemFireCache()	Resolves a reference to the GemFireCache.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.geode.cache.Declarable

init

Constructor Details

DataSerializableSessionSerializerInitializer

public DataSerializableSessionSerializerInitializer()

Default constructor used to construct a new, un-initialized instance of DataSerializableSessionSerializerInitializer. For use in Apache Geode/Pivotal GemFire cache.xml.

DataSerializableSessionSerializerInitializer

public DataSerializableSessionSerializerInitializer(@Nullable
 org.apache.geode.cache.GemFireCache gemfireCache)

Constructs a new instance of DataSerializableSessionSerializerInitializer initialized with the given, non-required GemFireCache. This constructor is meant to be used programmatically and users are encouraged to provide a reference to the configured and initialized GemFireCache instance if available.

Parameters:

gemfireCache - reference to the GemFireCache instance. GemFireCache may be null in to order to "lazy" initialize or resolve the cache.

See Also:

• GemFireCache

Method Details

of

public static DataSerializableSessionSerializerInitializer of(@Nullable
 org.apache.geode.cache.GemFireCache gemfireCache)

Factory method used to construct a new instance of DataSerializableSessionSerializerInitializer initialized with the given, non-required GemFireCache.

Parameters:

gemfireCache - reference to the GemFireCache instance.

Returns:

a new DataSerializableSessionSerializerInitializer initialized with the given, non-required GemFireCache.

See Also:

• GemFireCache
• DataSerializableSessionSerializerInitializer(GemFireCache)

getGemFireCache

protected Optional<org.apache.geode.cache.GemFireCache> getGemFireCache()

Returns an Optional reference to the GemFireCache. The GemFireCache instance may be resolved lazily when the initialize(Cache, Properties) method is called, such as when processing cache.xml.

Returns:

an Optional reference to the GemFireCache.

See Also:

• GemFireCache
• Optional

getLogger

protected org.slf4j.Logger getLogger()

Returns a reference to the configured Logger used to capture log events and messages.

Returns:

a reference to the configured Logger used for logging.

See Also:

• Logger

initialize

public void initialize(org.apache.geode.cache.Cache cache,
 Properties parameters)

Specified by:

initialize in interface org.apache.geode.cache.Declarable

See Also:

• doInitialization()

doInitialization

public void doInitialization()

Resolves the GemFireCache instance, configures Spring Session (for Apache Geode/Pivotal GemFire) to enable and use the DataSerialization framework and finally, registers the DataSerializers used by Spring Session and required by Apache Geode/Pivotal GemFire to de/serialize the Session objects as DataSerializable types.

See Also:

• resolveGemFireCache()
• configureUseDataSerialization()
• DataSerializableSessionSerializer.register()

resolveGemFireCache

protected org.apache.geode.cache.GemFireCache resolveGemFireCache()

Resolves a reference to the GemFireCache.

Returns:

a resolved reference to the GemFireCache.

Throws:

org.apache.geode.cache.CacheClosedException - if the GemFireCache cannot be resolved.

See Also:

• GemFireCache

registerDataSerializableSessionSerializer

protected void registerDataSerializableSessionSerializer()

Registers the DataSerializableSessionSerializer with Apache Geode/Pivotal GemFire in order to properly handle the Spring Session types.

See Also:

• DataSerializableSessionSerializer.register()

configureUseDataSerialization

protected void configureUseDataSerialization()

Configures Spring Session (for Apache Geode/Pivotal GemFire) to "use" Apache Geode/Pivotal GemFire's DataSerialization framework and Delta capable DataSerializable Session objects.

See Also:

• AbstractGemFireOperationsSessionRepository.DeltaCapableGemFireSession
• AbstractGemFireOperationsSessionRepository.DeltaCapableGemFireSessionAttributes