How to use

org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor

constructor

@Test
public void doNotCauseSessionCreation() throws Exception {
  Map<String, Object> attributes = new HashMap<>();
  WebSocketHandler wsHandler = Mockito.mock(WebSocketHandler.class);
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  interceptor.beforeHandshake(this.request, this.response, wsHandler, attributes);
  assertNull(this.servletRequest.getSession(false));
}

@Test
public void constructorWithAttributeNames() throws Exception {
  Map<String, Object> attributes = new HashMap<>();
  WebSocketHandler wsHandler = Mockito.mock(WebSocketHandler.class);
  this.servletRequest.setSession(new MockHttpSession(null, "123"));
  this.servletRequest.getSession().setAttribute("foo", "bar");
  this.servletRequest.getSession().setAttribute("bar", "baz");
  Set<String> names = Collections.singleton("foo");
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor(names);
  interceptor.beforeHandshake(this.request, this.response, wsHandler, attributes);
  assertEquals(2, attributes.size());
  assertEquals("bar", attributes.get("foo"));
  assertEquals("123", attributes.get(HttpSessionHandshakeInterceptor.HTTP_SESSION_ID_ATTR_NAME));
}

@Test
public void doNotCopyAttributes() throws Exception {
  Map<String, Object> attributes = new HashMap<>();
  WebSocketHandler wsHandler = Mockito.mock(WebSocketHandler.class);
  this.servletRequest.setSession(new MockHttpSession(null, "123"));
  this.servletRequest.getSession().setAttribute("foo", "bar");
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  interceptor.setCopyAllAttributes(false);
  interceptor.beforeHandshake(this.request, this.response, wsHandler, attributes);
  assertEquals(1, attributes.size());
  assertEquals("123", attributes.get(HttpSessionHandshakeInterceptor.HTTP_SESSION_ID_ATTR_NAME));
}

@Test
public void doNotCopyHttpSessionId() throws Exception {
  Map<String, Object> attributes = new HashMap<>();
  WebSocketHandler wsHandler = Mockito.mock(WebSocketHandler.class);
  this.servletRequest.setSession(new MockHttpSession(null, "123"));
  this.servletRequest.getSession().setAttribute("foo", "bar");
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  interceptor.setCopyHttpSessionId(false);
  interceptor.beforeHandshake(this.request, this.response, wsHandler, attributes);
  assertEquals(1, attributes.size());
  assertEquals("bar", attributes.get("foo"));
}

@Test
public void defaultConstructor() throws Exception {
  Map<String, Object> attributes = new HashMap<>();
  WebSocketHandler wsHandler = Mockito.mock(WebSocketHandler.class);
  this.servletRequest.setSession(new MockHttpSession(null, "123"));
  this.servletRequest.getSession().setAttribute("foo", "bar");
  this.servletRequest.getSession().setAttribute("bar", "baz");
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  interceptor.beforeHandshake(this.request, this.response, wsHandler, attributes);
  assertEquals(3, attributes.size());
  assertEquals("bar", attributes.get("foo"));
  assertEquals("baz", attributes.get("bar"));
  assertEquals("123", attributes.get(HttpSessionHandshakeInterceptor.HTTP_SESSION_ID_ATTR_NAME));
}

public void registerStompEndpoints(StompEndpointRegistry registry) {
  registry.addEndpoint("/other").withSockJS()
      .setInterceptors(new HttpSessionHandshakeInterceptor());
  registry.addEndpoint("/chat").withSockJS()
      .setInterceptors(new HttpSessionHandshakeInterceptor());
}

@Test
public void handshakeHandlerAndInterceptor() {
  WebMvcStompWebSocketEndpointRegistration registration =
      new WebMvcStompWebSocketEndpointRegistration(new String[] {"/foo"}, this.handler, this.scheduler);
  DefaultHandshakeHandler handshakeHandler = new DefaultHandshakeHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  registration.setHandshakeHandler(handshakeHandler).addInterceptors(interceptor);
  MultiValueMap<HttpRequestHandler, String> mappings = registration.getMappings();
  assertEquals(1, mappings.size());
  Map.Entry<HttpRequestHandler, List<String>> entry = mappings.entrySet().iterator().next();
  assertEquals(Arrays.asList("/foo"), entry.getValue());
  WebSocketHttpRequestHandler requestHandler = (WebSocketHttpRequestHandler) entry.getKey();
  assertNotNull(requestHandler.getWebSocketHandler());
  assertSame(handshakeHandler, requestHandler.getHandshakeHandler());
  assertEquals(2, requestHandler.getHandshakeInterceptors().size());
  assertEquals(interceptor, requestHandler.getHandshakeInterceptors().get(0));
  assertEquals(OriginHandshakeInterceptor.class, requestHandler.getHandshakeInterceptors().get(1).getClass());
}

