org.springframework.session.data.mongo

Class AbstractMongoSessionConverter

java.lang.Object

org.springframework.session.data.mongo.AbstractMongoSessionConverter

All Implemented Interfaces:

GenericConverter

Direct Known Subclasses:

JacksonMongoSessionConverter, JdkMongoSessionConverter

public abstract class AbstractMongoSessionConverter
extends Object
implements GenericConverter

Base class for serializing and deserializing session objects. To create custom serializer you have to implement this interface and simply register your class as a bean.

Since:

1.2

Author:

Jakub Kubrynski, Greg Turnquist

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.core.convert.converter.GenericConverter

GenericConverter.ConvertiblePair

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EXPIRE_AT_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMongoSessionConverter()

Method Summary

Modifier and Type	Method and Description
protected abstract MongoSession	convert(org.bson.Document sessionWrapper)
protected abstract com.mongodb.DBObject	convert(MongoSession session)
Object	convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType)
protected void	ensureIndexes(org.springframework.data.mongodb.core.index.IndexOperations sessionCollectionIndexes) Method ensures that there is a TTL index on expireAt field.
protected String	extractPrincipal(org.springframework.session.Session expiringSession)
Set<GenericConverter.ConvertiblePair>	getConvertibleTypes()
protected abstract org.springframework.data.mongodb.core.query.Query	getQueryForIndex(String indexName, Object indexValue) Returns query to be executed to return sessions based on a particular index.

Methods inherited from class java.lang.Object

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

Field Detail

EXPIRE_AT_FIELD_NAME

protected static final String EXPIRE_AT_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractMongoSessionConverter

public AbstractMongoSessionConverter()

Method Detail

getQueryForIndex

protected abstract org.springframework.data.mongodb.core.query.Query getQueryForIndex(String indexName,
                                                                                      Object indexValue)

Returns query to be executed to return sessions based on a particular index.

Parameters:

indexName - name of the index

indexValue - value to query against

Returns:

built query or null if indexName is not supported

ensureIndexes

protected void ensureIndexes(org.springframework.data.mongodb.core.index.IndexOperations sessionCollectionIndexes)

Method ensures that there is a TTL index on expireAt field. It's has expireAfterSeconds set to zero seconds, so the expiration time is controlled by the application. It can be extended in custom converters when there is a need for creating additional custom indexes.

Parameters:

sessionCollectionIndexes - IndexOperations to use

extractPrincipal

protected String extractPrincipal(org.springframework.session.Session expiringSession)

getConvertibleTypes

public Set<GenericConverter.ConvertiblePair> getConvertibleTypes()

Specified by:

getConvertibleTypes in interface GenericConverter

convert

public Object convert(Object source,
                      TypeDescriptor sourceType,
                      TypeDescriptor targetType)

Specified by:

convert in interface GenericConverter

convert

protected abstract com.mongodb.DBObject convert(MongoSession session)

convert

protected abstract MongoSession convert(org.bson.Document sessionWrapper)