Add support for creating session with externally specified id

Author: Jakub Maciej

spring-session-core/src/main/java/org/springframework/session/CreateWithIdSessionRepository.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014-2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.session;
+
+/**
+ * Extends a basic {@link SessionRepository} to allow creating session with specific id
+ *
+ * @param <S> the type of Session being managed by this
+ * {@link CreateWithIdSessionRepository}
+ * @author Jakub Maciej
+ */
+public interface CreateWithIdSessionRepository<S extends Session> extends SessionRepository<S> {
+
+	/**
+	 * Creates a new {@link Session} that is capable of being persisted by this
+	 * {@link SessionRepository}.
+	 *
+	 * <p>
+	 * This allows optimizations and customizations in how the {@link 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.
+	 * </p>
+	 * @return a new {@link Session} that is capable of being persisted by this
+	 * {@link SessionRepository}
+	 * @param id a desired session id
+	 */
+	S createSession(String id);
+
+}

spring-session-data-redis/src/main/java/org/springframework/session/data/redis/RedisIndexedSessionRepository.java

@@ -38,6 +38,7 @@
 import org.springframework.data.redis.serializer.RedisSerializer;
 import org.springframework.session.DelegatingIndexResolver;
 import org.springframework.session.FindByIndexNameSessionRepository;
+import org.springframework.session.CreateWithIdSessionRepository;
 import org.springframework.session.FlushMode;
 import org.springframework.session.IndexResolver;
 import org.springframework.session.MapSession;
@@ -244,10 +245,12 @@
  *
  * @author Rob Winch
  * @author Vedran Pavic
+ * @author Jakub Maciej
  * @since 2.2.0
  */
 public class RedisIndexedSessionRepository
-		implements FindByIndexNameSessionRepository<RedisIndexedSessionRepository.RedisSession>, MessageListener {
+		implements FindByIndexNameSessionRepository<RedisIndexedSessionRepository.RedisSession>,
+				   CreateWithIdSessionRepository<RedisIndexedSessionRepository.RedisSession>, MessageListener {
 
 	private static final Log logger = LogFactory.getLog(RedisIndexedSessionRepository.class);
 
@@ -498,6 +501,17 @@ public RedisSession createSession() {
 		return session;
 	}
 
+	@Override
+	public RedisSession createSession(final String id) {
+		MapSession cached = new MapSession(id);
+		if (this.defaultMaxInactiveInterval != null) {
+			cached.setMaxInactiveInterval(Duration.ofSeconds(this.defaultMaxInactiveInterval));
+		}
+		RedisSession session = new RedisSession(cached, true);
+		session.flushImmediateIfNecessary();
+		return session;
+	}
+
 	@Override
 	public void onMessage(Message message, byte[] pattern) {
 		byte[] messageChannel = message.getChannel();

spring-session-hazelcast/src/main/java/org/springframework/session/hazelcast/HazelcastIndexedSessionRepository.java

@@ -41,6 +41,7 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.session.DelegatingIndexResolver;
 import org.springframework.session.FindByIndexNameSessionRepository;
+import org.springframework.session.CreateWithIdSessionRepository;
 import org.springframework.session.FlushMode;
 import org.springframework.session.IndexResolver;
 import org.springframework.session.MapSession;
@@ -108,10 +109,12 @@
  * @author Tommy Ludwig
  * @author Mark Anderson
  * @author Aleksandar Stojsavljevic
+ * @author Jakub Maciej
  * @since 2.2.0
  */
 public class HazelcastIndexedSessionRepository
 		implements FindByIndexNameSessionRepository<HazelcastIndexedSessionRepository.HazelcastSession>,
+				   CreateWithIdSessionRepository<HazelcastIndexedSessionRepository.HazelcastSession>,
 		EntryAddedListener<String, MapSession>, EntryEvictedListener<String, MapSession>,
 		EntryRemovedListener<String, MapSession> {
 
@@ -243,6 +246,17 @@ public HazelcastSession createSession() {
 		return session;
 	}
 
+	@Override
+	public HazelcastSession createSession(final String id) {
+		MapSession cached = new MapSession(id);
+		if (this.defaultMaxInactiveInterval != null) {
+			cached.setMaxInactiveInterval(Duration.ofSeconds(this.defaultMaxInactiveInterval));
+		}
+		HazelcastSession session = new HazelcastSession(cached, true);
+		session.flushImmediateIfNecessary();
+		return session;
+	}
+
 	@Override
 	public void save(HazelcastSession session) {
 		if (session.isNew) {
@@ -338,15 +352,9 @@ public void entryRemoved(EntryEvent<String, MapSession> event) {
 			this.eventPublisher.publishEvent(new SessionDeletedEvent(this, session));
 		}
 	}
-
-	/**
-	 * A custom implementation of {@link Session} that uses a {@link MapSession} as the
-	 * basis for its mapping. It keeps track if changes have been made since last save.
-	 *
-	 * @author Aleksandar Stojsavljevic
-	 */
 	final class HazelcastSession implements Session {
 
+
 		private final MapSession delegate;
 
 		private boolean isNew;

spring-session-jdbc/src/main/java/org/springframework/session/jdbc/JdbcIndexedSessionRepository.java

@@ -47,6 +47,7 @@
 import org.springframework.jdbc.support.lob.LobHandler;
 import org.springframework.session.DelegatingIndexResolver;
 import org.springframework.session.FindByIndexNameSessionRepository;
+import org.springframework.session.CreateWithIdSessionRepository;
 import org.springframework.session.FlushMode;
 import org.springframework.session.IndexResolver;
 import org.springframework.session.MapSession;
@@ -125,10 +126,12 @@
  *
  * @author Vedran Pavic
  * @author Craig Andrews
+ * @author Jakub Maciej
  * @since 2.2.0
  */
 public class JdbcIndexedSessionRepository
-		implements FindByIndexNameSessionRepository<JdbcIndexedSessionRepository.JdbcSession> {
+		implements FindByIndexNameSessionRepository<JdbcIndexedSessionRepository.JdbcSession>,
+				   CreateWithIdSessionRepository<JdbcIndexedSessionRepository.JdbcSession> {
 
 	/**
 	 * The default name of database table used by Spring Session to store sessions.
@@ -404,6 +407,17 @@ public JdbcSession createSession() {
 		return session;
 	}
 
+	@Override
+	public JdbcSession createSession(final String id) {
+		MapSession delegate = new MapSession(id);
+		if (this.defaultMaxInactiveInterval != null) {
+			delegate.setMaxInactiveInterval(Duration.ofSeconds(this.defaultMaxInactiveInterval));
+		}
+		JdbcSession session = new JdbcSession(delegate, UUID.randomUUID().toString(), true);
+		session.flushIfRequired();
+		return session;
+	}
+
 	@Override
 	public void save(final JdbcSession session) {
 		session.save();