org.springframework.session.data.gemfire.config.annotation.web.http

Class GemFireHttpSessionConfiguration

java.lang.Object

org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration

org.springframework.session.data.gemfire.config.annotation.web.http.GemFireHttpSessionConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.annotation.ImportAware, org.springframework.context.ApplicationContextAware

@Configuration
public class GemFireHttpSessionConfiguration
extends org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration
implements org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.annotation.ImportAware

The GemFireHttpSessionConfiguration class is a Spring @Configuration class used to configure and initialize Pivotal GemFire/Apache Geode as a clustered, distributed and replicated HttpSession provider implementation in Spring Session.

Since:

1.1.0

See Also:

ExpirationAttributes, GemFireCache, Region, RegionAttributes, RegionShortcut, ClientRegionShortcut, Pool, BeanClassLoaderAware, Bean, Configuration, DependsOn, ImportAware, AnnotationAttributes, AnnotationMetadata, GemfireOperations, GemfireTemplate, IndexFactoryBean, RegionAttributesFactoryBean, Session, SpringHttpSessionConfiguration, GemFireOperationsSessionRepository, EnableGemFireHttpSession, GemFireCacheTypeAwareRegionFactoryBean, SessionAttributesIndexFactoryBean

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.geode.cache.client.ClientRegionShortcut	DEFAULT_CLIENT_REGION_SHORTCUT Default ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state.
static java.lang.String[]	DEFAULT_INDEXABLE_SESSION_ATTRIBUTES Defaults names of all Session attributes that will be indexed by Apache Geode.
static int	DEFAULT_MAX_INACTIVE_INTERVAL_IN_SECONDS Default maximum interval in seconds in which a Session can remain inactive before it expires.
static java.lang.String	DEFAULT_POOL_NAME Name of the connection Pool used by the client Region to send Session state to the cluster of Geode servers.
static org.apache.geode.cache.RegionShortcut	DEFAULT_SERVER_REGION_SHORTCUT Default RegionShortcut used to configure the data management policy of the Cache Region that will store Session state.
static java.lang.String	DEFAULT_SESSION_REGION_NAME Default name of (Client)Cache Region used to store Session state.
static java.lang.String	DEFAULT_SESSION_SERIALIZER_BEAN_NAME
static java.lang.String	SESSION_DATA_SERIALIZER_BEAN_NAME Set of defaults for Session serialization.
static java.lang.String	SESSION_PDX_SERIALIZER_BEAN_NAME
protected static java.lang.Class<java.lang.Object>	SESSION_REGION_KEY_CONSTRAINT Key and Value class type constraints applied to the Session Region.
protected static java.lang.Class<AbstractGemFireOperationsSessionRepository.GemFireSession>	SESSION_REGION_VALUE_CONSTRAINT
static java.lang.String	SESSION_SERIALIZER_BEAN_ALIAS

Constructor Summary

Constructors

