Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add option to copy HTTP session id to handshake attrs

Browse Source 
Issue: SPR-12314
This commit is contained in:
Rossen Stoyanchev
2014-10-10 15:21:04 -04:00
parent 4a29e164a8
commit f0323be786
2 changed files with 52 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
spring-websocket/src/main/java/org/springframework/web/socket/server/support/HttpSessionHandshakeInterceptor.java
View File

@@ -38,7 +38,15 @@ import org.springframework.web.socket.server.HandshakeInterceptor;
*/
public class HttpSessionHandshakeInterceptor implements HandshakeInterceptor {
private Collection<String> attributeNames;
/**
* The name of the attribute under which the HTTP session id is exposed when
* {@link #setCopyHttpSessionId(boolean) copyHttpSessionId} is "true".
*/
public static final String HTTP_SESSION_ID_ATTR_NAME = "HTTP.SESSION.ID";
private final Collection<String> attributeNames;
private boolean copyHttpSessionId;
/**
@@ -56,6 +64,25 @@ public class HttpSessionHandshakeInterceptor implements HandshakeInterceptor {
this.attributeNames = attributeNames;
}
/**
* When set to "true", the HTTP session id is copied to the WebSocket
* handshake attributes, and is subsequently available via
* {@link org.springframework.web.socket.WebSocketSession#getAttributes()}
* under the key {@link #HTTP_SESSION_ID_ATTR_NAME}.
* <p>By default this is "false".
* @param copyHttpSessionId whether to copy the HTTP session id.
*/
public void setCopyHttpSessionId(boolean copyHttpSessionId) {
this.copyHttpSessionId = copyHttpSessionId;
}
/**
* Whether to copy the HTTP session id to the handshake attributes.
*/
public boolean isCopyHttpSessionId() {
return this.copyHttpSessionId;
}
@Override
public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
@@ -72,6 +99,9 @@ public class HttpSessionHandshakeInterceptor implements HandshakeInterceptor {
attributes.put(name, session.getAttribute(name));
}
}
if (isCopyHttpSessionId()) {
attributes.put(HTTP_SESSION_ID_ATTR_NAME, session.getId());
}
}
}
return true;