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

Class AbstractGemFireHttpSessionConfiguration

java.lang.Object

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

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

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.ApplicationContextAware, org.springframework.context.EnvironmentAware

Direct Known Subclasses:

GemFireHttpSessionConfiguration

public abstract class AbstractGemFireHttpSessionConfiguration
extends org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration
implements org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.EnvironmentAware

The AbstractGemFireHttpSessionConfiguration class is an abstract base class containing configuration logic common to Apache Geode and Pivotal GemFire in order to manage HttpSession state.

Since:

2.0.4

See Also:

ClassLoader, BeanClassLoaderAware, ConfigurableBeanFactory, ApplicationContext, ConfigurableApplicationContext, EnvironmentAware, Environment, SpringHttpSessionConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	SPRING_SESSION_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractGemFireHttpSessionConfiguration()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	clientRegionShortcutPropertyName()
protected java.lang.String	exposeConfigurationAsPropertiesPropertyName()
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.springframework.core.env.Environment	getEnvironment() Returns a reference to the configured Spring Environment.
protected org.slf4j.Logger	getLogger() Return a reference to the configured SLF4J Logger.
protected java.lang.String	indexableSessionAttributesPropertyName()
protected java.lang.String	indexedSessionAttributesPropertyName()
protected java.lang.String	maxInactiveIntervalInSecondsPropertyName()
protected java.lang.String	poolNamePropertyName()
protected <T> T	requireProperty(java.lang.String propertyName, java.lang.Class<T> type) Resolves the value for the given property identified by name from the Spring Environment as an instance of the specified type.
protected <T extends java.lang.Enum<T>> T	resolveEnumeratedProperty(java.lang.String propertyName, java.lang.Class<T> targetType, T defaultValue) Attempts to resolve the property with the given name from the Spring Environment as an Enum.
protected java.lang.Boolean	resolveProperty(java.lang.String propertyName, java.lang.Boolean defaultValue) Attempts to resolve the property with the given name from the Spring Environment as an Boolean.
protected <T> T	resolveProperty(java.lang.String propertyName, java.lang.Class<T> targetType) Attempts to resolve the property with the given name from the Spring Environment.
protected <T> T	resolveProperty(java.lang.String propertyName, java.lang.Class<T> targetType, T defaultValue) Attempts to resolve the property with the given name from the Spring Environment.
protected java.lang.Integer	resolveProperty(java.lang.String propertyName, java.lang.Integer defaultValue) Attempts to resolve the property with the given name from the Spring Environment as an Integer.
protected java.lang.String	resolveProperty(java.lang.String propertyName, java.lang.String defaultValue) Attempts to resolve the property with the given name from the Spring Environment as a String.
protected java.lang.String[]	resolveProperty(java.lang.String propertyName, java.lang.String[] defaultValue) Attempts to resolve the property with the given name from the Spring Environment as a String array.
protected java.lang.String	serverRegionShortcutPropertyName()
protected java.lang.String	sessionExpirationPolicyBeanNamePropertyName()
protected java.lang.String	sessionRegionNamePropertyName()
protected java.lang.String	sessionSerializerBeanNamePropertyName()
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	setEnvironment(org.springframework.core.env.Environment environment) Sets a reference to the Spring Environment.

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

init, sessionEventHttpSessionListenerAdapter, setCookieSerializer, setHttpSessionIdResolver, setHttpSessionListeners, setServletContext, springSessionRepositoryFilter

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_SESSION_PROPERTY_PREFIX

protected static final java.lang.String SPRING_SESSION_PROPERTY_PREFIX

See Also:

Constant Field Values

Constructor Detail

AbstractGemFireHttpSessionConfiguration

public AbstractGemFireHttpSessionConfiguration()

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.

Throws:

java.lang.IllegalStateException - if ApplicationContext is null.

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.

Throws:

java.lang.IllegalStateException - if ApplicationContext is null.

See Also:

ConfigurableBeanFactory, getApplicationContext()

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Sets a reference to the Spring Environment.

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

Parameters:

environment - Spring Environment.