Constructor and Description
GemFireHttpSessionConfiguration()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.context.ApplicationContext	getApplicationContext() Returns a reference to the Spring ApplicationContext.
protected java.lang.ClassLoader	getBeanClassLoader() Returns a reference to the ClassLoader used by the Spring container to load bean class types.
protected org.springframework.beans.factory.config.ConfigurableBeanFactory	getBeanFactory() Returns a reference to the Spring container ConfigurableBeanFactory.
protected org.apache.geode.cache.client.ClientRegionShortcut	getClientRegionShortcut() Gets the ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state.
protected java.lang.String[]	getIndexableSessionAttributes() Get the names of all Session attributes that will be indexed.
protected int	getMaxInactiveIntervalInSeconds() Gets the maximum interval in seconds in which a Session can remain inactive before it expires.
protected java.lang.String	getPoolName() Returns the name of the Pool used by the client Region to send Session to the cluster of servers during cache operations.
protected org.apache.geode.cache.RegionShortcut	getServerRegionShortcut() Gets the RegionShortcut used to configure the data management policy of the Cache Region that will store Session state.
protected java.lang.String	getSessionRegionName() Returns the name of the (Client)Cache Region used to store Session state.
protected java.lang.String	getSessionSerializerBeanName() Returns the configured bean name of the Spring bean declared in the Spring application context defining the serialization strategy for serializing the Session.
void	init()
protected boolean	isUsingDataSerialization() Determine whether the configured serialization strategy is using Apache Geode / Pivotal GemFire's DataSerialization framework.
org.springframework.data.gemfire.IndexFactoryBean	principalNameIndex(org.apache.geode.cache.GemFireCache gemfireCache) Defines a GemFire Index bean on the GemFire cache Region storing and managing Sessions, specifically on the 'principalName' property for quick lookup of Sessions by 'principalName'.
SessionAttributesIndexFactoryBean	sessionAttributesIndex(org.apache.geode.cache.GemFireCache gemfireCache) Defines a GemFire Index bean on the GemFire cache Region storing and managing Sessions, specifically on all Session attributes for quick lookup and queries on Session attribute names with a given value.
java.lang.Object	sessionDataSerializer()
java.lang.Object	sessionPdxSerializer()
GemFireCacheTypeAwareRegionFactoryBean<java.lang.Object,org.springframework.session.Session>	sessionRegion(org.apache.geode.cache.GemFireCache gemfireCache, org.apache.geode.cache.RegionAttributes<java.lang.Object,org.springframework.session.Session> sessionRegionAttributes) Defines the Region used to store and manage Session state in either a client-server or peer-to-peer (p2p) topology.
org.springframework.data.gemfire.RegionAttributesFactoryBean	sessionRegionAttributes(org.apache.geode.cache.GemFireCache gemfireCache) Defines a RegionAttributes used to configure and initialize the cache Region used to store Session state.
org.springframework.data.gemfire.GemfireTemplate	sessionRegionTemplate(org.apache.geode.cache.GemFireCache gemfireCache) Defines a GemfireTemplate bean used to interact with the (Client)Cache Region used to store Session state.
GemFireOperationsSessionRepository	sessionRepository(org.springframework.data.gemfire.GemfireOperations gemfireOperations) Defines the SessionRepository bean used to interact with Apache Geode or Pivotal GemFire as the Spring Session provider.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Sets a reference the Spring ApplicationContext.
void	setBeanClassLoader(java.lang.ClassLoader beanClassLoader) Sets a reference to the ClassLoader used by the Spring container to load bean class types.
void	setClientRegionShortcut(org.apache.geode.cache.client.ClientRegionShortcut shortcut) Gets the ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state.
void	setImportMetadata(org.springframework.core.type.AnnotationMetadata importMetadata) Callback with the AnnotationMetadata of the class containing @Import annotation that imported this @Configuration class.
void	setIndexableSessionAttributes(java.lang.String[] indexableSessionAttributes) Sets the names of all Session attributes that will be indexed.
void	setMaxInactiveIntervalInSeconds(int maxInactiveIntervalInSeconds) Sets the maximum interval in seconds in which a Session can remain inactive before it expires.
void	setPoolName(java.lang.String poolName) Sets the name of the Pool used by the client Region to send Session to the cluster of servers during cache operations.
void	setServerRegionShortcut(org.apache.geode.cache.RegionShortcut shortcut) Sets the RegionShortcut used to configure the data management policy of the Cache Region that will store Session state.
void	setSessionRegionName(java.lang.String sessionRegionName) Sets the name of the (Client)Cache Region used to store Session state.
void	setSessionSerializerBeanName(java.lang.String sessionSerializerBeanName) Sets the bean name of the Spring bean declared in the Spring application context defining the serialization strategy for serializing the Session.

Methods inherited from class org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration

sessionEventHttpSessionListenerAdapter, setCookieSerializer, setHttpSessionListeners, setHttpSessionStrategy, setServletContext, springSessionRepositoryFilter

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_INACTIVE_INTERVAL_IN_SECONDS

public static final int DEFAULT_MAX_INACTIVE_INTERVAL_IN_SECONDS

Default maximum interval in seconds in which a Session can remain inactive before it expires.

SESSION_REGION_KEY_CONSTRAINT

protected static final java.lang.Class<java.lang.Object> SESSION_REGION_KEY_CONSTRAINT

Key and Value class type constraints applied to the Session Region.

SESSION_REGION_VALUE_CONSTRAINT

protected static final java.lang.Class<AbstractGemFireOperationsSessionRepository.GemFireSession> SESSION_REGION_VALUE_CONSTRAINT

DEFAULT_CLIENT_REGION_SHORTCUT

public static final org.apache.geode.cache.client.ClientRegionShortcut DEFAULT_CLIENT_REGION_SHORTCUT

Default ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state.

DEFAULT_SERVER_REGION_SHORTCUT

