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

Annotation Type EnableGemFireHttpSession

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Configuration
 @Import(value=GemFireHttpSessionConfiguration.class)
public @interface EnableGemFireHttpSession

Add this annotation to an @Configuration class to expose the SessionRepositoryFilter as a bean named "springSessionRepositoryFilter" and backed by Pivotal GemFire or Apache Geode. In order to leverage the annotation, a single Pivotal GemFire/Apache Geode Cache or ClientCache instance must be provided. For example:

 
  @Configuration
  @EnableGemFireHttpSession
 public class GemFirePeerCacheHttpSessionConfiguration {

      @Bean
     public Properties gemfireProperties() {
       Properties gemfireProperties = new Properties();
       gemfireProperties.setProperty("name", "ExamplePeer");
       gemfireProperties.setProperty("mcast-port", "0");
       gemfireProperties.setProperty("log-level", "warning");
       return gemfireProperties;
     }

      @Bean
     public CacheFactoryBean gemfireCache() throws Exception {
       CacheFactoryBean clientCacheFactoryBean = new CacheFactoryBean();
       clientCacheFactoryBean.setLazyInitialize(false);
       clientCacheFactoryBean.setProperties(gemfireProperties());
       clientCacheFactoryBean.setUseBeanFactoryLocator(false);
       return clientCacheFactoryBean;
     }
 }
  

Alternatively, a Spring Session can be configured to use Pivotal GemFire (Apache Geode) as a client using a dedicated GemFire Server cluster and a ClientCache. For example: @Configuration @EnableGemFireHttpSession public class GemFireClientCacheHttpSessionConfiguration { @Bean public Properties gemfireProperties() { Properties gemfireProperties = new Properties(); gemfireProperties.setProperty("name", "ExampleClient"); gemfireProperties.setProperty("log-level", "warning"); return gemfireProperties; } @Bean public ClientCacheFactoryBean gemfireCache() throws Exception { ClientCacheFactoryBean clientCacheFactoryBean = new ClientCacheFactoryBean(); clientCacheFactoryBean.setLazyInitialize(false); clientCacheFactoryBean.setProperties(gemfireProperties()); clientCacheFactoryBean.setUseBeanFactoryLocator(false); return clientCacheFactoryBean; } } More advanced configurations can extend GemFireHttpSessionConfiguration instead.

Since:

1.1.0

Author:

John Blum

See Also:

GemFireHttpSessionConfiguration, EnableSpringHttpSession

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
com.gemstone.gemfire.cache.client.ClientRegionShortcut	clientRegionShortcut Defines the GemFire ClientCache Region DataPolicy.
String[]	indexableSessionAttributes Identifies the Session attributes by name that should be indexed for query operations.
int	maxInactiveIntervalInSeconds Defines the maximum interval in seconds that a Session can remain inactive before it is considered expired.
String	regionName Defines the name of the GemFire (Client)Cache Region used to store Sessions.
com.gemstone.gemfire.cache.RegionShortcut	serverRegionShortcut Defines the GemFire, Peer Cache Region DataPolicy.

Element Detail

clientRegionShortcut

public abstract com.gemstone.gemfire.cache.client.ClientRegionShortcut clientRegionShortcut

Defines the GemFire ClientCache Region DataPolicy.

Returns:

a ClientRegionShortcut used to specify and configure the ClientCache Region DataPolicy.

See Also:

ClientRegionShortcut

Default:

com.gemstone.gemfire.cache.client.ClientRegionShortcut.PROXY

indexableSessionAttributes

public abstract String[] indexableSessionAttributes

Identifies the Session attributes by name that should be indexed for query operations. For instance, find all Sessions in GemFire having attribute A defined with value X.

Returns:

an array of Strings identifying the names of Session attributes to index.

Default:

{}

maxInactiveIntervalInSeconds

public abstract int maxInactiveIntervalInSeconds

Defines the maximum interval in seconds that a Session can remain inactive before it is considered expired. Defaults to 1800 seconds, or 30 minutes.

Returns:

an integer value defining the maximum inactive interval in seconds for declaring a Session expired.

Default:

1800

regionName

public abstract String regionName

Defines the name of the GemFire (Client)Cache Region used to store Sessions.

Returns:

a String specifying the name of the GemFire (Client)Cache Region used to store Sessions.

See Also:

Region.getName()

Default:

"ClusteredSpringSessions"

serverRegionShortcut

public abstract com.gemstone.gemfire.cache.RegionShortcut serverRegionShortcut

Defines the GemFire, Peer Cache Region DataPolicy.

Returns:

a RegionShortcut used to specify and configure the Peer Cache Region DataPolicy.

See Also:

RegionShortcut

Default:

com.gemstone.gemfire.cache.RegionShortcut.PARTITION