Calling {@link #setContextInitializerClasses} (init-param 'contextInitializerClasses') * indicates which {@link ApplicationContextInitializer} classes should be used to - * further configure the internal application context prior to refresh(). + * further configure the internal application context prior to refresh. * @see #FrameworkServlet(WebApplicationContext) */ public FrameworkServlet() { @@ -275,7 +275,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic * ConfigurableApplicationContext#setParent parent}, the root application context * will be set as the parent. *
Default is "false", applying {@link jakarta.servlet.http.HttpServlet}'s * default behavior (i.e. reflecting the message received back to the client). *
Turn this flag on if you prefer TRACE requests to go through the - * regular dispatching chain, just like other HTTP requests. This usually - * means that your controllers will receive those requests; make sure - * that those endpoints are actually able to handle a TRACE request. + * regular dispatching chain, just like other HTTP requests. This usually means + * that your controllers will receive those requests, in which case you must + * make sure that those endpoints are actually able to handle a TRACE request. *
Note that HttpServlet's default TRACE processing will be applied * in any case if your controllers happen to not generate a response * of content type 'message/http' (as required for a TRACE response). @@ -484,9 +484,9 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Whether to log request params at DEBUG level, and headers at TRACE level. + * Set whether to log request parameters at DEBUG level and headers at TRACE level. * Both may contain sensitive information. - *
By default set to {@code false} so that request details are not shown. + *
Defaults to {@code false} so that request details are not shown. * @param enable whether to enable or not * @since 5.1 */ @@ -495,7 +495,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Whether logging of potentially sensitive, request details at DEBUG and + * Whether logging of potentially sensitive request details at DEBUG and * TRACE level is allowed. * @since 5.1 */ @@ -574,7 +574,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic wac = this.webApplicationContext; if (wac instanceof ConfigurableWebApplicationContext cwac && !cwac.isActive()) { // The context has not yet been refreshed -> provide services such as - // setting the parent context, setting the application context id, etc + // setting the parent context, setting the application context ID, etc if (cwac.getParent() == null) { // The context instance was injected without an explicit parent -> set // the root application context (if any; may be null) as the parent @@ -587,7 +587,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic // No context instance was injected at construction time -> see if one // has been registered in the servlet context. If one exists, it is assumed // that the parent context (if any) has already been set and that the - // user has performed any initialization such as setting the context id + // user has performed any initialization such as setting the context ID wac = findWebApplicationContext(); } if (wac == null) { @@ -676,13 +676,13 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) { if (ObjectUtils.identityToString(wac).equals(wac.getId())) { - // The application context id is still set to its original default value - // -> assign a more useful id based on available information + // The application context ID is still set to its original default value + // -> assign a more useful ID based on available information if (this.contextId != null) { wac.setId(this.contextId); } else { - // Generate default id... + // Generate default ID... wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + ObjectUtils.getDisplayString(getServletContext().getContextPath()) + '/' + getServletName()); } @@ -890,7 +890,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate GET requests to processRequest/doService. + * Delegate {@code GET} requests to processRequest/doService. *
Will also be invoked by HttpServlet's default implementation of {@code doHead}, * with a {@code NoBodyResponse} that just captures the content length. * @see #doService @@ -904,7 +904,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate POST requests to {@link #processRequest}. + * Delegate {@code POST} requests to {@link #processRequest}. * @see #doService */ @Override @@ -915,7 +915,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate PUT requests to {@link #processRequest}. + * Delegate {@code PUT} requests to {@link #processRequest}. * @see #doService */ @Override @@ -926,7 +926,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate DELETE requests to {@link #processRequest}. + * Delegate {@code DELETE} requests to {@link #processRequest}. * @see #doService */ @Override @@ -937,7 +937,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate OPTIONS requests to {@link #processRequest}, if desired. + * Delegate {@code OPTIONS} requests to {@link #processRequest}, if desired. *
Applies HttpServlet's standard OPTIONS processing otherwise, * and also if there is still no 'Allow' header set after dispatching. * @see #doService @@ -967,7 +967,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic } /** - * Delegate TRACE requests to {@link #processRequest}, if desired. + * Delegate {@code TRACE} requests to {@link #processRequest}, if desired. *
Applies HttpServlet's standard TRACE processing otherwise. * @see #doService */ @@ -1171,7 +1171,9 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic /** * Subclasses must implement this method to do the work of request handling, - * receiving a centralized callback for GET, POST, PUT and DELETE. + * receiving a centralized callback for {@code GET}, {@code POST}, {@code PUT}, + * {@code DELETE}, {@code OPTIONS}, and {@code TRACE} requests as well as for + * requests using non-standard HTTP methods (such as WebDAV). *
The contract is essentially the same as that for the commonly overridden * {@code doGet} or {@code doPost} methods of HttpServlet. *
This class intercepts calls to ensure that exception handling and diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/HttpServletBean.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/HttpServletBean.java index d3576911637..7d8642e9d89 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/HttpServletBean.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/HttpServletBean.java @@ -55,7 +55,7 @@ import org.springframework.web.context.support.StandardServletEnvironment; * parameters is automatic, with the corresponding setter method getting * invoked with the converted value. It is also possible for subclasses to * specify required properties. Parameters without matching bean property - * setter will simply be ignored. + * setters will simply be ignored. * *
This servlet leaves request handling to subclasses, inheriting the default * behavior of HttpServlet ({@code doGet}, {@code doPost}, etc). @@ -69,7 +69,7 @@ import org.springframework.web.context.support.StandardServletEnvironment; * *
The {@link FrameworkServlet} class is a more specific servlet base * class which loads its own application context. FrameworkServlet serves - * as direct base class of Spring's full-fledged {@link DispatcherServlet}. + * as the direct base class of Spring's full-fledged {@link DispatcherServlet}. * * @author Rod Johnson * @author Juergen Hoeller @@ -107,6 +107,7 @@ public abstract class HttpServletBean extends HttpServlet implements Environment * Set the {@code Environment} that this servlet runs in. *
Any environment set here overrides the {@link StandardServletEnvironment} * provided by default. + * @since 3.1 * @throws IllegalArgumentException if environment is not assignable to * {@code ConfigurableEnvironment} */ @@ -120,6 +121,7 @@ public abstract class HttpServletBean extends HttpServlet implements Environment * Return the {@link Environment} associated with this servlet. *
If none specified, a default environment will be initialized via * {@link #createEnvironment()}. + * @since 3.1 */ @Override public ConfigurableEnvironment getEnvironment() { @@ -133,6 +135,7 @@ public abstract class HttpServletBean extends HttpServlet implements Environment * Create and return a new {@link StandardServletEnvironment}. *
Subclasses may override this in order to configure the environment or * specialize the environment type returned. + * @since 3.1 */ protected ConfigurableEnvironment createEnvironment() { return new StandardServletEnvironment();