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

Class GemFireCacheTypeAwareRegionFactoryBean<K,V>

java.lang.Object

org.springframework.session.data.gemfire.config.annotation.web.http.support.GemFireCacheTypeAwareRegionFactoryBean<K,V>

Type Parameters:

K - the type of keys

V - the type of values

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>, org.springframework.beans.factory.InitializingBean

public class GemFireCacheTypeAwareRegionFactoryBean<K,V>
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>, org.springframework.beans.factory.InitializingBean

The GemFireCacheTypeAwareRegionFactoryBean class is a Spring FactoryBean used to construct, configure and initialize the GemFire cache Region used to store and manage Session state.

Since:

1.1.0

Author:

John Blum

See Also:

GenericRegionFactoryBean, BeanFactoryAware, FactoryBean, InitializingBean

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.gemstone.gemfire.cache.client.ClientRegionShortcut	DEFAULT_CLIENT_REGION_SHORTCUT
protected static com.gemstone.gemfire.cache.RegionShortcut	DEFAULT_SERVER_REGION_SHORTCUT
protected static String	DEFAULT_SPRING_SESSION_GEMFIRE_REGION_NAME

Constructor Summary

Constructors

Constructor and Description
GemFireCacheTypeAwareRegionFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Post-construction initialization callback to create, configure and initialize the GemFire cache Region used to store, replicate (distribute) and manage Session state.
protected org.springframework.beans.factory.BeanFactory	getBeanFactory() Gets a reference to the Spring BeanFactory responsible for creating GemFire components.
protected com.gemstone.gemfire.cache.client.ClientRegionShortcut	getClientRegionShortcut() Returns the Region data policy used by the GemFire cache client to manage Session state.
protected com.gemstone.gemfire.cache.GemFireCache	getGemfireCache() Returns a reference to the GemFire cache used to construct the appropriate Region.
com.gemstone.gemfire.cache.Region<K,V>	getObject() Returns a reference to the constructed GemFire cache Region used to store and manage Session state.
Class<?>	getObjectType() Returns the specific type of GemFire cache Region this factory creates when initialized or Region.class when uninitialized.
protected com.gemstone.gemfire.cache.RegionAttributes<K,V>	getRegionAttributes() Returns the GemFire RegionAttributes used to configure the GemFire cache Region used to store and manage Session state.
protected String	getRegionName() Returns the configured name of the GemFire cache Region use to store and manage Session state.
protected com.gemstone.gemfire.cache.RegionShortcut	getServerRegionShortcut() Returns the Region data policy used by the GemFire peer cache to manage Session state.
boolean	isSingleton() Returns true indicating the GemFire cache Region created by this factory is the sole instance.
protected com.gemstone.gemfire.cache.Region<K,V>	newClientRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache) Constructs a GemFire cache Region using the client-server GemFire topology to store and manage Session state in a GemFire server cluster accessible from a GemFire cache client.
protected com.gemstone.gemfire.cache.Region<K,V>	newServerRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache) Constructs a GemFire cache Region using a peer-to-peer (p2p) GemFire topology to store and manage Session state in a GemFire server cluster accessible from a GemFire cache client.
protected org.springframework.data.gemfire.client.Interest<K>[]	registerInterests(boolean register) Decides whether interests will be registered for all keys.
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Sets a reference to the Spring BeanFactory responsible for creating GemFire components.
void	setClientRegionShortcut(com.gemstone.gemfire.cache.client.ClientRegionShortcut clientRegionShortcut) Sets the Region data policy used by the GemFire cache client to manage Session state.
void	setGemfireCache(com.gemstone.gemfire.cache.GemFireCache gemfireCache) Sets a reference to the GemFire cache used to construct the appropriate Region.
void	setRegionAttributes(com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes) Sets the GemFire RegionAttributes used to configure the GemFire cache Region used to store and manage Session state.
void	setRegionName(String regionName) Sets the name of the GemFire cache Region use to store and manage Session state.
void	setServerRegionShortcut(com.gemstone.gemfire.cache.RegionShortcut serverRegionShortcut) Sets the Region data policy used by the GemFire peer cache to manage Session state.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_REGION_SHORTCUT