public static final org.apache.geode.cache.RegionShortcut DEFAULT_SERVER_REGION_SHORTCUT

Default RegionShortcut used to configure the data management policy of the Cache Region that will store Session state.

DEFAULT_POOL_NAME

public static final java.lang.String DEFAULT_POOL_NAME

Name of the connection Pool used by the client Region to send Session state to the cluster of Geode servers.

See Also:

Constant Field Values

DEFAULT_SESSION_REGION_NAME

public static final java.lang.String DEFAULT_SESSION_REGION_NAME

Default name of (Client)Cache Region used to store Session state.

See Also:

Constant Field Values

SESSION_DATA_SERIALIZER_BEAN_NAME

public static final java.lang.String SESSION_DATA_SERIALIZER_BEAN_NAME

Set of defaults for Session serialization.

See Also:

Constant Field Values

SESSION_PDX_SERIALIZER_BEAN_NAME

public static final java.lang.String SESSION_PDX_SERIALIZER_BEAN_NAME

See Also:

Constant Field Values

SESSION_SERIALIZER_BEAN_ALIAS

public static final java.lang.String SESSION_SERIALIZER_BEAN_ALIAS

See Also:

Constant Field Values

DEFAULT_SESSION_SERIALIZER_BEAN_NAME

public static final java.lang.String DEFAULT_SESSION_SERIALIZER_BEAN_NAME

See Also:

Constant Field Values

DEFAULT_INDEXABLE_SESSION_ATTRIBUTES

public static final java.lang.String[] DEFAULT_INDEXABLE_SESSION_ATTRIBUTES

Defaults names of all Session attributes that will be indexed by Apache Geode.

Constructor Detail

GemFireHttpSessionConfiguration

public GemFireHttpSessionConfiguration()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Sets a reference the Spring ApplicationContext.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Overrides:

setApplicationContext in class org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration

Parameters:

applicationContext - reference to the Spring ApplicationContext.

Throws:

org.springframework.beans.BeansException - if the reference cannot be stored.

See Also:

ApplicationContext

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

Returns a reference to the Spring ApplicationContext.

Returns:

a reference to the Spring ApplicationContext.

See Also:

ApplicationContext

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)

Sets a reference to the ClassLoader used by the Spring container to load bean class types.

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

Parameters:

beanClassLoader - ClassLoader used by the Spring container to load bean class types.

See Also:

BeanClassLoaderAware.setBeanClassLoader(ClassLoader), ClassLoader

getBeanClassLoader

protected java.lang.ClassLoader getBeanClassLoader()

Returns a reference to the ClassLoader used by the Spring container to load bean class types.

Returns:

the ClassLoader used by the Spring container to load bean class types.

See Also:

ClassLoader

getBeanFactory

protected org.springframework.beans.factory.config.ConfigurableBeanFactory getBeanFactory()

Returns a reference to the Spring container ConfigurableBeanFactory.

Returns:

a reference to the Spring container ConfigurableBeanFactory.

See Also:

ConfigurableBeanFactory, getApplicationContext()

setClientRegionShortcut

public void setClientRegionShortcut(org.apache.geode.cache.client.ClientRegionShortcut shortcut)

Gets the ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state. Defaults to ClientRegionShortcut.PROXY.

Parameters:

shortcut - ClientRegionShortcut used to configure the data management policy of the ClientCache Region.

See Also:

EnableGemFireHttpSession.clientRegionShortcut(), ClientRegionShortcut

getClientRegionShortcut

protected org.apache.geode.cache.client.ClientRegionShortcut getClientRegionShortcut()

Gets the ClientRegionShortcut used to configure the data management policy of the ClientCache Region that will store Session state. Defaults to ClientRegionShortcut.PROXY.

Returns:

the ClientRegionShortcut used to configure the data management policy of the ClientCache Region.

See Also:

ClientRegionShortcut

setIndexableSessionAttributes

public void setIndexableSessionAttributes(java.lang.String[] indexableSessionAttributes)

Sets the names of all Session attributes that will be indexed.

Parameters:

indexableSessionAttributes - an array of Strings containing the names of all Session attributes for which an Index will be created.

See Also:

EnableGemFireHttpSession.indexableSessionAttributes()

getIndexableSessionAttributes

protected java.lang.String[] getIndexableSessionAttributes()

Get the names of all Session attributes that will be indexed.

Returns:

an array of Strings containing the names of all Session attributes for which an Index will be created. Defaults to an empty array if unspecified.

