类 RequestContext

字段详细资料

• DEFAULT_THEME_NAME

  public static final String DEFAULT_THEME_NAME

  Default theme name used if the RequestContext cannot find a ThemeResolver. Only applies to non-DispatcherServlet requests.

  Same as AbstractThemeResolver's default, but not linked in here to avoid package interdependencies.

  另请参阅:

  AbstractThemeResolver.ORIGINAL_DEFAULT_THEME_NAME, 常量字段值

• WEB_APPLICATION_CONTEXT_ATTRIBUTE

  public static final String WEB_APPLICATION_CONTEXT_ATTRIBUTE

  Request attribute to hold the current web application context for RequestContext usage. By default, the DispatcherServlet's context (or the root context as fallback) is exposed.

• jstlPresent

  protected static final boolean jstlPresent

构造器详细资料

• RequestContext

  public RequestContext​(HttpServletRequest request)

  Create a new RequestContext for the given request, using the request attributes for Errors retrieval.

  This only works with InternalResourceViews, as Errors instances are part of the model and not normally exposed as request attributes. It will typically be used within JSPs or custom tags.

  Will only work within a DispatcherServlet request. Pass in a ServletContext to be able to fallback to the root WebApplicationContext.

  参数:

  request - current HTTP request

  另请参阅:

  DispatcherServlet, RequestContext(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext)

• RequestContext

  public RequestContext​(HttpServletRequest request,
                        HttpServletResponse response)

  Create a new RequestContext for the given request, using the request attributes for Errors retrieval.

  This only works with InternalResourceViews, as Errors instances are part of the model and not normally exposed as request attributes. It will typically be used within JSPs or custom tags.

  Will only work within a DispatcherServlet request. Pass in a ServletContext to be able to fallback to the root WebApplicationContext.

  参数:

  request - current HTTP request

  response - current HTTP response

  另请参阅:

  DispatcherServlet, RequestContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext, Map)

• RequestContext

  public RequestContext​(HttpServletRequest request,
                        @Nullable
                        ServletContext servletContext)

  Create a new RequestContext for the given request, using the request attributes for Errors retrieval.

  This only works with InternalResourceViews, as Errors instances are part of the model and not normally exposed as request attributes. It will typically be used within JSPs or custom tags.

  If a ServletContext is specified, the RequestContext will also work with the root WebApplicationContext (outside a DispatcherServlet).

  参数:

  request - current HTTP request

  servletContext - the servlet context of the web application (can be null; necessary for fallback to root WebApplicationContext)

  另请参阅:

  WebApplicationContext, DispatcherServlet

• RequestContext

  public RequestContext​(HttpServletRequest request,
                        @Nullable
                        Map<String,​Object> model)

  Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.

  This works with all View implementations. It will typically be used by View implementations.

  Will only work within a DispatcherServlet request. Pass in a ServletContext to be able to fallback to the root WebApplicationContext.

  参数:

  request - current HTTP request

  model - the model attributes for the current view (can be null, using the request attributes for Errors retrieval)

  另请参阅:

  DispatcherServlet, RequestContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext, Map)

• RequestContext

  public RequestContext​(HttpServletRequest request,
                        @Nullable
                        HttpServletResponse response,
                        @Nullable
                        ServletContext servletContext,
                        @Nullable
                        Map<String,​Object> model)

  Create a new RequestContext for the given request, using the given model attributes for Errors retrieval.

  This works with all View implementations. It will typically be used by View implementations.

  If a ServletContext is specified, the RequestContext will also work with a root WebApplicationContext (outside a DispatcherServlet).

  参数:

  request - current HTTP request

  response - current HTTP response

  servletContext - the servlet context of the web application (can be null; necessary for fallback to root WebApplicationContext)

  model - the model attributes for the current view (can be null, using the request attributes for Errors retrieval)

  另请参阅:

  WebApplicationContext, DispatcherServlet

方法详细资料

• getRequest

  protected final HttpServletRequest getRequest()

  Return the underlying HttpServletRequest. Only intended for cooperating classes in this package.

