Skip to content
This repository was archived by the owner on Apr 4, 2025. It is now read-only.

made field names in session converters configurable #186

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

made field names in session converters configurable #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/main/java/org/springframework/session/data/mongo/AbstractMongoSessionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
*/
public abstract class AbstractMongoSessionConverter implements GenericConverter {

static final String EXPIRE_AT_FIELD_NAME = "expireAt";
private String expireAtFieldName = "expireAt";
private static final Log LOG = LogFactory.getLog(AbstractMongoSessionConverter.class);
private static final String SPRING_SECURITY_CONTEXT = "SPRING_SECURITY_CONTEXT";

Expand All @@ -73,16 +73,16 @@ public abstract class AbstractMongoSessionConverter implements GenericConverter
protected void ensureIndexes(IndexOperations sessionCollectionIndexes) {

for (IndexInfo info : sessionCollectionIndexes.getIndexInfo()) {
if (EXPIRE_AT_FIELD_NAME.equals(info.getName())) {
LOG.debug("TTL index on field " + EXPIRE_AT_FIELD_NAME + " already exists");
if (expireAtFieldName.equals(info.getName())) {
LOG.debug("TTL index on field " + expireAtFieldName + " already exists");
return;
}
}

LOG.info("Creating TTL index on field " + EXPIRE_AT_FIELD_NAME);
LOG.info("Creating TTL index on field " + expireAtFieldName);

sessionCollectionIndexes
.ensureIndex(new Index(EXPIRE_AT_FIELD_NAME, Sort.Direction.ASC).named(EXPIRE_AT_FIELD_NAME).expire(0));
.ensureIndex(new Index(expireAtFieldName, Sort.Direction.ASC).named(expireAtFieldName).expire(0));
}

protected String extractPrincipal(MongoSession expiringSession) {
Expand All @@ -91,11 +91,13 @@ protected String extractPrincipal(MongoSession expiringSession) {
.get(FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME);
}

@Override
public Set<ConvertiblePair> getConvertibleTypes() {

return Collections.singleton(new ConvertiblePair(DBObject.class, MongoSession.class));
}

@Override
@SuppressWarnings("unchecked")
@Nullable
public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
Expand All @@ -120,4 +122,12 @@ public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor t
public void setIndexResolver(IndexResolver<MongoSession> indexResolver) {
this.indexResolver = Assert.requireNonNull(indexResolver, "indexResolver must not be null!");
}

public void setExpireAtFieldName(String expireAtFieldName) {
this.expireAtFieldName = expireAtFieldName;
}

String getExpireAtFieldName() {
return expireAtFieldName;
}
}
16 changes: 8 additions & 8 deletions src/main/java/org/springframework/session/data/mongo/JacksonMongoSessionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,8 @@ public class JacksonMongoSessionConverter extends AbstractMongoSessionConverter

private static final Log LOG = LogFactory.getLog(JacksonMongoSessionConverter.class);

private static final String ATTRS_FIELD_NAME = "attrs.";
private static final String PRINCIPAL_FIELD_NAME = "principal";
private static final String EXPIRE_AT_FIELD_NAME = "expireAt";
private String attrsFieldName = "attrs.";
private String pricipalFieldName = "principal";

private final ObjectMapper objectMapper;

Expand All @@ -78,13 +77,14 @@ public JacksonMongoSessionConverter(ObjectMapper objectMapper) {
this.objectMapper = objectMapper;
}

@Override
@Nullable
protected Query getQueryForIndex(String indexName, Object indexValue) {

if (FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME.equals(indexName)) {
return Query.query(Criteria.where(PRINCIPAL_FIELD_NAME).is(indexValue));
return Query.query(Criteria.where(pricipalFieldName).is(indexValue));
} else {
return Query.query(Criteria.where(ATTRS_FIELD_NAME + MongoSession.coverDot(indexName)).is(indexValue));
return Query.query(Criteria.where(attrsFieldName + MongoSession.coverDot(indexName)).is(indexValue));
}
}

Expand Down Expand Up @@ -115,8 +115,8 @@ protected DBObject convert(MongoSession source) {
DBObject dbSession = BasicDBObject.parse(this.objectMapper.writeValueAsString(source));

// Override default serialization with proper values.
dbSession.put(PRINCIPAL_FIELD_NAME, extractPrincipal(source));
dbSession.put(EXPIRE_AT_FIELD_NAME, source.getExpireAt());
dbSession.put(pricipalFieldName, extractPrincipal(source));
dbSession.put(getExpireAtFieldName(), source.getExpireAt());
return dbSession;
} catch (JsonProcessingException e) {
throw new IllegalStateException("Cannot convert MongoExpiringSession", e);
Expand All @@ -127,7 +127,7 @@ protected DBObject convert(MongoSession source) {
@Nullable
protected MongoSession convert(Document source) {

Date expireAt = (Date) source.remove(EXPIRE_AT_FIELD_NAME);
Date expireAt = (Date) source.remove(getExpireAtFieldName());
source.remove("originalSessionId");
String json = source.toJson(JsonWriterSettings.builder().outputMode(JsonMode.RELAXED).build());

Expand Down
114 changes: 83 additions & 31 deletions src/main/java/org/springframework/session/data/mongo/JdkMongoSessionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@
*/
public class JdkMongoSessionConverter extends AbstractMongoSessionConverter {

private static final String ID = "_id";
private static final String CREATION_TIME = "created";
private static final String LAST_ACCESSED_TIME = "accessed";
private static final String MAX_INTERVAL = "interval";
private static final String ATTRIBUTES = "attr";
private static final String PRINCIPAL_FIELD_NAME = "principal";
private String idFieldName = "_id";
private String creationTimeFieldName = "created";
private String lastAccessedTimeFieldName = "accessed";
private String maxIntervalFieldName = "interval";
private String attributesFieldName = "attr";
private String principalFieldName = "principal";

private final Converter<Object, byte[]> serializer;
private final Converter<byte[], Object> deserializer;
Expand Down Expand Up @@ -80,7 +80,7 @@ public JdkMongoSessionConverter(Converter<Object, byte[]> serializer, Converter<
public Query getQueryForIndex(String indexName, Object indexValue) {

if (FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME.equals(indexName)) {
return Query.query(Criteria.where(PRINCIPAL_FIELD_NAME).is(indexValue));
return Query.query(Criteria.where(principalFieldName).is(indexValue));
} else {
return null;
}
Expand All @@ -91,74 +91,126 @@ protected DBObject convert(MongoSession session) {

BasicDBObject basicDBObject = new BasicDBObject();

basicDBObject.put(ID, session.getId());
basicDBObject.put(CREATION_TIME, session.getCreationTime());
basicDBObject.put(LAST_ACCESSED_TIME, session.getLastAccessedTime());
basicDBObject.put(MAX_INTERVAL, session.getMaxInactiveInterval());
basicDBObject.put(PRINCIPAL_FIELD_NAME, extractPrincipal(session));
basicDBObject.put(EXPIRE_AT_FIELD_NAME, session.getExpireAt());
basicDBObject.put(ATTRIBUTES, serializeAttributes(session));
basicDBObject.put(idFieldName, session.getId());
basicDBObject.put(creationTimeFieldName, session.getCreationTime());
basicDBObject.put(lastAccessedTimeFieldName, session.getLastAccessedTime());
basicDBObject.put(maxIntervalFieldName, session.getMaxInactiveInterval());
basicDBObject.put(principalFieldName, extractPrincipal(session));
basicDBObject.put(getExpireAtFieldName(), session.getExpireAt());
basicDBObject.put(attributesFieldName, serializeattributesFieldName(session));

return basicDBObject;
}

@Override
protected MongoSession convert(Document sessionWrapper) {

Object maxInterval = sessionWrapper.getOrDefault(MAX_INTERVAL, this.maxInactiveInterval);
Object maxInterval = sessionWrapper.getOrDefault(maxIntervalFieldName, this.maxInactiveInterval);

Duration maxIntervalDuration = (maxInterval instanceof Duration) ? (Duration) maxInterval
: Duration.parse(maxInterval.toString());

MongoSession session = new MongoSession(sessionWrapper.getString(ID), maxIntervalDuration.getSeconds());
MongoSession session = new MongoSession(sessionWrapper.getString(idFieldName),
maxIntervalDuration.getSeconds());

Object creationTime = sessionWrapper.get(CREATION_TIME);
Object creationTime = sessionWrapper.get(creationTimeFieldName);
if (creationTime instanceof Instant) {
session.setCreationTime(((Instant) creationTime).toEpochMilli());
} else if (creationTime instanceof Date) {
session.setCreationTime(((Date) creationTime).getTime());
}

Object lastAccessedTime = sessionWrapper.get(LAST_ACCESSED_TIME);
Object lastAccessedTime = sessionWrapper.get(lastAccessedTimeFieldName);
if (lastAccessedTime instanceof Instant) {
session.setLastAccessedTime((Instant) lastAccessedTime);
} else if (lastAccessedTime instanceof Date) {
session.setLastAccessedTime(Instant.ofEpochMilli(((Date) lastAccessedTime).getTime()));
}

session.setExpireAt((Date) sessionWrapper.get(EXPIRE_AT_FIELD_NAME));
session.setExpireAt((Date) sessionWrapper.get(getExpireAtFieldName()));

deserializeAttributes(sessionWrapper, session);
deserializeattributesFieldName(sessionWrapper, session);

return session;
}

@Nullable
private byte[] serializeAttributes(Session session) {
private byte[] serializeattributesFieldName(Session session) {

Map<String, Object> attributes = new HashMap<>();
Map<String, Object> attributesFieldName = new HashMap<>();

for (String attrName : session.getAttributeNames()) {
attributes.put(attrName, session.getAttribute(attrName));
attributesFieldName.put(attrName, session.getAttribute(attrName));
}

return this.serializer.convert(attributes);
return this.serializer.convert(attributesFieldName);
}

@SuppressWarnings("unchecked")
private void deserializeAttributes(Document sessionWrapper, Session session) {
private void deserializeattributesFieldName(Document sessionWrapper, Session session) {

Object sessionAttributes = sessionWrapper.get(ATTRIBUTES);
Object sessionattributesFieldName = sessionWrapper.get(attributesFieldName);

byte[] attributesBytes = (sessionAttributes instanceof Binary ? ((Binary) sessionAttributes).getData()
: (byte[]) sessionAttributes);
byte[] attributesFieldNameBytes = (sessionattributesFieldName instanceof Binary
? ((Binary) sessionattributesFieldName).getData()
: (byte[]) sessionattributesFieldName);

Map<String, Object> attributes = (Map<String, Object>) this.deserializer.convert(attributesBytes);
Map<String, Object> attributesFieldName = (Map<String, Object>) this.deserializer
.convert(attributesFieldNameBytes);

if (attributes != null) {
for (Map.Entry<String, Object> entry : attributes.entrySet()) {
if (attributesFieldName != null) {
for (Map.Entry<String, Object> entry : attributesFieldName.entrySet()) {
session.setAttribute(entry.getKey(), entry.getValue());
}
}
}

public String getIdFieldName() {
return idFieldName;
}

public void setIdFieldName(String idFieldName) {
this.idFieldName = idFieldName;
}

public String getCreationTimeFieldName() {
return creationTimeFieldName;
}

public void setCreationTimeFieldName(String creationTimeFieldName) {
this.creationTimeFieldName = creationTimeFieldName;
}

public String getLastAccessedTimeFieldName() {
return lastAccessedTimeFieldName;
}

public void setLastAccessedTimeFieldName(String lastAccessedTimeFieldName) {
this.lastAccessedTimeFieldName = lastAccessedTimeFieldName;
}

public String getMaxIntervalFieldName() {
return maxIntervalFieldName;
}

public void setMaxIntervalFieldName(String maxIntervalFieldName) {
this.maxIntervalFieldName = maxIntervalFieldName;
}

public String getPrincipalFieldName() {
return principalFieldName;
}

public void setPrincipalFieldName(String principalFieldName) {
this.principalFieldName = principalFieldName;
}

public String getAttributesFieldName() {
return attributesFieldName;
}

public void setAttributesFieldName(String attributesFieldName) {
this.attributesFieldName = attributesFieldName;
}

}