setMaxInactiveIntervalInSeconds

public void setMaxInactiveIntervalInSeconds(int maxInactiveIntervalInSeconds)

Sets the maximum interval in seconds in which a Session can remain inactive before it expires.

Parameters:

maxInactiveIntervalInSeconds - integer value specifying the maximum interval in seconds that a Session can remain inactive before it expires.

See Also:

EnableGemFireHttpSession.maxInactiveIntervalInSeconds()

getMaxInactiveIntervalInSeconds

protected int getMaxInactiveIntervalInSeconds()

Gets the maximum interval in seconds in which a Session can remain inactive before it expires.

Returns:

an integer value specifying the maximum interval in seconds that a Session can remain inactive before it expires.

setPoolName

public void setPoolName(java.lang.String poolName)

Sets the name of the Pool used by the client Region to send Session to the cluster of servers during cache operations.

Parameters:

poolName - String containing the name of a Pool.

See Also:

EnableGemFireHttpSession.poolName()

getPoolName

protected java.lang.String getPoolName()

Returns the name of the Pool used by the client Region to send Session to the cluster of servers during cache operations.

Returns:

a String containing the name of a Pool.

See Also:

Pool.getName()

setServerRegionShortcut

public void setServerRegionShortcut(org.apache.geode.cache.RegionShortcut shortcut)

Sets the RegionShortcut used to configure the data management policy of the Cache Region that will store Session state. Defaults to RegionShortcut.PARTITION.

Parameters:

shortcut - RegionShortcut used to configure the data management policy of the Cache Region.

See Also:

EnableGemFireHttpSession.serverRegionShortcut(), RegionShortcut

getServerRegionShortcut

protected org.apache.geode.cache.RegionShortcut getServerRegionShortcut()

Gets the RegionShortcut used to configure the data management policy of the Cache Region that will store Session state. Defaults to RegionShortcut.PARTITION.

Returns:

the RegionShortcut used to configure the data management policy of the Cache Region.

See Also:

RegionShortcut

setSessionRegionName

public void setSessionRegionName(java.lang.String sessionRegionName)

Sets the name of the (Client)Cache Region used to store Session state.

Parameters:

sessionRegionName - String specifying the name of the (Client)Cache Region used to store Session state.

See Also:

EnableGemFireHttpSession.regionName()

getSessionRegionName

protected java.lang.String getSessionRegionName()

Returns the name of the (Client)Cache Region used to store Session state.

Returns:

a String specifying the name of the (Client)Cache Region used to store Session state.

See Also:

Region.getName()

setSessionSerializerBeanName

public void setSessionSerializerBeanName(java.lang.String sessionSerializerBeanName)

Sets the bean name of the Spring bean declared in the Spring application context defining the serialization strategy for serializing the Session. The serialization strategy and bean referred to by its name must be an implementation of SessionSerializer. Defaults to SessionDataSerializer.

Parameters:

sessionSerializerBeanName - bean name of the SessionSerializer used to serialize the Session.

See Also:

DataSerializableSessionSerializer, SessionSerializer

getSessionSerializerBeanName

protected java.lang.String getSessionSerializerBeanName()

Returns the configured bean name of the Spring bean declared in the Spring application context defining the serialization strategy for serializing the Session. The serialization strategy and bean referred to by its name must be an implementation of SessionSerializer. Defaults to SessionDataSerializer.

Returns:

the bean name of the SessionSerializer used to serialize the Session.

See Also:

DataSerializableSessionSerializer, SessionSerializer

isUsingDataSerialization

protected boolean isUsingDataSerialization()

Determine whether the configured serialization strategy is using Apache Geode / Pivotal GemFire's DataSerialization framework.

Returns:

a boolean value indicating whether the configured serialization strategy is using Apache Geode / Pivotal GemFire's DataSerialization framework.

See Also:

getSessionSerializerBeanName()

setImportMetadata

public void setImportMetadata(org.springframework.core.type.AnnotationMetadata importMetadata)

Callback with the AnnotationMetadata of the class containing @Import annotation that imported this @Configuration class.

Specified by:

setImportMetadata in interface org.springframework.context.annotation.ImportAware

Parameters:

importMetadata - AnnotationMetadata of the application class importing this Configuration class.

See Also:

AnnotationMetadata

init

@PostConstruct
public void init()

Overrides:

init in class org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration

sessionDataSerializer

@Bean(value="SessionDataSerializer")
public java.lang.Object sessionDataSerializer()