• getServletContext

  @Nullable
  protected final ServletContext getServletContext()

  Return the underlying ServletContext. Only intended for cooperating classes in this package.

• getWebApplicationContext

  public final WebApplicationContext getWebApplicationContext()

  Return the current WebApplicationContext.

• getMessageSource

  public final MessageSource getMessageSource()

  Return the current WebApplicationContext as MessageSource.

• getModel

  @Nullable
  public final Map<String,​Object> getModel()

  Return the model Map that this RequestContext encapsulates, if any.

  返回:

  the populated model Map, or null if none available

• getLocale

  public final Locale getLocale()

  Return the current Locale (falling back to the request locale; never null).

  Typically coming from a DispatcherServlet's LocaleResolver. Also includes a fallback check for JSTL's Locale attribute.

  另请参阅:

  RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)

• getTimeZone

  @Nullable
  public TimeZone getTimeZone()

  Return the current TimeZone (or null if none derivable from the request).

  Typically coming from a DispatcherServlet's LocaleContextResolver. Also includes a fallback check for JSTL's TimeZone attribute.

  另请参阅:

  RequestContextUtils.getTimeZone(javax.servlet.http.HttpServletRequest)

• getFallbackLocale

  protected Locale getFallbackLocale()

  Determine the fallback locale for this context.

  The default implementation checks for a JSTL locale attribute in request, session or application scope; if not found, returns the HttpServletRequest.getLocale().

  返回:

  the fallback locale (never null)

  另请参阅:

  ServletRequest.getLocale()

• getFallbackTimeZone

  @Nullable
  protected TimeZone getFallbackTimeZone()

  Determine the fallback time zone for this context.

  The default implementation checks for a JSTL time zone attribute in request, session or application scope; returns null if not found.

  返回:

  the fallback time zone (or null if none derivable from the request)

• changeLocale

  public void changeLocale​(Locale locale)

  Change the current locale to the specified one, storing the new locale through the configured LocaleResolver.

  参数:

  locale - the new locale

  另请参阅:

  LocaleResolver.setLocale(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Locale), changeLocale(java.util.Locale, java.util.TimeZone)

• changeLocale

  public void changeLocale​(Locale locale,
                           TimeZone timeZone)

  Change the current locale to the specified locale and time zone context, storing the new locale context through the configured LocaleResolver.

  参数:

  locale - the new locale

  timeZone - the new time zone

  另请参阅:

  LocaleContextResolver.setLocaleContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.context.i18n.LocaleContext), SimpleTimeZoneAwareLocaleContext

• getTheme

  public Theme getTheme()

  Return the current theme (never null).

  Resolved lazily for more efficiency when theme support is not being used.

• getFallbackTheme

  protected Theme getFallbackTheme()

  Determine the fallback theme for this context.

  The default implementation returns the default theme (with name "theme").

  返回:

  the fallback theme (never null)

• changeTheme

  public void changeTheme​(@Nullable
                          Theme theme)

  Change the current theme to the specified one, storing the new theme name through the configured ThemeResolver.

  参数:

  theme - the new theme

  另请参阅:

  ThemeResolver.setThemeName(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)

• changeTheme

  public void changeTheme​(String themeName)

  Change the current theme to the specified theme by name, storing the new theme name through the configured ThemeResolver.

  参数:

  themeName - the name of the new theme

  另请参阅:

  ThemeResolver.setThemeName(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)

• setDefaultHtmlEscape

  public void setDefaultHtmlEscape​(boolean defaultHtmlEscape)

  (De)activate default HTML escaping for messages and errors, for the scope of this RequestContext.

  The default is the application-wide setting (the "defaultHtmlEscape" context-param in web.xml).

  另请参阅:

  WebUtils.getDefaultHtmlEscape(javax.servlet.ServletContext)

• isDefaultHtmlEscape

  public boolean isDefaultHtmlEscape()

  Is default HTML escaping active? Falls back to false in case of no explicit default given.

• getDefaultHtmlEscape

  @Nullable
  public Boolean getDefaultHtmlEscape()

  Return the default HTML escape setting, differentiating between no default specified and an explicit value.

  返回:

  whether default HTML escaping is enabled (null = no explicit default)

