org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties Maven / Gradle / Ivy
/*
* Copyright 2012-2023 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
*
* https://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.boot.autoconfigure.web.reactive;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
import org.springframework.util.StringUtils;
/**
* {@link ConfigurationProperties properties} for Spring WebFlux.
*
* @author Brian Clozel
* @since 2.0.0
*/
@ConfigurationProperties(prefix = "spring.webflux")
public class WebFluxProperties {
/**
* Base path for all web handlers.
*/
private String basePath;
private final Format format = new Format();
private final Session session = new Session();
/**
* Path pattern used for static resources.
*/
private String staticPathPattern = "/**";
public String getBasePath() {
return this.basePath;
}
public void setBasePath(String basePath) {
this.basePath = cleanBasePath(basePath);
}
private String cleanBasePath(String basePath) {
String candidate = StringUtils.trimWhitespace(basePath);
if (StringUtils.hasText(candidate)) {
if (!candidate.startsWith("/")) {
candidate = "/" + candidate;
}
if (candidate.endsWith("/")) {
candidate = candidate.substring(0, candidate.length() - 1);
}
}
return candidate;
}
public Format getFormat() {
return this.format;
}
@DeprecatedConfigurationProperty(replacement = "server.reactive.session")
public Session getSession() {
return this.session;
}
public String getStaticPathPattern() {
return this.staticPathPattern;
}
public void setStaticPathPattern(String staticPathPattern) {
this.staticPathPattern = staticPathPattern;
}
public static class Format {
/**
* Date format to use, for example 'dd/MM/yyyy'.
*/
private String date;
/**
* Time format to use, for example 'HH:mm:ss'.
*/
private String time;
/**
* Date-time format to use, for example 'yyyy-MM-dd HH:mm:ss'.
*/
private String dateTime;
public String getDate() {
return this.date;
}
public void setDate(String date) {
this.date = date;
}
public String getTime() {
return this.time;
}
public void setTime(String time) {
this.time = time;
}
public String getDateTime() {
return this.dateTime;
}
public void setDateTime(String dateTime) {
this.dateTime = dateTime;
}
}
/**
* Session properties.
*
* @deprecated since 2.6.0 for removal in 3.0.0 in favor of
* {@code server.reactive.session}.
*/
@Deprecated
public static class Session {
private final Cookie cookie = new Cookie();
@DeprecatedConfigurationProperty(replacement = "server.reactive.session.cookie")
public Cookie getCookie() {
return this.cookie;
}
}
/**
* Session cookie properties.
*
* @deprecated since 2.6.0 for removal in 3.0.0 in favor of
* {@link org.springframework.boot.web.server.Cookie}.
*/
@Deprecated
public static class Cookie {
/**
* SameSite attribute value for session Cookies.
*/
private SameSite sameSite;
@DeprecatedConfigurationProperty(replacement = "server.reactive.session.cookie.same-site")
public SameSite getSameSite() {
return this.sameSite;
}
public void setSameSite(SameSite sameSite) {
this.sameSite = sameSite;
}
}
/**
* SameSite values.
*
* @deprecated since 2.6.0 for removal in 3.0.0 in favor of
* {@link org.springframework.boot.web.server.Cookie.SameSite}.
*/
@Deprecated
public enum SameSite {
/**
* Cookies are sent in both first-party and cross-origin requests.
*/
NONE("None"),
/**
* Cookies are sent in a first-party context, also when following a link to the
* origin site.
*/
LAX("Lax"),
/**
* Cookies are only sent in a first-party context (i.e. not when following a link
* to the origin site).
*/
STRICT("Strict");
private final String attribute;
SameSite(String attribute) {
this.attribute = attribute;
}
public String attribute() {
return this.attribute;
}
}
}