org.springframework.session.hazelcast

Class HazelcastSessionRepository

java.lang.Object

org.springframework.session.hazelcast.HazelcastSessionRepository

All Implemented Interfaces:

com.hazelcast.map.listener.EntryAddedListener<java.lang.String,MapSession>, com.hazelcast.map.listener.EntryEvictedListener<java.lang.String,MapSession>, com.hazelcast.map.listener.EntryRemovedListener<java.lang.String,MapSession>, com.hazelcast.map.listener.MapListener, java.util.EventListener, FindByIndexNameSessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>, SessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

public class HazelcastSessionRepository
extends java.lang.Object
implements FindByIndexNameSessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>, com.hazelcast.map.listener.EntryAddedListener<java.lang.String,MapSession>, com.hazelcast.map.listener.EntryEvictedListener<java.lang.String,MapSession>, com.hazelcast.map.listener.EntryRemovedListener<java.lang.String,MapSession>

A SessionRepository implementation that stores sessions in Hazelcast's distributed IMap.

An example of how to create a new instance can be seen below:

 Config config = new Config();

 // ... configure Hazelcast ...

 HazelcastInstance hazelcastInstance = Hazelcast.newHazelcastInstance(config);

 HazelcastSessionRepository sessionRepository =
         new HazelcastSessionRepository(hazelcastInstance);
 

In order to support finding sessions by principal name using findByIndexNameAndIndexValue(String, String) method, custom configuration of IMap supplied to this implementation is required. The following snippet demonstrates how to define required configuration using programmatic Hazelcast Configuration:

 MapAttributeConfig attributeConfig = new MapAttributeConfig()
         .setName(HazelcastSessionRepository.PRINCIPAL_NAME_ATTRIBUTE)
         .setExtractor(PrincipalNameExtractor.class.getName());

 Config config = new Config();

 config.getMapConfig(HazelcastSessionRepository.DEFAULT_SESSION_MAP_NAME)
         .addMapAttributeConfig(attributeConfig)
         .addMapIndexConfig(new MapIndexConfig(
                 HazelcastSessionRepository.PRINCIPAL_NAME_ATTRIBUTE, false));

 Hazelcast.newHazelcastInstance(config);
 

This implementation listens for events on the Hazelcast-backed SessionRepository and translates those events into the corresponding Spring Session events. Publish the Spring Session events with the given ApplicationEventPublisher.

• entryAdded - SessionCreatedEvent
• entryEvicted - SessionExpiredEvent
• entryRemoved - SessionDeletedEvent

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SESSION_MAP_NAME The default name of map used by Spring Session to store sessions.
static java.lang.String	PRINCIPAL_NAME_ATTRIBUTE The principal name custom attribute name.

Fields inherited from interface org.springframework.session.FindByIndexNameSessionRepository

PRINCIPAL_NAME_INDEX_NAME

Constructor Summary

Constructors

Constructor and Description
HazelcastSessionRepository(com.hazelcast.core.HazelcastInstance hazelcastInstance)

Method Summary

Modifier and Type	Method and Description
void	close()
org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession	createSession() Creates a new Session that is capable of being persisted by this SessionRepository.
void	deleteById(java.lang.String id) Deletes the Session with the given Session.getId() or does nothing if the Session is not found.
void	entryAdded(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)
void	entryEvicted(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)
void	entryRemoved(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)
org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession	findById(java.lang.String id) Gets the Session by the Session.getId() or null if no Session is found.
java.util.Map<java.lang.String,org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>	findByIndexNameAndIndexValue(java.lang.String indexName, java.lang.String indexValue) Find a Map of the session id to the Session of all sessions that contain the session attribute with the name FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME and the value of the specified principal name.
void	init()
void	save(org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession session) Ensures the Session created by SessionRepository.createSession() is saved.
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher) Sets the ApplicationEventPublisher that is used to publish session events.
void	setDefaultMaxInactiveInterval(java.lang.Integer defaultMaxInactiveInterval) Set the maximum inactive interval in seconds between requests before newly created sessions will be invalidated.
void	setHazelcastFlushMode(HazelcastFlushMode hazelcastFlushMode) Sets the Hazelcast flush mode.
void	setSessionMapName(java.lang.String sessionMapName) Set the name of map used to store sessions.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SESSION_MAP_NAME