sessionPdxSerializer

@Bean(value="SessionPdxSerializer")
public java.lang.Object sessionPdxSerializer()

sessionRegion

@Bean(name="ClusteredSpringSessions")
public GemFireCacheTypeAwareRegionFactoryBean<java.lang.Object,org.springframework.session.Session> sessionRegion(org.apache.geode.cache.GemFireCache gemfireCache,
                                                                                                                                                        @Qualifier(value="sessionRegionAttributes")
                                                                                                                                                        org.apache.geode.cache.RegionAttributes<java.lang.Object,org.springframework.session.Session> sessionRegionAttributes)

Defines the Region used to store and manage Session state in either a client-server or peer-to-peer (p2p) topology.

Parameters:

gemfireCache - reference to the GemFireCache.

sessionRegionAttributes - RegionAttributes used to configure the Region.

Returns:

a GemFireCacheTypeAwareRegionFactoryBean used to configure and initialize the cache Region used to store and manage Session state.

See Also:

GemFireCache, RegionAttributes, getClientRegionShortcut(), getPoolName(), getServerRegionShortcut(), getSessionRegionName()

sessionRegionAttributes

@Bean
public org.springframework.data.gemfire.RegionAttributesFactoryBean sessionRegionAttributes(org.apache.geode.cache.GemFireCache gemfireCache)

Defines a RegionAttributes used to configure and initialize the cache Region used to store Session state. Expiration is also configured for the Region on the basis that the cache Region is a not a proxy on either the client or server.

Parameters:

gemfireCache - reference to the GemFireCache.

Returns:

an instance of RegionAttributes used to configure and initialize cache Region used to store and manage Session state.

See Also:

RegionAttributesFactoryBean, GemFireCache, PartitionAttributes, isExpirationAllowed(GemFireCache)

sessionRegionTemplate

@Bean
 @DependsOn(value="ClusteredSpringSessions")
public org.springframework.data.gemfire.GemfireTemplate sessionRegionTemplate(org.apache.geode.cache.GemFireCache gemfireCache)

Defines a GemfireTemplate bean used to interact with the (Client)Cache Region used to store Session state.

Parameters:

gemfireCache - reference to the single GemFireCache instance used by the GemfireTemplate to perform cache Region data access operations.

Returns:

a GemfireTemplate used to interact with the (Client)Cache Region used to store Session state.

See Also:

GemfireTemplate, GemFireCache, Region, getSessionRegionName()

sessionRepository

@Bean
public GemFireOperationsSessionRepository sessionRepository(@Qualifier(value="sessionRegionTemplate")
                                                                  org.springframework.data.gemfire.GemfireOperations gemfireOperations)

Defines the SessionRepository bean used to interact with Apache Geode or Pivotal GemFire as the Spring Session provider.

Parameters:

gemfireOperations - instance of GemfireOperations used to manage Session state in Apache Geode or Pivotal GemFire.

Returns:

a GemFireOperationsSessionRepository for managing (clustering/replicating) Session state in Apache Geode or Pivotal GemFire.

See Also:

GemFireOperationsSessionRepository, GemfireOperations

principalNameIndex

@Bean
 @DependsOn(value="ClusteredSpringSessions")
public org.springframework.data.gemfire.IndexFactoryBean principalNameIndex(org.apache.geode.cache.GemFireCache gemfireCache)

Defines a GemFire Index bean on the GemFire cache Region storing and managing Sessions, specifically on the 'principalName' property for quick lookup of Sessions by 'principalName'.

Parameters:

gemfireCache - a reference to the GemFire cache.

Returns:

a IndexFactoryBean to create an GemFire Index on the 'principalName' property for Sessions stored in the GemFire cache Region.

See Also:

IndexFactoryBean, GemFireCache

sessionAttributesIndex

@Bean
 @DependsOn(value="ClusteredSpringSessions")
public SessionAttributesIndexFactoryBean sessionAttributesIndex(org.apache.geode.cache.GemFireCache gemfireCache)

Defines a GemFire Index bean on the GemFire cache Region storing and managing Sessions, specifically on all Session attributes for quick lookup and queries on Session attribute names with a given value.

Parameters:

gemfireCache - a reference to the GemFire cache.

Returns:

a IndexFactoryBean to create an GemFire Index on attributes of Sessions stored in the GemFire cache Region.

See Also:

IndexFactoryBean, GemFireCache