From decb55ce14f71f195517a62c66ff1027537dc163 Mon Sep 17 00:00:00 2001 From: Sebastien Deleuze Date: Mon, 18 May 2015 10:53:15 +0200 Subject: [PATCH] Rename CrossOriginConfigurer/Registration to CorsConfigurer/Registration Issue: SPR-12933 --- ...ginConfigurer.java => CorsConfigurer.java} | 12 +++++----- ...egistration.java => CorsRegistration.java} | 16 ++++++------- .../DelegatingWebMvcConfiguration.java | 4 ++-- .../WebMvcConfigurationSupport.java | 8 +++---- .../config/annotation/WebMvcConfigurer.java | 2 +- .../annotation/WebMvcConfigurerAdapter.java | 2 +- .../annotation/WebMvcConfigurerComposite.java | 4 ++-- ...rerTests.java => CorsConfigurerTests.java} | 24 +++++++++---------- ...MvcConfigurationSupportExtensionTests.java | 4 ++-- 9 files changed, 38 insertions(+), 38 deletions(-) rename spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/{CrossOriginConfigurer.java => CorsConfigurer.java} (80%) rename spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/{CrossOriginRegistration.java => CorsRegistration.java} (83%) rename spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/{CrossOriginConfigurerTests.java => CorsConfigurerTests.java} (80%) diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurer.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsConfigurer.java similarity index 80% rename from spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurer.java rename to spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsConfigurer.java index bd62567018..82f687c6a5 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurer.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsConfigurer.java @@ -28,11 +28,11 @@ import org.springframework.web.cors.CorsConfiguration; * @author Sebastien Deleuze * * @since 4.2 - * @see CrossOriginRegistration + * @see CorsRegistration */ -public class CrossOriginConfigurer { +public class CorsConfigurer { - private final List registrations = new ArrayList(); + private final List registrations = new ArrayList(); /** * Enable cross origin requests on the specified path patterns. If no path pattern is specified, @@ -40,15 +40,15 @@ public class CrossOriginConfigurer { * *

By default, all origins, all headers and credentials are allowed. Max age is set to 30 minutes.

*/ - public CrossOriginRegistration enableCrossOrigin(String... pathPatterns) { - CrossOriginRegistration registration = new CrossOriginRegistration(pathPatterns); + public CorsRegistration enableCors(String... pathPatterns) { + CorsRegistration registration = new CorsRegistration(pathPatterns); this.registrations.add(registration); return registration; } protected Map getCorsConfigurations() { Map configs = new HashMap(); - for (CrossOriginRegistration registration : this.registrations) { + for (CorsRegistration registration : this.registrations) { for (String pathPattern : registration.getPathPatterns()) { configs.put(pathPattern, registration.getCorsConfiguration()); } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginRegistration.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsRegistration.java similarity index 83% rename from spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginRegistration.java rename to spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsRegistration.java index 2af6900931..96b44aadca 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CrossOriginRegistration.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/CorsRegistration.java @@ -32,13 +32,13 @@ import org.springframework.web.cors.CorsConfiguration; * @author Sebastien Deleuze * @since 4.2 */ -public class CrossOriginRegistration { +public class CorsRegistration { private final String[] pathPatterns; private final CorsConfiguration config; - public CrossOriginRegistration(String... pathPatterns) { + public CorsRegistration(String... pathPatterns) { this.pathPatterns = (pathPatterns.length == 0 ? new String[]{ "/**" } : pathPatterns); // Same default values than @CrossOrigin annotation + allows simple methods this.config = new CorsConfiguration(); @@ -51,32 +51,32 @@ public class CrossOriginRegistration { this.config.setMaxAge(1800L); } - public CrossOriginRegistration allowedOrigins(String... origins) { + public CorsRegistration allowedOrigins(String... origins) { this.config.setAllowedOrigins(new ArrayList(Arrays.asList(origins))); return this; } - public CrossOriginRegistration allowedMethods(String... methods) { + public CorsRegistration allowedMethods(String... methods) { this.config.setAllowedMethods(new ArrayList(Arrays.asList(methods))); return this; } - public CrossOriginRegistration allowedHeaders(String... headers) { + public CorsRegistration allowedHeaders(String... headers) { this.config.setAllowedHeaders(new ArrayList(Arrays.asList(headers))); return this; } - public CrossOriginRegistration exposedHeaders(String... headers) { + public CorsRegistration exposedHeaders(String... headers) { this.config.setExposedHeaders(new ArrayList(Arrays.asList(headers))); return this; } - public CrossOriginRegistration maxAge(long maxAge) { + public CorsRegistration maxAge(long maxAge) { this.config.setMaxAge(maxAge); return this; } - public CrossOriginRegistration allowCredentials(boolean allowCredentials) { + public CorsRegistration allowCredentials(boolean allowCredentials) { this.config.setAllowCredentials(allowCredentials); return this; } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.java index ea0724daff..521fe8343f 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.java @@ -133,8 +133,8 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { } @Override - protected void configureCrossOrigin(CrossOriginConfigurer configurer) { - this.configurers.configureCrossOrigin(configurer); + protected void configureCors(CorsConfigurer configurer) { + this.configurers.configureCors(configurer); } } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java index b3f57793cf..c11bc7d47d 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java @@ -875,8 +875,8 @@ public class WebMvcConfigurationSupport implements ApplicationContextAware, Serv */ protected final Map getCorsConfigurations() { if (this.corsConfigurations == null) { - CrossOriginConfigurer registry = new CrossOriginConfigurer(); - configureCrossOrigin(registry); + CorsConfigurer registry = new CorsConfigurer(); + configureCors(registry); this.corsConfigurations = registry.getCorsConfigurations(); } return this.corsConfigurations; @@ -885,9 +885,9 @@ public class WebMvcConfigurationSupport implements ApplicationContextAware, Serv /** * Override this method to configure cross-origin requests handling. * @since 4.2 - * @see CrossOriginConfigurer + * @see CorsConfigurer */ - protected void configureCrossOrigin(CrossOriginConfigurer configurer) { + protected void configureCors(CorsConfigurer configurer) { } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java index a9a40502ec..8f5114a6dc 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java @@ -186,6 +186,6 @@ public interface WebMvcConfigurer { * Configure cross-origin requests handling. * @since 4.2 */ - void configureCrossOrigin(CrossOriginConfigurer configurer); + void configureCors(CorsConfigurer configurer); } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerAdapter.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerAdapter.java index 46a79fb1a5..885b5eced6 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerAdapter.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerAdapter.java @@ -170,7 +170,7 @@ public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer { *

This implementation is empty. */ @Override - public void configureCrossOrigin(CrossOriginConfigurer configurer) { + public void configureCors(CorsConfigurer configurer) { } } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerComposite.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerComposite.java index ed5c65e753..c845683782 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerComposite.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurerComposite.java @@ -154,9 +154,9 @@ class WebMvcConfigurerComposite implements WebMvcConfigurer { } @Override - public void configureCrossOrigin(CrossOriginConfigurer configurer) { + public void configureCors(CorsConfigurer configurer) { for (WebMvcConfigurer delegate : this.delegates) { - delegate.configureCrossOrigin(configurer); + delegate.configureCors(configurer); } } diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurerTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CorsConfigurerTests.java similarity index 80% rename from spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurerTests.java rename to spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CorsConfigurerTests.java index 09f91f57d0..4b12feba24 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CrossOriginConfigurerTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/CorsConfigurerTests.java @@ -27,34 +27,34 @@ import org.junit.Test; import org.springframework.web.cors.CorsConfiguration; /** - * Test fixture with a {@link CrossOriginConfigurer}. + * Test fixture with a {@link CorsConfigurer}. * * @author Sebastien Deleuze */ -public class CrossOriginConfigurerTests { +public class CorsConfigurerTests { - private CrossOriginConfigurer configurer; + private CorsConfigurer configurer; @Before public void setUp() { - this.configurer = new CrossOriginConfigurer(); + this.configurer = new CorsConfigurer(); } @Test - public void noCrossOriginConfigured() { + public void noCorsConfigured() { assertTrue(this.configurer.getCorsConfigurations().isEmpty()); } @Test - public void multipleCrossOriginConfigured() { - this.configurer.enableCrossOrigin("/foo"); - this.configurer.enableCrossOrigin("/bar"); + public void multipleCorsConfigured() { + this.configurer.enableCors("/foo"); + this.configurer.enableCors("/bar"); assertEquals(2, this.configurer.getCorsConfigurations().size()); } @Test - public void defaultCrossOriginRegistration() { - this.configurer.enableCrossOrigin(); + public void defaultCorsRegistration() { + this.configurer.enableCors(); Map configs = this.configurer.getCorsConfigurations(); assertEquals(1, configs.size()); CorsConfiguration config = configs.get("/**"); @@ -66,8 +66,8 @@ public class CrossOriginConfigurerTests { } @Test - public void customizedCrossOriginRegistration() { - this.configurer.enableCrossOrigin("/foo").allowedOrigins("http://domain2.com", "http://domain2.com") + public void customizedCorsRegistration() { + this.configurer.enableCors("/foo").allowedOrigins("http://domain2.com", "http://domain2.com") .allowedMethods("DELETE").allowCredentials(false).allowedHeaders("header1", "header2") .exposedHeaders("header3", "header4").maxAge(3600); Map configs = this.configurer.getCorsConfigurations(); diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java index 76868d3752..d61fc90e84 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupportExtensionTests.java @@ -404,8 +404,8 @@ public class WebMvcConfigurationSupportExtensionTests { } @Override - public void configureCrossOrigin(CrossOriginConfigurer registry) { - registry.enableCrossOrigin("/resources/**"); + public void configureCors(CorsConfigurer registry) { + registry.enableCors("/resources/**"); } }