public static final java.lang.String DEFAULT_SESSION_MAP_NAME

The default name of map used by Spring Session to store sessions.

See Also:

Constant Field Values

PRINCIPAL_NAME_ATTRIBUTE

public static final java.lang.String PRINCIPAL_NAME_ATTRIBUTE

The principal name custom attribute name.

See Also:

Constant Field Values

Constructor Detail

HazelcastSessionRepository

public HazelcastSessionRepository(com.hazelcast.core.HazelcastInstance hazelcastInstance)

Method Detail

init

@PostConstruct
public void init()

close

@PreDestroy
public void close()

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Sets the ApplicationEventPublisher that is used to publish session events. The default is to not publish session events.

Parameters:

applicationEventPublisher - the ApplicationEventPublisher that is used to publish session events. Cannot be null.

setDefaultMaxInactiveInterval

public void setDefaultMaxInactiveInterval(java.lang.Integer defaultMaxInactiveInterval)

Set the maximum inactive interval in seconds between requests before newly created sessions will be invalidated. A negative time indicates that the session will never timeout. The default is 1800 (30 minutes).

Parameters:

defaultMaxInactiveInterval - the maximum inactive interval in seconds

setSessionMapName

public void setSessionMapName(java.lang.String sessionMapName)

Set the name of map used to store sessions.

Parameters:

sessionMapName - the session map name

setHazelcastFlushMode

public void setHazelcastFlushMode(HazelcastFlushMode hazelcastFlushMode)

Sets the Hazelcast flush mode. Default flush mode is HazelcastFlushMode.ON_SAVE.

Parameters:

hazelcastFlushMode - the new Hazelcast flush mode

createSession

public org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession createSession()

Description copied from interface: SessionRepository

Creates a new Session that is capable of being persisted by this SessionRepository.

This allows optimizations and customizations in how the Session is persisted. For example, the implementation returned might keep track of the changes ensuring that only the delta needs to be persisted on a save.

Specified by:

createSession in interface SessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

Returns:

a new Session that is capable of being persisted by this SessionRepository

save

public void save(org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession session)

Description copied from interface: SessionRepository

Ensures the Session created by SessionRepository.createSession() is saved.

Some implementations may choose to save as the Session is updated by returning a Session that immediately persists any changes. In this case, this method may not actually do anything.

Specified by:

save in interface SessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

Parameters:

session - the Session to save

findById

public org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession findById(java.lang.String id)

Description copied from interface: SessionRepository

Gets the Session by the Session.getId() or null if no Session is found.

Specified by:

findById in interface SessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

Parameters:

id - the Session.getId() to lookup

Returns:

the Session by the Session.getId() or null if no Session is found.

deleteById

public void deleteById(java.lang.String id)

Description copied from interface: SessionRepository

Deletes the Session with the given Session.getId() or does nothing if the Session is not found.

Specified by:

deleteById in interface SessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

Parameters:

id - the Session.getId() to delete

findByIndexNameAndIndexValue

public java.util.Map<java.lang.String,org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession> findByIndexNameAndIndexValue(java.lang.String indexName,
                                                                                                                                                      java.lang.String indexValue)

Description copied from interface: FindByIndexNameSessionRepository

Find a Map of the session id to the Session of all sessions that contain the session attribute with the name FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME and the value of the specified principal name.

Specified by:

findByIndexNameAndIndexValue in interface FindByIndexNameSessionRepository<org.springframework.session.hazelcast.HazelcastSessionRepository.HazelcastSession>

Parameters:

indexName - the name of the index (i.e. FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME)

indexValue - the value of the index to search for.

Returns:

a Map (never null) of the session id to the Session of all sessions that contain the session specified index name and the value of the specified index name. If no results are found, an empty Map is returned.

entryAdded

public void entryAdded(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)

Specified by:

entryAdded in interface com.hazelcast.map.listener.EntryAddedListener<java.lang.String,MapSession>

entryEvicted

public void entryEvicted(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)

Specified by:

entryEvicted in interface com.hazelcast.map.listener.EntryEvictedListener<java.lang.String,MapSession>

entryRemoved

public void entryRemoved(com.hazelcast.core.EntryEvent<java.lang.String,MapSession> event)

Specified by:

entryRemoved in interface com.hazelcast.map.listener.EntryRemovedListener<java.lang.String,MapSession>