Refactoring in reactive WebSocketSession and adapters

The WebSocketHander adapters are now neutral for client vs server-side
use with the adapters for RxNetty and Reactor Netty (server-side only)
completely removed.

A new HandshakeInfo carries information about the handshake including
URI, headers, and principal from the upgrade strategy, to the adapter,
and then to the session.

WebSocketSession exposes the HandshakeInfo as well reducing its overall
number of methods.

Author: rstoyanchev

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/WebSocketSession.java

@@ -16,6 +16,8 @@
 package org.springframework.web.reactive.socket;
 
 import java.net.URI;
+import java.security.Principal;
+import java.util.Optional;
 import java.util.function.Function;
 
 import org.reactivestreams.Publisher;
@@ -24,6 +26,8 @@
 
 import org.springframework.core.io.buffer.DataBuffer;
 import org.springframework.core.io.buffer.DataBufferFactory;
+import org.springframework.http.HttpHeaders;
+import org.springframework.web.reactive.socket.adapter.HandshakeInfo;
 
 /**
  * Representation for a WebSocket session.
@@ -39,13 +43,13 @@ public interface WebSocketSession {
 	String getId();
 
 	/**
-	 * Return the WebSocket endpoint URI.
+	 * Return information from the handshake request.
 	 */
-	URI getUri();
+	HandshakeInfo getHandshakeInfo();
 
 	/**
-	 * Return a {@link DataBufferFactory} that can be used for creating message payloads.
-	 * @return a buffer factory
+	 * Return a {@code DataBuffer} Factory to create message payloads.
+	 * @return the buffer factory for the session
 	 */
 	DataBufferFactory bufferFactory();
 

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/AbstractListenerWebSocketSession.java

@@ -17,7 +17,6 @@
 package org.springframework.web.reactive.socket.adapter;
 
 import java.io.IOException;
-import java.net.URI;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import org.reactivestreams.Publisher;
@@ -55,8 +54,10 @@ public abstract class AbstractListenerWebSocketSession<T> extends WebSocketSessi
 	private final AtomicBoolean sendCalled = new AtomicBoolean();
 
 