@Test
public void handshakeHandlerAndInterceptorWithAllowedOrigins() {
  WebMvcStompWebSocketEndpointRegistration registration =
      new WebMvcStompWebSocketEndpointRegistration(new String[] {"/foo"}, this.handler, this.scheduler);
  DefaultHandshakeHandler handshakeHandler = new DefaultHandshakeHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  String origin = "http://mydomain.com";
  registration.setHandshakeHandler(handshakeHandler).addInterceptors(interceptor).setAllowedOrigins(origin);
  MultiValueMap<HttpRequestHandler, String> mappings = registration.getMappings();
  assertEquals(1, mappings.size());
  Map.Entry<HttpRequestHandler, List<String>> entry = mappings.entrySet().iterator().next();
  assertEquals(Arrays.asList("/foo"), entry.getValue());
  WebSocketHttpRequestHandler requestHandler = (WebSocketHttpRequestHandler) entry.getKey();
  assertNotNull(requestHandler.getWebSocketHandler());
  assertSame(handshakeHandler, requestHandler.getHandshakeHandler());
  assertEquals(2, requestHandler.getHandshakeInterceptors().size());
  assertEquals(interceptor, requestHandler.getHandshakeInterceptors().get(0));
  assertEquals(OriginHandshakeInterceptor.class, requestHandler.getHandshakeInterceptors().get(1).getClass());
}

@Test
public void interceptors() {
  WebSocketHandler handler = new TextWebSocketHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  this.registration.addHandler(handler, "/foo").addInterceptors(interceptor);
  List<Mapping> mappings = this.registration.getMappings();
  assertEquals(1, mappings.size());
  Mapping mapping = mappings.get(0);
  assertEquals(handler, mapping.webSocketHandler);
  assertEquals("/foo", mapping.path);
  assertNotNull(mapping.interceptors);
  assertEquals(2, mapping.interceptors.length);
  assertEquals(interceptor, mapping.interceptors[0]);
  assertEquals(OriginHandshakeInterceptor.class, mapping.interceptors[1].getClass());
}

@Test
public void interceptorsWithAllowedOrigins() {
  WebSocketHandler handler = new TextWebSocketHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  this.registration.addHandler(handler, "/foo").addInterceptors(interceptor).setAllowedOrigins("http://mydomain1.com");
  List<Mapping> mappings = this.registration.getMappings();
  assertEquals(1, mappings.size());
  Mapping mapping = mappings.get(0);
  assertEquals(handler, mapping.webSocketHandler);
  assertEquals("/foo", mapping.path);
  assertNotNull(mapping.interceptors);
  assertEquals(2, mapping.interceptors.length);
  assertEquals(interceptor, mapping.interceptors[0]);
  assertEquals(OriginHandshakeInterceptor.class, mapping.interceptors[1].getClass());
}

public void registerStompEndpoints(StompEndpointRegistry registry) {
  registry.addEndpoint("/websocket")
      .setHandshakeHandler(testHandshakeHandler())
      .addInterceptors(new HttpSessionHandshakeInterceptor());
}

@Test
public void interceptorsPassedToSockJsRegistration() {
  WebSocketHandler handler = new TextWebSocketHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  this.registration.addHandler(handler, "/foo")
      .addInterceptors(interceptor)
      .setAllowedOrigins("http://mydomain1.com")
      .withSockJS();
  this.registration.getSockJsServiceRegistration().setTaskScheduler(this.taskScheduler);
  List<Mapping> mappings = this.registration.getMappings();
  assertEquals(1, mappings.size());
  Mapping mapping = mappings.get(0);
  assertEquals(handler, mapping.webSocketHandler);
  assertEquals("/foo/**", mapping.path);
  assertNotNull(mapping.sockJsService);
  assertTrue(mapping.sockJsService.getAllowedOrigins().contains("http://mydomain1.com"));
  List<HandshakeInterceptor> interceptors = mapping.sockJsService.getHandshakeInterceptors();
  assertEquals(interceptor, interceptors.get(0));
  assertEquals(OriginHandshakeInterceptor.class, interceptors.get(1).getClass());
}

@Test
public void emptyAllowedOrigin() {
  WebSocketHandler handler = new TextWebSocketHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  this.registration.addHandler(handler, "/foo").addInterceptors(interceptor).setAllowedOrigins();
  List<Mapping> mappings = this.registration.getMappings();
  assertEquals(1, mappings.size());
  Mapping mapping = mappings.get(0);
  assertEquals(handler, mapping.webSocketHandler);
  assertEquals("/foo", mapping.path);
  assertNotNull(mapping.interceptors);
  assertEquals(2, mapping.interceptors.length);
  assertEquals(interceptor, mapping.interceptors[0]);
  assertEquals(OriginHandshakeInterceptor.class, mapping.interceptors[1].getClass());
}

