Deprecate methods in ReactorNettyWebSocketClient

Closes gh-25049
This commit is contained in:
Johnny Lim 2020-05-12 21:40:04 +09:00 committed by Rossen Stoyanchev
parent 6d6269f1ee
commit 30351c257c
2 changed files with 17 additions and 7 deletions

View File

@ -34,7 +34,6 @@ import org.springframework.util.StringUtils;
import org.springframework.web.reactive.socket.HandshakeInfo; import org.springframework.web.reactive.socket.HandshakeInfo;
import org.springframework.web.reactive.socket.WebSocketHandler; import org.springframework.web.reactive.socket.WebSocketHandler;
import org.springframework.web.reactive.socket.WebSocketSession; import org.springframework.web.reactive.socket.WebSocketSession;
import org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport;
import org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession; import org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession;
/** /**
@ -53,7 +52,7 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
private final Supplier<WebsocketClientSpec.Builder> specBuilderSupplier; private final Supplier<WebsocketClientSpec.Builder> specBuilderSupplier;
@Nullable @Nullable
private Integer maxFramePayloadLength = NettyWebSocketSessionSupport.DEFAULT_FRAME_MAX_SIZE; private Integer maxFramePayloadLength;
@Nullable @Nullable
private Boolean handlePing; private Boolean handlePing;
@ -67,7 +66,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
} }
/** /**
* Constructor that accepts an existing {@link HttpClient}. * Constructor that accepts an existing {@link HttpClient} builder
* with a default {@link WebsocketClientSpec.Builder}.
* @since 5.1 * @since 5.1
*/ */
public ReactorNettyWebSocketClient(HttpClient httpClient) { public ReactorNettyWebSocketClient(HttpClient httpClient) {
@ -75,8 +75,8 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
} }
/** /**
* Constructor with an {@link HttpClient} and a supplier for the * Constructor that accepts an existing {@link HttpClient} builder
* {@link WebsocketClientSpec.Builder} to use. * and a pre-configured {@link WebsocketClientSpec.Builder}.
* @since 5.3 * @since 5.3
*/ */
public ReactorNettyWebSocketClient( public ReactorNettyWebSocketClient(
@ -131,7 +131,10 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* <p>By default set to 65536 (64K). * <p>By default set to 65536 (64K).
* @param maxFramePayloadLength the max length for frames. * @param maxFramePayloadLength the max length for frames.
* @since 5.2 * @since 5.2
* @deprecated as of 5.3 in favor of providing a supplier of
* {@link WebsocketClientSpec.Builder} with a constructor argument.
*/ */
@Deprecated
public void setMaxFramePayloadLength(int maxFramePayloadLength) { public void setMaxFramePayloadLength(int maxFramePayloadLength) {
this.maxFramePayloadLength = maxFramePayloadLength; this.maxFramePayloadLength = maxFramePayloadLength;
} }
@ -139,7 +142,9 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/** /**
* Return the configured {@link #setMaxFramePayloadLength(int) maxFramePayloadLength}. * Return the configured {@link #setMaxFramePayloadLength(int) maxFramePayloadLength}.
* @since 5.2 * @since 5.2
* @deprecated as of 5.3 in favor of {@link #getWebsocketClientSpec()}
*/ */
@Deprecated
public int getMaxFramePayloadLength() { public int getMaxFramePayloadLength() {
return getWebsocketClientSpec().maxFramePayloadLength(); return getWebsocketClientSpec().maxFramePayloadLength();
} }
@ -154,7 +159,10 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
* frames will be passed through to the {@link WebSocketHandler}. * frames will be passed through to the {@link WebSocketHandler}.
* @param handlePing whether to let Ping frames through for handling * @param handlePing whether to let Ping frames through for handling
* @since 5.2.4 * @since 5.2.4
* @deprecated as of 5.3 in favor of providing a supplier of
* {@link WebsocketClientSpec.Builder} with a constructor argument.
*/ */
@Deprecated
public void setHandlePing(boolean handlePing) { public void setHandlePing(boolean handlePing) {
this.handlePing = handlePing; this.handlePing = handlePing;
} }
@ -162,7 +170,9 @@ public class ReactorNettyWebSocketClient implements WebSocketClient {
/** /**
* Return the configured {@link #setHandlePing(boolean)}. * Return the configured {@link #setHandlePing(boolean)}.
* @since 5.2.4 * @since 5.2.4
* @deprecated as of 5.3 in favor of {@link #getWebsocketClientSpec()}
*/ */
@Deprecated
public boolean getHandlePing() { public boolean getHandlePing() {
return getWebsocketClientSpec().handlePing(); return getWebsocketClientSpec().handlePing();
} }

View File

@ -108,7 +108,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param maxFramePayloadLength the max length for frames. * @param maxFramePayloadLength the max length for frames.
* @since 5.1 * @since 5.1
* @deprecated as of 5.2.6 in favor of providing a supplier of * @deprecated as of 5.2.6 in favor of providing a supplier of
* {@link WebsocketServerSpec.Builder} wiht a constructor argument. * {@link WebsocketServerSpec.Builder} with a constructor argument.
*/ */
@Deprecated @Deprecated
public void setMaxFramePayloadLength(Integer maxFramePayloadLength) { public void setMaxFramePayloadLength(Integer maxFramePayloadLength) {
@ -136,7 +136,7 @@ public class ReactorNettyRequestUpgradeStrategy implements RequestUpgradeStrateg
* @param handlePing whether to let Ping frames through for handling * @param handlePing whether to let Ping frames through for handling
* @since 5.2.4 * @since 5.2.4
* @deprecated as of 5.2.6 in favor of providing a supplier of * @deprecated as of 5.2.6 in favor of providing a supplier of
* {@link WebsocketServerSpec.Builder} wiht a constructor argument. * {@link WebsocketServerSpec.Builder} with a constructor argument.
*/ */
@Deprecated @Deprecated
public void setHandlePing(boolean handlePing) { public void setHandlePing(boolean handlePing) {