-	public AbstractListenerWebSocketSession(T delegate, String id, URI uri, DataBufferFactory bufferFactory) {
-		super(delegate, id, uri, bufferFactory);
+	public AbstractListenerWebSocketSession(T delegate, String id, HandshakeInfo handshakeInfo,
+			DataBufferFactory bufferFactory) {
+
+		super(delegate, id, handshakeInfo, bufferFactory);
 	}
 
 

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/HandshakeInfo.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2002-2016 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
+ *
+ *      http://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.web.reactive.socket.adapter;
+
+import java.net.URI;
+import java.security.Principal;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.util.Assert;
+
+/**
+ * Simple container of information from a WebSocket handshake request.
+ *
+ * @author Rossen Stoyanchev
+ * @since 5.0
+ */
+public class HandshakeInfo {
+
+	private final URI uri;
+
+	private final HttpHeaders headers;
+
+	private final Mono<Principal> principal;
+
+
+	public HandshakeInfo(URI uri, HttpHeaders headers, Mono<Principal> principal) {
+		Assert.notNull(uri, "URI is required.");
+		Assert.notNull(headers, "HttpHeaders are required.");
+		Assert.notNull(principal, "Prinicpal is required.");
+		this.uri = uri;
+		this.headers = headers;
+		this.principal = principal;
+	}
+
+
+	public URI getUri() {
+		return this.uri;
+	}
+
+	public HttpHeaders getHeaders() {
+		return this.headers;
+	}
+
+	public Mono<Principal> getPrincipal() {
+		return this.principal;
+	}
+
+	@Override
+	public String toString() {
+		return "HandshakeInfo[uri=" + this.uri + ", headers=" + this.headers + "]";
+	}
+
+}

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/JettyWebSocketHandlerAdapter.java

@@ -32,8 +32,7 @@
 import org.reactivestreams.Subscription;
 
 import org.springframework.core.io.buffer.DataBuffer;
-import org.springframework.http.server.reactive.ServerHttpRequest;
-import org.springframework.http.server.reactive.ServerHttpResponse;
+import org.springframework.core.io.buffer.DataBufferFactory;
 import org.springframework.web.reactive.socket.CloseStatus;
 import org.springframework.web.reactive.socket.WebSocketHandler;
 import org.springframework.web.reactive.socket.WebSocketMessage;
@@ -54,17 +53,16 @@ public class JettyWebSocketHandlerAdapter extends WebSocketHandlerAdapterSupport
 	private JettyWebSocketSession session;
 
 
-	public JettyWebSocketHandlerAdapter(ServerHttpRequest request, ServerHttpResponse response,
+	public JettyWebSocketHandlerAdapter(HandshakeInfo handshakeInfo, DataBufferFactory bufferFactory,
 			WebSocketHandler delegate) {
 
-		super(request, response, delegate);
+		super(handshakeInfo, bufferFactory, delegate);
 	}
 
 
 	@OnWebSocketConnect
 	public void onWebSocketConnect(Session session) {
-		this.session = new JettyWebSocketSession(session, getUri(), getBufferFactory());
-
+		this.session = new JettyWebSocketSession(session, getHandshakeInfo(), getBufferFactory());
 		HandlerResultSubscriber subscriber = new HandlerResultSubscriber();
 		getDelegate().handle(this.session).subscribe(subscriber);
 	}

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/JettyWebSocketSession.java

@@ -17,7 +17,6 @@
 package org.springframework.web.reactive.socket.adapter;
 
 import java.io.IOException;
-import java.net.URI;
 import java.nio.ByteBuffer;
 import java.nio.charset.StandardCharsets;
 
@@ -41,8 +40,8 @@
 public class JettyWebSocketSession extends AbstractListenerWebSocketSession<Session> {
 
 
-	public JettyWebSocketSession(Session session, URI uri, DataBufferFactory bufferFactory) {
-		super(session, ObjectUtils.getIdentityHexString(session), uri, bufferFactory);
+	public JettyWebSocketSession(Session session, HandshakeInfo info, DataBufferFactory bufferFactory) {
+		super(session, ObjectUtils.getIdentityHexString(session), info, bufferFactory);
 	}
 
 

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/NettyWebSocketSessionSupport.java

@@ -15,7 +15,6 @@
  */
 package org.springframework.web.reactive.socket.adapter;
 
-import java.net.URI;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -54,8 +53,8 @@ public abstract class NettyWebSocketSessionSupport<T> extends WebSocketSessionSu
 	}
 
 
-	protected NettyWebSocketSessionSupport(T delegate, URI uri, NettyDataBufferFactory bufferFactory) {
-		super(delegate, ObjectUtils.getIdentityHexString(delegate), uri, bufferFactory);
+	protected NettyWebSocketSessionSupport(T delegate, HandshakeInfo info, NettyDataBufferFactory factory) {
+		super(delegate, ObjectUtils.getIdentityHexString(delegate), info, factory);
 	}
 
 

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/ReactorNettyWebSocketHandlerAdapter.java

@@ -15,8 +15,6 @@
  */
 package org.springframework.web.reactive.socket.adapter;
 
-import java.net.URI;
-
 import io.netty.handler.codec.http.websocketx.WebSocketFrame;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
@@ -42,10 +40,10 @@ public class ReactorNettyWebSocketSession
 		extends NettyWebSocketSessionSupport<ReactorNettyWebSocketSession.WebSocketConnection> {
 
 
-	protected ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound,
-			URI uri, NettyDataBufferFactory factory) {
+	public ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound,
+			HandshakeInfo handshakeInfo, NettyDataBufferFactory bufferFactory) {
 
-		super(new WebSocketConnection(inbound, outbound), uri, factory);
+		super(new WebSocketConnection(inbound, outbound), handshakeInfo, bufferFactory);
 	}
 
 

spring-web-reactive/src/main/java/org/springframework/web/reactive/socket/adapter/ReactorNettyWebSocketSession.java

@@ -16,8 +16,6 @@
 
 package org.springframework.web.reactive.socket.adapter;
 
-import java.net.URI;
-
 import io.netty.handler.codec.http.websocketx.WebSocketFrame;
 import io.reactivex.netty.protocol.http.ws.WebSocketConnection;
 import org.reactivestreams.Publisher;
@@ -41,8 +39,8 @@
 public class RxNettyWebSocketSession extends NettyWebSocketSessionSupport<WebSocketConnection> {
 
 
-	public RxNettyWebSocketSession(WebSocketConnection conn, URI uri, NettyDataBufferFactory factory) {
-		super(conn, uri, factory);
+	public RxNettyWebSocketSession(WebSocketConnection conn, HandshakeInfo info, NettyDataBufferFactory factory) {
+		super(conn, info, factory);
 	}