protected static final com.gemstone.gemfire.cache.client.ClientRegionShortcut DEFAULT_CLIENT_REGION_SHORTCUT

DEFAULT_SERVER_REGION_SHORTCUT

protected static final com.gemstone.gemfire.cache.RegionShortcut DEFAULT_SERVER_REGION_SHORTCUT

DEFAULT_SPRING_SESSION_GEMFIRE_REGION_NAME

protected static final String DEFAULT_SPRING_SESSION_GEMFIRE_REGION_NAME

See Also:

Constant Field Values

Constructor Detail

GemFireCacheTypeAwareRegionFactoryBean

public GemFireCacheTypeAwareRegionFactoryBean()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Post-construction initialization callback to create, configure and initialize the GemFire cache Region used to store, replicate (distribute) and manage Session state. This method intelligently handles both client-server and peer-to-peer (p2p) GemFire supported distributed system topologies.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - if the initialization of the GemFire cache Region fails.

See Also:

GemFireUtils.isClient(GemFireCache), getGemfireCache(), newClientRegion(GemFireCache), newServerRegion(GemFireCache)

newServerRegion

protected com.gemstone.gemfire.cache.Region<K,V> newServerRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache)
                                                          throws Exception

Constructs a GemFire cache Region using a peer-to-peer (p2p) GemFire topology to store and manage Session state in a GemFire server cluster accessible from a GemFire cache client.

Parameters:

gemfireCache - a reference to the GemFire Cache.

Returns:

a peer-to-peer-based GemFire cache Region to store and manage Session state.

Throws:

Exception - if the instantiation, configuration and initialization of the GemFire cache Region fails.

See Also:

GenericRegionFactoryBean, GemFireCache, Region, getRegionAttributes(), getRegionName(), getServerRegionShortcut()

newClientRegion

protected com.gemstone.gemfire.cache.Region<K,V> newClientRegion(com.gemstone.gemfire.cache.GemFireCache gemfireCache)
                                                          throws Exception

Constructs a GemFire cache Region using the client-server GemFire topology to store and manage Session state in a GemFire server cluster accessible from a GemFire cache client.

Parameters:

gemfireCache - a reference to the GemFire Cache.

Returns:

a client-server-based GemFire cache Region to store and manage Session state.

Throws:

Exception - if the instantiation, configuration and initialization of the GemFire cache Region fails.

See Also:

ClientRegionFactoryBean, GemFireCache, Region, getClientRegionShortcut(), getRegionAttributes(), getRegionName(), registerInterests(boolean)

registerInterests

protected org.springframework.data.gemfire.client.Interest<K>[] registerInterests(boolean register)

Decides whether interests will be registered for all keys. Interests is only registered on a client and typically only when the client is a (CACHING) PROXY to the server (i.e. non-LOCAL only).

Parameters:

register - a boolean value indicating whether interests should be registered.

Returns:

an array of Interests KEY/VALUE registrations.

See Also:

Interest

getObject

public com.gemstone.gemfire.cache.Region<K,V> getObject()
                                                 throws Exception

Returns a reference to the constructed GemFire cache Region used to store and manage Session state.

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

Returns:

the Region used to store and manage Session state.

Throws:

Exception - if the Region reference cannot be obtained.

See Also:

Region

getObjectType

public Class<?> getObjectType()

Returns the specific type of GemFire cache Region this factory creates when initialized or Region.class when uninitialized.

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

Returns:

the GemFire cache Region class type constructed by this factory.

See Also:

Region, Class

isSingleton

public boolean isSingleton()

Returns true indicating the GemFire cache Region created by this factory is the sole instance.

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<com.gemstone.gemfire.cache.Region<K,V>>

