From 1cc36e5be9bb04450f924fc91c7b388c891048c2 Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Thu, 21 Jul 2022 23:54:38 +0200 Subject: [PATCH 1/2] Deprecate SockJsServiceRegistration#setSupressCors SockJsServiceRegistration#setSupressCors name contains a typo. It is now deprecated in favor of a correctly spelled method, setSuppressCors. See gh-28853 --- .../annotation/SockJsServiceRegistration.java | 13 +++++++++++++ ...bMvcStompWebSocketEndpointRegistrationTests.java | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java b/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java index 8b430c7a65b4..aa132f425d03 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java @@ -251,8 +251,21 @@ protected SockJsServiceRegistration setAllowedOriginPatterns(String... allowedOr * SockJS requests. *

The default value is "false". * @since 4.1.2 + * @deprecated as of 5.3.23, in favor of {@link #setSuppressCors(boolean)}, + * to be removed in Spring Framework 6.0 */ + @Deprecated public SockJsServiceRegistration setSupressCors(boolean suppressCors) { + return this.setSuppressCors(suppressCors); + } + + /** + * This option can be used to disable automatic addition of CORS headers for + * SockJS requests. + *

The default value is "false". + * @since 4.1.2 (was named {@code setSupressCors} prior to 5.3.23) + */ + public SockJsServiceRegistration setSuppressCors(boolean suppressCors) { this.suppressCors = suppressCors; return this; } diff --git a/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java b/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java index eeab9c04e4da..a1718b59d80e 100644 --- a/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java +++ b/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java @@ -166,7 +166,7 @@ public void disableCorsWithSockJsService() { WebMvcStompWebSocketEndpointRegistration registration = new WebMvcStompWebSocketEndpointRegistration(new String[] {"/foo"}, this.handler, this.scheduler); - registration.withSockJS().setSupressCors(true); + registration.withSockJS().setSuppressCors(true); MultiValueMap mappings = registration.getMappings(); assertThat(mappings.size()).isEqualTo(1); From 421b5cb3117efab4756247832a91802294ae3353 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Fri, 22 Jul 2022 16:07:12 +0200 Subject: [PATCH 2/2] Polish "Deprecate SockJsServiceRegistration#setSupressCors" See gh-28853 --- .../annotation/SockJsServiceRegistration.java | 19 +++++++++---------- ...ompWebSocketEndpointRegistrationTests.java | 2 +- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java b/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java index aa132f425d03..a64af7af146b 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/SockJsServiceRegistration.java @@ -250,24 +250,23 @@ protected SockJsServiceRegistration setAllowedOriginPatterns(String... allowedOr * This option can be used to disable automatic addition of CORS headers for * SockJS requests. *

The default value is "false". - * @since 4.1.2 - * @deprecated as of 5.3.23, in favor of {@link #setSuppressCors(boolean)}, - * to be removed in Spring Framework 6.0 + * @since 5.3.23 */ - @Deprecated - public SockJsServiceRegistration setSupressCors(boolean suppressCors) { - return this.setSuppressCors(suppressCors); + public SockJsServiceRegistration setSuppressCors(boolean suppressCors) { + this.suppressCors = suppressCors; + return this; } /** * This option can be used to disable automatic addition of CORS headers for * SockJS requests. *

The default value is "false". - * @since 4.1.2 (was named {@code setSupressCors} prior to 5.3.23) + * @since 4.1.2 + * @deprecated as of 5.3.23, in favor of {@link #setSuppressCors(boolean)} */ - public SockJsServiceRegistration setSuppressCors(boolean suppressCors) { - this.suppressCors = suppressCors; - return this; + @Deprecated + public SockJsServiceRegistration setSupressCors(boolean suppressCors) { + return this.setSuppressCors(suppressCors); } /** diff --git a/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java b/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java index a1718b59d80e..3129a68d4be9 100644 --- a/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java +++ b/spring-websocket/src/test/java/org/springframework/web/socket/config/annotation/WebMvcStompWebSocketEndpointRegistrationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2019 the original author or authors. + * Copyright 2002-2022 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.