• isResponseEncodedHtmlEscape

  public boolean isResponseEncodedHtmlEscape()

  Is HTML escaping using the response encoding by default? If enabled, only XML markup significant characters will be escaped with UTF-* encodings.

  Falls back to true in case of no explicit default given, as of Spring 4.2.

  从以下版本开始:

  4.1.2

• getResponseEncodedHtmlEscape

  @Nullable
  public Boolean getResponseEncodedHtmlEscape()

  Return the default setting about use of response encoding for HTML escape setting, differentiating between no default specified and an explicit value.

  返回:

  whether default use of response encoding HTML escaping is enabled (null = no explicit default)

  从以下版本开始:

  4.1.2

• setUrlPathHelper

  public void setUrlPathHelper​(UrlPathHelper urlPathHelper)

  Set the UrlPathHelper to use for context path and request URI decoding. Can be used to pass a shared UrlPathHelper instance in.

  A default UrlPathHelper is always available.

• getUrlPathHelper

  public UrlPathHelper getUrlPathHelper()

  Return the UrlPathHelper used for context path and request URI decoding. Can be used to configure the current UrlPathHelper.

  A default UrlPathHelper is always available.

• getRequestDataValueProcessor

  @Nullable
  public RequestDataValueProcessor getRequestDataValueProcessor()

  Return the RequestDataValueProcessor instance to use obtained from the WebApplicationContext under the name "requestDataValueProcessor". Or null if no matching bean was found.

• getContextPath

  public String getContextPath()

  Return the context path of the original request, that is, the path that indicates the current web application. This is useful for building links to other resources within the application.

  Delegates to the UrlPathHelper for decoding.

  另请参阅:

  HttpServletRequest.getContextPath(), getUrlPathHelper()

• getContextUrl

  public String getContextUrl​(String relativeUrl)

  Return a context-aware URl for the given relative URL.

  参数:

  relativeUrl - the relative URL part

  返回:

  a URL that points back to the server with an absolute path (also URL-encoded accordingly)

• getContextUrl

  public String getContextUrl​(String relativeUrl,
                              Map<String,​?> params)

  Return a context-aware URl for the given relative URL with placeholders (named keys with braces {}). For example, send in a relative URL foo/{bar}?spam={spam} and a parameter map {bar=baz,spam=nuts} and the result will be [contextpath]/foo/baz?spam=nuts.

  参数:

  relativeUrl - the relative URL part

  params - a map of parameters to insert as placeholders in the url

  返回:

  a URL that points back to the server with an absolute path (also URL-encoded accordingly)

• getPathToServlet

  public String getPathToServlet()

  Return the path to URL mappings within the current servlet including the context path and the servlet path of the original request. This is useful for building links to other resources within the application where a servlet mapping of the style "/main/*" is used.

  Delegates to the UrlPathHelper to determine the context and servlet path.

• getRequestUri

  public String getRequestUri()

  Return the request URI of the original request, that is, the invoked URL without parameters. This is particularly useful as HTML form action target, possibly in combination with the original query string.

  Delegates to the UrlPathHelper for decoding.

  另请参阅:

  getQueryString(), UrlPathHelper.getOriginatingRequestUri(javax.servlet.http.HttpServletRequest), getUrlPathHelper()

• getQueryString

  public String getQueryString()

  Return the query string of the current request, that is, the part after the request path. This is particularly useful for building an HTML form action target in combination with the original request URI.

  Delegates to the UrlPathHelper for decoding.

  另请参阅:

  getRequestUri(), UrlPathHelper.getOriginatingQueryString(javax.servlet.http.HttpServletRequest), getUrlPathHelper()

• getMessage

  public String getMessage​(String code,
                           String defaultMessage)

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           Object[] args,
                           String defaultMessage)

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           List<?> args,
                           String defaultMessage)

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  args - arguments for the message as a List, or null if none

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           Object[] args,
                           String defaultMessage,
                           boolean htmlEscape)

  Retrieve the message for the given code.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  defaultMessage - the String to return if the lookup fails

  htmlEscape - if the message should be HTML-escaped

  返回:

  the message