See Also:

Environment

getEnvironment

protected org.springframework.core.env.Environment getEnvironment()

Returns a reference to the configured Spring Environment.

Returns:

a reference to the configured Spring Environment.

See Also:

Environment

getLogger

protected org.slf4j.Logger getLogger()

Return a reference to the configured SLF4J Logger.

Returns:

a reference to the configured SLF4J Logger.

See Also:

Logger

clientRegionShortcutPropertyName

protected java.lang.String clientRegionShortcutPropertyName()

exposeConfigurationAsPropertiesPropertyName

protected java.lang.String exposeConfigurationAsPropertiesPropertyName()

indexableSessionAttributesPropertyName

protected java.lang.String indexableSessionAttributesPropertyName()

indexedSessionAttributesPropertyName

protected java.lang.String indexedSessionAttributesPropertyName()

maxInactiveIntervalInSecondsPropertyName

protected java.lang.String maxInactiveIntervalInSecondsPropertyName()

poolNamePropertyName

protected java.lang.String poolNamePropertyName()

serverRegionShortcutPropertyName

protected java.lang.String serverRegionShortcutPropertyName()

sessionExpirationPolicyBeanNamePropertyName

protected java.lang.String sessionExpirationPolicyBeanNamePropertyName()

sessionRegionNamePropertyName

protected java.lang.String sessionRegionNamePropertyName()

sessionSerializerBeanNamePropertyName

protected java.lang.String sessionSerializerBeanNamePropertyName()

requireProperty

protected <T> T requireProperty(java.lang.String propertyName,
                                java.lang.Class<T> type)

Resolves the value for the given property identified by name from the Spring Environment as an instance of the specified type.

Type Parameters:

T - Class type of the propertyName property's assigned value.

Parameters:

propertyName - String containing the name of the required property to resolve.

type - Class type of the property's assigned value.

Returns:

the assigned value of the named property.

Throws:

java.lang.IllegalStateException - if the property has not been assigned a value. For String values, this also means the value cannot be empty. For non-String values, this means the value must not be null.

See Also:

resolveProperty(String, Class, Object)

resolveEnumeratedProperty

protected <T extends java.lang.Enum<T>> T resolveEnumeratedProperty(java.lang.String propertyName,
                                                                    java.lang.Class<T> targetType,
                                                                    T defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Enum.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object), Enum

resolveProperty

protected java.lang.Boolean resolveProperty(java.lang.String propertyName,
                                            java.lang.Boolean defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Boolean.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or the default value if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object), Boolean

resolveProperty

protected java.lang.Integer resolveProperty(java.lang.String propertyName,
                                            java.lang.Integer defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as an Integer.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or the default value if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object), Integer

resolveProperty

protected java.lang.String resolveProperty(java.lang.String propertyName,
                                           java.lang.String defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as a String.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or the default value if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object), String

resolveProperty

protected java.lang.String[] resolveProperty(java.lang.String propertyName,
                                             java.lang.String[] defaultValue)

Attempts to resolve the property with the given name from the Spring Environment as a String array.

Parameters:

propertyName - name of the property to resolve.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or the default value if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object), String

resolveProperty

protected <T> T resolveProperty(java.lang.String propertyName,
                                java.lang.Class<T> targetType)

Attempts to resolve the property with the given name from the Spring Environment.

Type Parameters:

T - type of the property value.

Parameters:

propertyName - name of the property to resolve.

targetType - type of the property's value.

Returns:

the value of the property identified by name or null if the property is not defined or not set.

See Also:

resolveProperty(String, Class, Object)

resolveProperty

protected <T> T resolveProperty(java.lang.String propertyName,
                                java.lang.Class<T> targetType,
                                T defaultValue)

Attempts to resolve the property with the given name from the Spring Environment.

Type Parameters:

T - Class type of the property value.

Parameters:

propertyName - name of the property to resolve.

targetType - Class type of the property's value.

defaultValue - default value to return if the property is not defined or not set.

Returns:

the value of the property identified by name or default value if the property is not defined or not set.

See Also:

getEnvironment()