Skip to content

Commit

Permalink
Polish JdkMongoSessionConverter
Browse files Browse the repository at this point in the history 
* Serializer/Deserializer -> Converter API
* Verify/Test null constructor arguments

Issue gh-431
  • Loading branch information
Rob Winch committed Mar 17, 2016
1 parent 9014ac9 commit b58ea03
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 40 deletions.
61 changes: 21 additions & 40 deletions ...ession/src/main/java/org/springframework/session/data/mongo/JdkMongoSessionConverter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,31 @@
*/
package org.springframework.session.data.mongo;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.mongodb.BasicDBObject;
import com.mongodb.DBObject;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.core.serializer.DefaultDeserializer;
import org.springframework.core.serializer.DefaultSerializer;
import org.springframework.core.serializer.Deserializer;
import org.springframework.core.serializer.Serializer;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.serializer.support.DeserializingConverter;
import org.springframework.core.serializer.support.SerializingConverter;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.session.FindByIndexNameSessionRepository;
import org.springframework.session.Session;
import org.springframework.util.Assert;

/**
* {@code AbstractMongoSessionConverter} implementation using standard Java serialization.
*
* @author Jakub Kubrynski
* @author Rob Winch
* @since 1.2
*/
public class JdkMongoSessionConverter extends AbstractMongoSessionConverter {

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

private static final String ID = "_id";
private static final String CREATION_TIME = "created";
private static final String LAST_ACCESSED_TIME = "accessed";
Expand All @@ -54,14 +48,17 @@ public class JdkMongoSessionConverter extends AbstractMongoSessionConverter {

private static final String PRINCIPAL_FIELD_NAME = "principal";

private final Serializer serializer;
private final Deserializer deserializer;
private final Converter<Object, byte[]> serializer;
private final Converter<byte[], Object> deserializer;

public JdkMongoSessionConverter() {
this(new DefaultSerializer(), new DefaultDeserializer());
this(new SerializingConverter(), new DeserializingConverter());
}

public JdkMongoSessionConverter(Serializer serializer, Deserializer deserializer) {
public JdkMongoSessionConverter(Converter<Object, byte[]> serializer,
Converter<byte[], Object> deserializer) {
Assert.notNull(serializer, "serializer cannot be null");
Assert.notNull(deserializer, "deserializer cannot be null");
this.serializer = serializer;
this.deserializer = deserializer;
}
Expand Down Expand Up @@ -100,37 +97,21 @@ protected MongoExpiringSession convert(DBObject sessionWrapper) {
return session;
}

@SuppressWarnings("unchecked")
private byte[] serializeAttributes(Session session) {
try {
ByteArrayOutputStream out = new ByteArrayOutputStream();
Map<String, Object> attributes = new HashMap<String, Object>();
for (String attrName : session.getAttributeNames()) {
attributes.put(attrName, session.getAttribute(attrName));
}
this.serializer.serialize(attributes, out);
return out.toByteArray();
}
catch (IOException e) {
LOG.error("Exception during session serialization", e);
throw new IllegalStateException("Cannot serialize session", e);
Map<String, Object> attributes = new HashMap<String, Object>();
for (String attrName : session.getAttributeNames()) {
attributes.put(attrName, session.getAttribute(attrName));
}
return this.serializer.convert(attributes);
}

@SuppressWarnings("unchecked")
private void deserializeAttributes(DBObject sessionWrapper, Session session) {
try {
ByteArrayInputStream in = new ByteArrayInputStream(
(byte[]) sessionWrapper.get(ATTRIBUTES));
Map<String, Object> attributes =
(Map<String, Object>) this.deserializer.deserialize(in);
for (Map.Entry<String, Object> entry : attributes.entrySet()) {
session.setAttribute(entry.getKey(), entry.getValue());
}
}
catch (IOException e) {
LOG.error("Exception during session deserialization", e);
throw new IllegalStateException("Cannot deserialize session", e);
byte[] attributesBytes = (byte[]) sessionWrapper.get(ATTRIBUTES);
Map<String, Object> attributes = (Map<String, Object>) this.deserializer
.convert(attributesBytes);
for (Map.Entry<String, Object> entry : attributes.entrySet()) {
session.setAttribute(entry.getKey(), entry.getValue());
}
}

Expand Down
13 changes: 13 additions & 0 deletions ...n/src/test/java/org/springframework/session/data/mongo/JdkMongoSessionConverterTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import org.junit.Test;

import org.springframework.core.convert.TypeDescriptor;
import org.springframework.core.serializer.support.DeserializingConverter;
import org.springframework.core.serializer.support.SerializingConverter;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextImpl;
import org.springframework.session.ExpiringSession;
Expand All @@ -28,11 +30,22 @@

/**
* @author Jakub Kubrynski
* @author Rob Winch
*/
public class JdkMongoSessionConverterTests {

JdkMongoSessionConverter sut = new JdkMongoSessionConverter();

@Test(expected = IllegalArgumentException.class)
public void constructorNullSerializer() {
new JdkMongoSessionConverter(null, new DeserializingConverter());
}

@Test(expected = IllegalArgumentException.class)
public void constructorNullDeserializer() {
new JdkMongoSessionConverter(new SerializingConverter(), null);
}

@Test
public void verifyRoundTripSerialization() throws Exception {
// given
Expand Down

1 comment on commit b58ea03

@jkubrynski
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Please sign in to comment.