• getMessage

  public String getMessage​(String code)
                    throws NoSuchMessageException

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           Object[] args)
                    throws NoSuchMessageException

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           List<?> args)
                    throws NoSuchMessageException

  Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

  参数:

  code - the code of the message

  args - arguments for the message as a List, or null if none

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getMessage

  public String getMessage​(String code,
                           @Nullable
                           Object[] args,
                           boolean htmlEscape)
                    throws NoSuchMessageException

  Retrieve the message for the given code.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  htmlEscape - if the message should be HTML-escaped

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getMessage

  public String getMessage​(MessageSourceResolvable resolvable)
                    throws NoSuchMessageException

  Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance), using the "defaultHtmlEscape" setting.

  参数:

  resolvable - the MessageSourceResolvable

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getMessage

  public String getMessage​(MessageSourceResolvable resolvable,
                           boolean htmlEscape)
                    throws NoSuchMessageException

  Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance).

  参数:

  resolvable - the MessageSourceResolvable

  htmlEscape - if the message should be HTML-escaped

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getThemeMessage

  public String getThemeMessage​(String code,
                                String defaultMessage)

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getThemeMessage

  public String getThemeMessage​(String code,
                                @Nullable
                                Object[] args,
                                String defaultMessage)

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getThemeMessage

  public String getThemeMessage​(String code,
                                @Nullable
                                List<?> args,
                                String defaultMessage)

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  args - arguments for the message as a List, or null if none

  defaultMessage - the String to return if the lookup fails

  返回:

  the message

• getThemeMessage

  public String getThemeMessage​(String code)
                         throws NoSuchMessageException

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getThemeMessage

  public String getThemeMessage​(String code,
                                @Nullable
                                Object[] args)
                         throws NoSuchMessageException

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  args - arguments for the message, or null if none

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getThemeMessage

  public String getThemeMessage​(String code,
                                @Nullable
                                List<?> args)
                         throws NoSuchMessageException

  Retrieve the theme message for the given code.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  code - the code of the message

  args - arguments for the message as a List, or null if none

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getThemeMessage

  public String getThemeMessage​(MessageSourceResolvable resolvable)
                         throws NoSuchMessageException

  Retrieve the given MessageSourceResolvable in the current theme.

  Note that theme messages are never HTML-escaped, as they typically denote theme-specific resource paths and not client-visible messages.

  参数:

  resolvable - the MessageSourceResolvable

  返回:

  the message

  抛出:

  NoSuchMessageException - if not found

• getErrors

  @Nullable
  public Errors getErrors​(String name)

  Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.

  参数:

  name - the name of the bind object

  返回:

  the Errors instance, or null if not found

• getErrors

  @Nullable
  public Errors getErrors​(String name,
                          boolean htmlEscape)

  Retrieve the Errors instance for the given bind object.

  参数:

  name - the name of the bind object

  htmlEscape - create an Errors instance with automatic HTML escaping?

  返回:

  the Errors instance, or null if not found

• getModelObject

  @Nullable
  protected Object getModelObject​(String modelName)

  Retrieve the model object for the given model name, either from the model or from the request attributes.

  参数:

  modelName - the name of the model object

  返回:

  the model object

• getBindStatus

  public BindStatus getBindStatus​(String path)
                           throws IllegalStateException

  Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting.

  参数:

  path - the bean and property path for which values and errors will be resolved (e.g. "person.age")

  返回:

  the new BindStatus instance

  抛出:

  IllegalStateException - if no corresponding Errors object found

• getBindStatus

  public BindStatus getBindStatus​(String path,
                                  boolean htmlEscape)
                           throws IllegalStateException

  Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting.

  参数:

  path - the bean and property path for which values and errors will be resolved (e.g. "person.age")

  htmlEscape - create a BindStatus with automatic HTML escaping?

  返回:

  the new BindStatus instance

  抛出:

  IllegalStateException - if no corresponding Errors object found