WebSockets & Real-Time Systems with Spring · Lesson

User Session Management

Implement advanced user session management for WebSockets, linking HTTP sessions to WebSocket sessions.

User Session Management is a free WebSockets & Real-Time Systems with Spring lesson on CoddyKit — lesson 3 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the WebSockets & Real-Time Systems with Spring learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Understanding User Sessions

In web applications, a "session" helps a server remember a user across multiple requests. It's like a temporary memory for each user.

For traditional HTTP, sessions are often managed with cookies. They allow you to store user-specific data, like login status or cart items, between page loads.

WebSockets: Session Challenges

Unlike HTTP, WebSockets establish a persistent, full-duplex connection. This connection doesn't inherently carry the same session context as an HTTP request.

This means if a user logs in via HTTP and then opens a WebSocket, the WebSocket connection won't automatically know who the user is without specific setup.

HTTP Session: Short-lived, request-response.
WebSocket Session: Long-lived, persistent connection.

Bridging HTTP & WebSocket Sessions

To build rich real-time applications, you often need the WebSocket connection to know about the user's HTTP session context.

For example, you might need to know if a user is authenticated, their user ID, or other profile details that were established during their initial HTTP login.

Spring provides mechanisms to "bridge" this gap during the WebSocket handshake.

The Handshake Interceptor

Spring's primary tool for linking HTTP and WebSocket sessions is the HttpSessionHandshakeInterceptor.

This interceptor runs during the WebSocket handshake, which is the initial HTTP request that upgrades to a WebSocket connection. It can copy attributes from the current HTTP session to the WebSocket session.

What it does: Copies HTTP session attributes.
When it runs: During the WebSocket handshake.

Configuring Session Interceptor

To use the HttpSessionHandshakeInterceptor, you need to register it within your WebSocket configuration. This tells Spring to apply the interceptor when a WebSocket connection is being established.

It's typically added in your WebSocketMessageBrokerConfigurer implementation:

public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
  @Override
  public void registerStompEndpoints(StompEndpointRegistry registry) {
    registry.addEndpoint("/ws")
            .addInterceptors(new HttpSessionHandshakeInterceptor())
            .withSockJS();
  }
}

Accessing Linked Session Data

Once the HttpSessionHandshakeInterceptor has done its job, you can access the copied HTTP session attributes within your WebSocket message handlers.

Commonly, you'll want to access the Principal (representing the authenticated user) or other custom attributes you've stored in the HTTP session.

@Controller
public class MyWebSocketController {
  @MessageMapping("/hello")
  public void handleMessage(@Payload String message, Principal principal) {
    String username = principal.getName();
    System.out.println("Message from " + username + ": " + message);
    // ... use username for user-specific logic
  }
}

WebSocket-Specific Data

Besides copying HTTP session data, you can also store information directly within the WebSocketSession itself. This data is specific to that particular WebSocket connection.

This is useful for managing connection-specific states, like a user's current chat room, notification preferences for this connection, or other transient data.

@EventListener
public void handleSessionConnect(SessionConnectedEvent event) {
  StompHeaderAccessor accessor = StompHeaderAccessor.wrap(event.getMessage());
  WebSocketSession session = (WebSocketSession) accessor.getSessionAttributes().get("webSocketSession");
  if (session != null) {
    session.getAttributes().put("customKey", "customValue");
  }
  System.out.println("User connected: " + accessor.getUser().getName());
}

Managing Session Lifecycle

Spring allows you to listen to WebSocket session lifecycle events. This is crucial for cleaning up resources or updating user status when connections are established or closed.

You can use @EventListener with SessionConnectedEvent and SessionDisconnectEvent to react to these changes.

SessionConnectedEvent: Fired when a new STOMP session is established.
SessionDisconnectEvent: Fired when a STOMP session is closed.

Runnable: Handshake Interceptor

This Spring Boot example configures a WebSocket endpoint with HttpSessionHandshakeInterceptor. When a client connects, the interceptor helps link the HTTP session (if any) to the WebSocket session.

We demonstrate a simple message handler that could access the authenticated user's Principal. If Spring Security were enabled, principal.getName() would return the logged-in username.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.stereotype.Controller;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;
import java.security.Principal;

@SpringBootApplication
@EnableWebSocketMessageBroker
public class WebSocketSessionApp {
  public static void main(String[] args) {
    SpringApplication.run(WebSocketSessionApp.class, args);
  }

  @Configuration
  public static class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
      config.enableSimpleBroker("/topic");
      config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
      registry.addEndpoint("/ws")
              .addInterceptors(new HttpSessionHandshakeInterceptor())
              .withSockJS();
    }
  }

  @Controller
  public static class WebSocketGreetingController {
    @MessageMapping("/hello")
    public void greeting(Principal principal) {
      if (principal != null) {
        System.out.println("Message from authenticated user: " + principal.getName());
      } else {
        System.out.println("Message from unauthenticated user (Principal is null).");
      }
    }
  }
}

Quick Check: Handshake Interceptor

Test your understanding of the HttpSessionHandshakeInterceptor.

Recap: Session Management

We've explored how to manage user sessions in Spring WebSocket applications, particularly how to link HTTP session context to WebSocket sessions.

The HttpSessionHandshakeInterceptor is key for copying HTTP session attributes during the handshake.
You can access authenticated user information (Principal) in WebSocket handlers.
@EventListener helps manage connection and disconnection events.

Proper session management ensures your real-time features are personalized and secure for each user.

Frequently asked questions

Is the “User Session Management” lesson free?

Yes — the full text of “User Session Management” is free to read here on the web, and the WebSockets & Real-Time Systems with Spring course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the WebSockets & Real-Time Systems with Spring course, upgrade to CoddyKit PRO.

What will I learn in “User Session Management”?

Implement advanced user session management for WebSockets, linking HTTP sessions to WebSocket sessions. You practise WebSockets & Real-Time Systems with Spring with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start WebSockets & Real-Time Systems with Spring?

No prior experience is required. WebSockets & Real-Time Systems with Spring on CoddyKit is structured for beginners through advanced learners; this is — lesson 3 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “User Session Management” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this WebSockets & Real-Time Systems with Spring lesson?

Yes. Every WebSockets & Real-Time Systems with Spring lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to WebSockets & Real-Time Systems with Spring