root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Polishing contribution 

See gh-28779
This commit is contained in:
rstoyanchev 2022-09-28 13:08:55 +01:00
parent 7ea49fa9f4
commit 075fccca94
2 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
spring-webmvc/src/main/java/org/springframework/web/servlet/i18n/CookieLocaleResolver.java
View File

@ -88,26 +88,15 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
*/ */
public static final String DEFAULT_COOKIE_NAME = CookieLocaleResolver.class.getName() + ".LOCALE"; public static final String DEFAULT_COOKIE_NAME = CookieLocaleResolver.class.getName() + ".LOCALE";
/**
* The default cookie max age (persists until browser shutdown) if none is
* explicitly set.
*/
public static final Duration DEFAULT_COOKIE_MAX_AGE = Duration.ofSeconds(-1);
/**
* The default cookie path used if none is explicitly set.
*/
public static final String DEFAULT_COOKIE_PATH = "/";
private static final Log logger = LogFactory.getLog(CookieLocaleResolver.class); private static final Log logger = LogFactory.getLog(CookieLocaleResolver.class);
private String cookieName; private String cookieName;
private Duration cookieMaxAge = DEFAULT_COOKIE_MAX_AGE; private Duration cookieMaxAge = Duration.ofSeconds(-1);
@Nullable @Nullable
private String cookiePath = DEFAULT_COOKIE_PATH; private String cookiePath = "/";
@Nullable @Nullable
private String cookieDomain; private String cookieDomain;
@ -131,9 +120,7 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
/** /**
* Create a new instance of {@link CookieLocaleResolver} using the supplied * Constructor with a given cookie name.
* cookie name.
* @param cookieName the cookie name
* @since 6.0 * @since 6.0
*/ */
public CookieLocaleResolver(String cookieName) { public CookieLocaleResolver(String cookieName) {
@ -142,8 +129,7 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
} }
/** /**
* Create a new instance of {@link CookieLocaleResolver} using the * Constructor with a {@linkplain #DEFAULT_COOKIE_NAME default cookie name}.
* {@linkplain #DEFAULT_COOKIE_NAME default cookie name}.
*/ */
public CookieLocaleResolver() { public CookieLocaleResolver() {
this(DEFAULT_COOKIE_NAME); this(DEFAULT_COOKIE_NAME);
@ -153,7 +139,7 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
/** /**
* Set the name of cookie created by this resolver. * Set the name of cookie created by this resolver.
* @param cookieName the cookie name * @param cookieName the cookie name
* @deprecated since 6.0, in favor of {@link #CookieLocaleResolver(String)} * @deprecated as of 6.0 in favor of {@link #CookieLocaleResolver(String)}
*/ */
@Deprecated @Deprecated
public void setCookieName(String cookieName) { public void setCookieName(String cookieName) {
@ -163,6 +149,8 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
/** /**
* Set the cookie "Max-Age" attribute. * Set the cookie "Max-Age" attribute.
* <p>By default, this is set to -1 in which case the cookie persists until
* browser shutdown.
* @since 6.0 * @since 6.0
* @see org.springframework.http.ResponseCookie.ResponseCookieBuilder#maxAge(Duration) * @see org.springframework.http.ResponseCookie.ResponseCookieBuilder#maxAge(Duration)
*/ */
@ -172,8 +160,8 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
} }
/** /**
* Variant of {@link #setCookieMaxAge(Duration)} accepting a value in * Variant of {@link #setCookieMaxAge(Duration)} with a value in seconds.
* seconds. * @deprecated as of 6.0 in favor of {@link #setCookieMaxAge(Duration)}
*/ */
@Deprecated @Deprecated
public void setCookieMaxAge(@Nullable Integer cookieMaxAge) { public void setCookieMaxAge(@Nullable Integer cookieMaxAge) {
@ -182,6 +170,7 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
/** /**
* Set the cookie "Path" attribute. * Set the cookie "Path" attribute.
* <p>By default, this is set to {@code "/"}.
* @see org.springframework.http.ResponseCookie.ResponseCookieBuilder#path(String) * @see org.springframework.http.ResponseCookie.ResponseCookieBuilder#path(String)
*/ */
public void setCookiePath(@Nullable String cookiePath) { public void setCookiePath(@Nullable String cookiePath) {

6
spring-webmvc/src/test/java/org/springframework/web/servlet/i18n/CookieLocaleResolverTests.java
View File

@ -148,7 +148,7 @@ class CookieLocaleResolverTests {
assertThat(cookie).isNotNull(); assertThat(cookie).isNotNull();
assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME); assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME);
assertThat(cookie.getDomain()).isNull(); assertThat(cookie.getDomain()).isNull();
assertThat(cookie.getPath()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_PATH); assertThat(cookie.getPath()).isEqualTo("/");
assertThat(cookie.getSecure()).isFalse(); assertThat(cookie.getSecure()).isFalse();
assertThat(cookie.getSameSite()).isEqualTo("Lax"); assertThat(cookie.getSameSite()).isEqualTo("Lax");
@ -216,7 +216,7 @@ class CookieLocaleResolverTests {
assertThat(cookie).isNotNull(); assertThat(cookie).isNotNull();
assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME); assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME);
assertThat(cookie.getDomain()).isNull(); assertThat(cookie.getDomain()).isNull();
assertThat(cookie.getPath()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_PATH); assertThat(cookie.getPath()).isEqualTo("/");
assertThat(cookie.getSecure()).isFalse(); assertThat(cookie.getSecure()).isFalse();
assertThat(cookie.getSameSite()).isEqualTo("Lax"); assertThat(cookie.getSameSite()).isEqualTo("Lax");
assertThat(cookie.getValue()).isEqualTo("de-AT"); assertThat(cookie.getValue()).isEqualTo("de-AT");
@ -239,7 +239,7 @@ class CookieLocaleResolverTests {
assertThat(cookie).isNotNull(); assertThat(cookie).isNotNull();
assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME); assertThat(cookie.getName()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_NAME);
assertThat(cookie.getDomain()).isNull(); assertThat(cookie.getDomain()).isNull();
assertThat(cookie.getPath()).isEqualTo(CookieLocaleResolver.DEFAULT_COOKIE_PATH); assertThat(cookie.getPath()).isEqualTo("/");
assertThat(cookie.getSecure()).isFalse(); assertThat(cookie.getSecure()).isFalse();
assertThat(cookie.getSameSite()).isEqualTo("Lax"); assertThat(cookie.getSameSite()).isEqualTo("Lax");
assertThat(cookie.getValue()).isEqualTo("de_AT"); assertThat(cookie.getValue()).isEqualTo("de_AT");