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

Class SessionCacheTypeAwareRegionFactoryBean<K,V>

java.lang.Object

org.springframework.data.gemfire.support.AbstractFactoryBeanSupport<org.apache.geode.cache.Region<K,V>>

org.springframework.data.gemfire.ResolvableRegionFactoryBean<K,V>

org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean<K,V>

org.springframework.session.data.gemfire.config.annotation.web.http.support.SessionCacheTypeAwareRegionFactoryBean<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.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.FactoryBean<org.apache.geode.cache.Region<K,V>>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.data.gemfire.eviction.EvictingRegionFactoryBean, org.springframework.data.gemfire.expiration.ExpiringRegionFactoryBean<K,V>

public class SessionCacheTypeAwareRegionFactoryBean<K,V>
extends org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean<K,V>

The SessionCacheTypeAwareRegionFactoryBean class is a Spring FactoryBean used to construct, configure and initialize the Apache Geode/Pivotal GemFire cache Region used to store and manage Session state.

Since:

1.1.0

See Also:

• GemFireCache
• Region
• RegionAttributes
• RegionShortcut
• ClientRegionShortcut
• Pool
• FactoryBean
• InitializingBean
• SmartLifecycle
• GenericRegionFactoryBean
• ClientRegionFactoryBean
• AbstractFactoryBeanSupport
• GemFireHttpSessionConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.geode.cache.client.ClientRegionShortcut	DEFAULT_CLIENT_REGION_SHORTCUT
protected static final String	DEFAULT_POOL_NAME
protected static final org.apache.geode.cache.RegionShortcut	DEFAULT_SERVER_REGION_SHORTCUT
protected static final String	DEFAULT_SESSION_REGION_NAME

Fields inherited from class org.springframework.data.gemfire.ResolvableRegionFactoryBean

CREATING_REGION_LOG_MESSAGE, REGION_FOUND_LOG_MESSAGE, REGION_NOT_FOUND_ERROR_MESSAGE

Fields inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

DEFAULT_SINGLETON

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
SessionCacheTypeAwareRegionFactoryBean()

Method Summary

Modifier and Type	Method	Description
org.apache.geode.cache.client.ClientRegionShortcut	getClientRegionShortcut()	Returns the Region data management policy used by the Apache Geode/Pivotal GemFire ClientCache to manage Session state.
protected Optional<String>	getPoolName()	Returns the name of the Pivotal GemFire Pool used by the client Region for managing Sessions during cache operations involving the server.
protected String	getRegionName()	Returns the configured name of the Region used to store and manage Session state.
org.apache.geode.cache.RegionShortcut	getServerRegionShortcut()	Returns the Region data management policy used by the Apache Geode/Pivotal GemFire peer Cache to manage Session state.
String	resolveRegionName()	Resolves the name of the Region used to manage Session state.
void	setRegionName(String regionName)	Sets the name of the Region used to store and manage Session state.

Methods inherited from class org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean

configureEviction, configureExpiration, createRegion, getAttributes, getClose, getCompressor, getCustomEntryIdleTimeout, getCustomEntryTimeToLive, getDataPolicy, getDiskStoreName, getEntryIdleTimeout, getEntryTimeToLive, getEvictionAttributes, getInterests, getKeyConstraint, getOffHeap, getPhase, getRegionIdleTimeout, getRegionTimeToLive, getScope, getSmartLifecycleComponent, getStatisticsEnabled, getValueConstraint, isAutoStartup, isClose, isRunning, newClientRegion, newClientRegionFactoryBean, newPeerRegionFactoryBean, newServerRegion, resolvePoolName, setAttributes, setClientRegionShortcut, setClose, setCompressor, setCustomEntryIdleTimeout, setCustomEntryTimeToLive, setDataPolicy, setDiskStoreName, setEntryIdleTimeout, setEntryTimeToLive, setEvictionAttributes, setInterests, setKeyConstraint, setOffHeap, setPoolName, setRegionConfigurers, setRegionConfigurers, setRegionIdleTimeout, setRegionTimeToLive, setScope, setServerRegionShortcut, setStatisticsEnabled, setValueConstraint, start, stop, stop

Methods inherited from class org.springframework.data.gemfire.ResolvableRegionFactoryBean

afterPropertiesSet, getCache, getLookupEnabled, getObject, getObjectType, getParent, getRegion, isLookupEnabled, loadSnapshot, postProcess, setCache, setLookupEnabled, setName, setParent, setRegion, setSnapshot

Methods inherited from class org.springframework.data.gemfire.support.AbstractFactoryBeanSupport

getBeanClassLoader, getBeanFactory, getBeanName, getLogger, getOptionalLogger, isDebugLoggingEnabled, isErrorLoggingEnabled, isInfoLoggingEnabled, isSingleton, isWarnLoggingEnabled, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarning, logWarning, newLogger, setBeanClassLoader, setBeanFactory, setBeanName

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CLIENT_REGION_SHORTCUT

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

DEFAULT_SERVER_REGION_SHORTCUT

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

DEFAULT_POOL_NAME

protected static final String DEFAULT_POOL_NAME

See Also:

• Constant Field Values

DEFAULT_SESSION_REGION_NAME

protected static final String DEFAULT_SESSION_REGION_NAME

See Also:

• Constant Field Values

Constructor Details

SessionCacheTypeAwareRegionFactoryBean

public SessionCacheTypeAwareRegionFactoryBean()

Method Details

getClientRegionShortcut

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

Returns the Region data management policy used by the Apache Geode/Pivotal GemFire ClientCache to manage Session state. Defaults to ClientRegionShortcut.PROXY.

Overrides:

getClientRegionShortcut in class org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean<K,V>

Returns:

a ClientRegionShortcut specifying the client Region data management policy used to manage Session state.

See Also:

• ClientRegionShortcut

getPoolName

protected Optional<String> getPoolName()

Returns the name of the Pivotal GemFire Pool used by the client Region for managing Sessions during cache operations involving the server.

Overrides:

getPoolName in class org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean<K,V>

Returns:

the name of a Pivotal GemFire Pool.

See Also:

• Pool.getName()

setRegionName

public void setRegionName(String regionName)

Sets the name of the Region used to store and manage Session state.

Overrides:

setRegionName in class org.springframework.data.gemfire.ResolvableRegionFactoryBean<K,V>

Parameters:

regionName - String containing the name of the Region used to store and manage Session state.

getRegionName

protected String getRegionName()

Returns the configured name of the Region used to store and manage Session state. Defaults to ClusteredSpringSessions.

Returns:

a String containing the name of the Region used to store and manage Session state.

See Also:

• Region.getName()

resolveRegionName

public String resolveRegionName()

Resolves the name of the Region used to manage Session state.

Overrides:

resolveRegionName in class org.springframework.data.gemfire.ResolvableRegionFactoryBean<K,V>

Returns:

the name of the Region used to manage Session state.

See Also:

• getRegionName()

getServerRegionShortcut

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

Returns the Region data management policy used by the Apache Geode/Pivotal GemFire peer Cache to manage Session state. Defaults to RegionShortcut.PARTITION.

Overrides:

getServerRegionShortcut in class org.springframework.data.gemfire.config.annotation.support.CacheTypeAwareRegionFactoryBean<K,V>

Returns:

a RegionShortcut specifying the peer Region data management policy to manage Session state.

See Also:

• RegionShortcut