Returns:

true to indicate the GemFire cache Region storing and managing Sessions is a Singleton.

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Sets a reference to the Spring BeanFactory responsible for creating GemFire components.

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Parameters:

beanFactory - reference to the Spring BeanFactory

Throws:

IllegalArgumentException - if the BeanFactory reference is null.

See Also:

BeanFactory

getBeanFactory

protected org.springframework.beans.factory.BeanFactory getBeanFactory()

Gets a reference to the Spring BeanFactory responsible for creating GemFire components.

Returns:

a reference to the Spring BeanFactory

Throws:

IllegalStateException - if the BeanFactory reference is null.

See Also:

BeanFactory

setClientRegionShortcut

public void setClientRegionShortcut(com.gemstone.gemfire.cache.client.ClientRegionShortcut clientRegionShortcut)

Sets the Region data policy used by the GemFire cache client to manage Session state.

Parameters:

clientRegionShortcut - a ClientRegionShortcut to specify the client Region data management policy.

See Also:

ClientRegionShortcut

getClientRegionShortcut

protected com.gemstone.gemfire.cache.client.ClientRegionShortcut getClientRegionShortcut()

Returns the Region data policy used by the GemFire cache client to manage Session state. Defaults to ClientRegionShortcut.PROXY.

Returns:

a ClientRegionShortcut specifying the client Region data management policy.

See Also:

GemFireHttpSessionConfiguration.DEFAULT_CLIENT_REGION_SHORTCUT, ClientRegionShortcut

setGemfireCache

public void setGemfireCache(com.gemstone.gemfire.cache.GemFireCache gemfireCache)

Sets a reference to the GemFire cache used to construct the appropriate Region.

Parameters:

gemfireCache - a reference to the GemFire cache.

Throws:

IllegalArgumentException - if the GemFireCache reference is null.

getGemfireCache

protected com.gemstone.gemfire.cache.GemFireCache getGemfireCache()

Returns a reference to the GemFire cache used to construct the appropriate Region.

Returns:

a reference to the GemFire cache.

Throws:

IllegalStateException - if the GemFireCache reference is null.

setRegionAttributes

public void setRegionAttributes(com.gemstone.gemfire.cache.RegionAttributes<K,V> regionAttributes)

Sets the GemFire RegionAttributes used to configure the GemFire cache Region used to store and manage Session state.

Parameters:

regionAttributes - the GemFire RegionAttributes used to configure the GemFire cache Region.

See Also:

RegionAttributes

getRegionAttributes

protected com.gemstone.gemfire.cache.RegionAttributes<K,V> getRegionAttributes()

Returns the GemFire RegionAttributes used to configure the GemFire cache Region used to store and manage Session state.

Returns:

the GemFire RegionAttributes used to configure the GemFire cache Region.

See Also:

RegionAttributes

setRegionName

public void setRegionName(String regionName)

Sets the name of the GemFire cache Region use to store and manage Session state.

Parameters:

regionName - a String specifying the name of the GemFire cache Region.

getRegionName

protected String getRegionName()

Returns the configured name of the GemFire cache Region use to store and manage Session state. Defaults to "ClusteredSpringSessions"

Returns:

a String specifying the name of the GemFire cache Region.

See Also:

Region.getName()

setServerRegionShortcut

public void setServerRegionShortcut(com.gemstone.gemfire.cache.RegionShortcut serverRegionShortcut)

Sets the Region data policy used by the GemFire peer cache to manage Session state.

Parameters:

serverRegionShortcut - a RegionShortcut to specify the peer Region data management policy.

See Also:

RegionShortcut

getServerRegionShortcut

protected com.gemstone.gemfire.cache.RegionShortcut getServerRegionShortcut()

Returns the Region data policy used by the GemFire peer cache to manage Session state. Defaults to RegionShortcut.PARTITION.

Returns:

a RegionShortcut specifying the peer Region data management policy.

See Also:

RegionShortcut