@Test
public void handshakeHandlerInterceptorWithSockJsService() {
  WebMvcStompWebSocketEndpointRegistration registration =
      new WebMvcStompWebSocketEndpointRegistration(new String[] {"/foo"}, this.handler, this.scheduler);
  DefaultHandshakeHandler handshakeHandler = new DefaultHandshakeHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  registration.setHandshakeHandler(handshakeHandler).addInterceptors(interceptor).withSockJS();
  MultiValueMap<HttpRequestHandler, String> mappings = registration.getMappings();
  assertEquals(1, mappings.size());
  Map.Entry<HttpRequestHandler, List<String>> entry = mappings.entrySet().iterator().next();
  assertEquals(Arrays.asList("/foo/**"), entry.getValue());
  SockJsHttpRequestHandler requestHandler = (SockJsHttpRequestHandler) entry.getKey();
  assertNotNull(requestHandler.getWebSocketHandler());
  DefaultSockJsService sockJsService = (DefaultSockJsService) requestHandler.getSockJsService();
  assertNotNull(sockJsService);
  Map<TransportType, TransportHandler> handlers = sockJsService.getTransportHandlers();
  WebSocketTransportHandler transportHandler = (WebSocketTransportHandler) handlers.get(TransportType.WEBSOCKET);
  assertSame(handshakeHandler, transportHandler.getHandshakeHandler());
  assertEquals(2, sockJsService.getHandshakeInterceptors().size());
  assertEquals(interceptor, sockJsService.getHandshakeInterceptors().get(0));
  assertEquals(OriginHandshakeInterceptor.class, sockJsService.getHandshakeInterceptors().get(1).getClass());
}

@Test
public void handshakeHandlerInterceptorWithSockJsServiceAndAllowedOrigins() {
  WebMvcStompWebSocketEndpointRegistration registration =
      new WebMvcStompWebSocketEndpointRegistration(new String[] {"/foo"}, this.handler, this.scheduler);
  DefaultHandshakeHandler handshakeHandler = new DefaultHandshakeHandler();
  HttpSessionHandshakeInterceptor interceptor = new HttpSessionHandshakeInterceptor();
  String origin = "http://mydomain.com";
  registration.setHandshakeHandler(handshakeHandler)
      .addInterceptors(interceptor).setAllowedOrigins(origin).withSockJS();
  MultiValueMap<HttpRequestHandler, String> mappings = registration.getMappings();
  assertEquals(1, mappings.size());
  Map.Entry<HttpRequestHandler, List<String>> entry = mappings.entrySet().iterator().next();
  assertEquals(Arrays.asList("/foo/**"), entry.getValue());
  SockJsHttpRequestHandler requestHandler = (SockJsHttpRequestHandler) entry.getKey();
  assertNotNull(requestHandler.getWebSocketHandler());
  DefaultSockJsService sockJsService = (DefaultSockJsService) requestHandler.getSockJsService();
  assertNotNull(sockJsService);
  Map<TransportType, TransportHandler> handlers = sockJsService.getTransportHandlers();
  WebSocketTransportHandler transportHandler = (WebSocketTransportHandler) handlers.get(TransportType.WEBSOCKET);
  assertSame(handshakeHandler, transportHandler.getHandshakeHandler());
  assertEquals(2, sockJsService.getHandshakeInterceptors().size());
  assertEquals(interceptor, sockJsService.getHandshakeInterceptors().get(0));
  assertEquals(OriginHandshakeInterceptor.class,
      sockJsService.getHandshakeInterceptors().get(1).getClass());
  assertTrue(sockJsService.getAllowedOrigins().contains(origin));
}

public void registerStompEndpoints(StompEndpointRegistry registry) {
  registry.addEndpoint("/other").setHandshakeHandler(testHandshakeHandler())
      .withSockJS().setInterceptors(new HttpSessionHandshakeInterceptor());
  registry.addEndpoint("/chat").setHandshakeHandler(testHandshakeHandler())
      .withSockJS().setInterceptors(new HttpSessionHandshakeInterceptor());
}

/**
 * Register the web socket handler and add a handshake interceptor to copy attributes from the
 * http session to the web socket.
 *
 * @see org.springframework.web.socket.config.annotation.WebSocketConfigurer#registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry)
 */
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  registry.addHandler(cwf_WebSocketHandler, "/ws/**").addInterceptors(new HttpSessionHandshakeInterceptor());
}

/**
 * Register the web socket handler and add a handshake interceptor to copy attributes from the
 * http session to the web socket.
 *
 * @see org.springframework.web.socket.config.annotation.WebSocketConfigurer#registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry)
 */
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
  registry.addHandler(fujion_WebSocketHandler, "/ws/**").addInterceptors(new HttpSessionHandshakeInterceptor());
}