com.publiccms.common.servlet

类 SafeRequestContext

java.lang.Object

com.publiccms.common.servlet.SafeRequestContext

public class SafeRequestContext
extends java.lang.Object

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_THEME_NAME
private java.lang.Boolean	defaultHtmlEscape
private java.util.Map<java.lang.String,org.springframework.validation.Errors>	errorsMap
private java.util.Locale	locale
private java.util.Map<java.lang.String,java.lang.Object>	model
private javax.servlet.http.HttpServletRequest	request
private org.springframework.web.servlet.support.RequestDataValueProcessor	requestDataValueProcessor
private javax.servlet.http.HttpServletResponse	response
private java.lang.Boolean	responseEncodedHtmlEscape
private org.springframework.ui.context.Theme	theme
private java.util.TimeZone	timeZone
private org.springframework.web.util.UrlPathHelper	urlPathHelper
static java.lang.String	WEB_APPLICATION_CONTEXT_ATTRIBUTE
private org.springframework.web.context.WebApplicationContext	webApplicationContext

构造器概要

构造器

构造器和说明
SafeRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, java.util.Map<java.lang.String,java.lang.Object> model)

方法概要

限定符和类型	方法和说明
void	changeLocale(java.util.Locale locale)
void	changeLocale(java.util.Locale locale, java.util.TimeZone timeZone)
void	changeTheme(java.lang.String themeName)
void	changeTheme(org.springframework.ui.context.Theme theme)
java.lang.String	getContextPath()
java.lang.String	getContextUrl(java.lang.String relativeUrl)
java.lang.String	getContextUrl(java.lang.String relativeUrl, java.util.Map<java.lang.String,?> params)
java.lang.Boolean	getDefaultHtmlEscape()
org.springframework.validation.Errors	getErrors(java.lang.String name)
org.springframework.validation.Errors	getErrors(java.lang.String name, boolean htmlEscape)
protected java.util.Locale	getFallbackLocale()
protected org.springframework.ui.context.Theme	getFallbackTheme()
protected java.util.TimeZone	getFallbackTimeZone()
java.util.Locale	getLocale()
java.lang.String	getMessage(org.springframework.context.MessageSourceResolvable resolvable)
java.lang.String	getMessage(org.springframework.context.MessageSourceResolvable resolvable, boolean htmlEscape)
java.lang.String	getMessage(java.lang.String code)
java.lang.String	getMessage(java.lang.String code, java.util.List<?> args)
java.lang.String	getMessage(java.lang.String code, java.util.List<?> args, java.lang.String defaultMessage)
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args)
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, boolean htmlEscape)
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage)
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, boolean htmlEscape)
java.lang.String	getMessage(java.lang.String code, java.lang.String defaultMessage)
java.util.Map<java.lang.String,java.lang.Object>	getModel()
protected java.lang.Object	getModelObject(java.lang.String modelName)
java.lang.String	getPathToServlet()
java.lang.String	getQueryString()
protected javax.servlet.http.HttpServletRequest	getRequest()
org.springframework.web.servlet.support.RequestDataValueProcessor	getRequestDataValueProcessor()
java.lang.String	getRequestUri()
java.lang.Boolean	getResponseEncodedHtmlEscape()
protected javax.servlet.ServletContext	getServletContext() Return the underlying ServletContext.
org.springframework.ui.context.Theme	getTheme()
java.lang.String	getThemeMessage(org.springframework.context.MessageSourceResolvable resolvable)
java.lang.String	getThemeMessage(java.lang.String code)
java.lang.String	getThemeMessage(java.lang.String code, java.util.List<?> args)
java.lang.String	getThemeMessage(java.lang.String code, java.util.List<?> args, java.lang.String defaultMessage)
java.lang.String	getThemeMessage(java.lang.String code, java.lang.Object[] args)
java.lang.String	getThemeMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage)
java.lang.String	getThemeMessage(java.lang.String code, java.lang.String defaultMessage)
java.util.TimeZone	getTimeZone()
org.springframework.web.util.UrlPathHelper	getUrlPathHelper()
boolean	isDefaultHtmlEscape()
boolean	isResponseEncodedHtmlEscape()
void	setDefaultHtmlEscape(boolean defaultHtmlEscape)
void	setUrlPathHelper(org.springframework.web.util.UrlPathHelper urlPathHelper)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_THEME_NAME

public static final java.lang.String DEFAULT_THEME_NAME

另请参阅:

常量字段值

WEB_APPLICATION_CONTEXT_ATTRIBUTE

public static final java.lang.String WEB_APPLICATION_CONTEXT_ATTRIBUTE

request

private javax.servlet.http.HttpServletRequest request

response

@Nullable
private javax.servlet.http.HttpServletResponse response

model

@Nullable
private java.util.Map<java.lang.String,java.lang.Object> model

webApplicationContext

private org.springframework.web.context.WebApplicationContext webApplicationContext

locale

@Nullable
private java.util.Locale locale

timeZone

@Nullable
private java.util.TimeZone timeZone

theme

@Nullable
private org.springframework.ui.context.Theme theme

defaultHtmlEscape

@Nullable
private java.lang.Boolean defaultHtmlEscape

responseEncodedHtmlEscape

@Nullable
private java.lang.Boolean responseEncodedHtmlEscape

urlPathHelper

private org.springframework.web.util.UrlPathHelper urlPathHelper

requestDataValueProcessor

@Nullable
private org.springframework.web.servlet.support.RequestDataValueProcessor requestDataValueProcessor

errorsMap

@Nullable
private java.util.Map<java.lang.String,org.springframework.validation.Errors> errorsMap

构造器详细资料

SafeRequestContext

public SafeRequestContext(javax.servlet.http.HttpServletRequest request,
                          @Nullable
                          javax.servlet.http.HttpServletResponse response,
                          @Nullable
                          javax.servlet.ServletContext servletContext,
                          @Nullable
                          java.util.Map<java.lang.String,java.lang.Object> model)

方法详细资料

getRequest

protected final javax.servlet.http.HttpServletRequest getRequest()

getServletContext

@Nullable
protected final javax.servlet.ServletContext getServletContext()

Return the underlying ServletContext.

getModel

@Nullable
public final java.util.Map<java.lang.String,java.lang.Object> getModel()

返回:

the populated model Map, or null if none available

getLocale

public final java.util.Locale getLocale()

返回:

current Locale (never null)

getTimeZone

@Nullable
public java.util.TimeZone getTimeZone()

返回:

current timezone (never null)

getFallbackLocale

protected java.util.Locale getFallbackLocale()

返回:

the fallback locale (never null)

getFallbackTimeZone

@Nullable
protected java.util.TimeZone getFallbackTimeZone()

返回:

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

changeLocale

public void changeLocale(java.util.Locale locale)

参数:

locale - the new locale

changeLocale

public void changeLocale(java.util.Locale locale,
                         java.util.TimeZone timeZone)

参数:

locale - the new locale

timeZone - the new time zone

getTheme

public org.springframework.ui.context.Theme getTheme()

返回:

current theme (never null).

getFallbackTheme

protected org.springframework.ui.context.Theme getFallbackTheme()

返回:

the fallback theme (never null)

changeTheme

public void changeTheme(@Nullable
                        org.springframework.ui.context.Theme theme)

参数:

theme - the new theme

另请参阅:

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

changeTheme

public void changeTheme(java.lang.String themeName)

参数:

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)

参数:

defaultHtmlEscape -

isDefaultHtmlEscape

public boolean isDefaultHtmlEscape()

返回:

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

getDefaultHtmlEscape

@Nullable
public java.lang.Boolean getDefaultHtmlEscape()

返回:

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.

getResponseEncodedHtmlEscape

@Nullable
public java.lang.Boolean getResponseEncodedHtmlEscape()

返回:

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

从以下版本开始:

4.1.2

setUrlPathHelper

public void setUrlPathHelper(org.springframework.web.util.UrlPathHelper urlPathHelper)

参数:

urlPathHelper -

getUrlPathHelper

public org.springframework.web.util.UrlPathHelper getUrlPathHelper()

返回:

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

getRequestDataValueProcessor

@Nullable
public org.springframework.web.servlet.support.RequestDataValueProcessor getRequestDataValueProcessor()

返回:

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

getContextPath

public java.lang.String getContextPath()

返回:

the context path of the original request

getContextUrl

public java.lang.String getContextUrl(java.lang.String relativeUrl)

参数:

relativeUrl - the relative URL part

返回:

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

getContextUrl

public java.lang.String getContextUrl(java.lang.String relativeUrl,
                                      java.util.Map<java.lang.String,?> params)

参数:

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 java.lang.String getPathToServlet()

返回:

the path to URL mappings within the current servlet including the context path and the servlet path of the original request.

getRequestUri

public java.lang.String getRequestUri()

返回:

the request URI of the original request

getQueryString

public java.lang.String getQueryString()

返回:

the query string of the current request

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.String defaultMessage)

参数:

code - the code of the message

defaultMessage - the String to return if the lookup fails

返回:

the message

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.lang.Object[] args,
                                   java.lang.String defaultMessage)

参数:

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 java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.util.List<?> args,
                                   java.lang.String defaultMessage)

参数:

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 java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.lang.Object[] args,
                                   java.lang.String defaultMessage,
                                   boolean htmlEscape)

参数:

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 java.lang.String getMessage(java.lang.String code)
                            throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.lang.Object[] args)
                            throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

args - arguments for the message, or null if none

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.util.List<?> args)
                            throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

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

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   @Nullable
                                   java.lang.Object[] args,
                                   boolean htmlEscape)
                            throws org.springframework.context.NoSuchMessageException

参数:

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

抛出:

org.springframework.context.NoSuchMessageException - if not found

getMessage

public java.lang.String getMessage(org.springframework.context.MessageSourceResolvable resolvable)
                            throws org.springframework.context.NoSuchMessageException

参数:

resolvable - the MessageSourceResolvable

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getMessage

public java.lang.String getMessage(org.springframework.context.MessageSourceResolvable resolvable,
                                   boolean htmlEscape)
                            throws org.springframework.context.NoSuchMessageException

参数:

resolvable - the MessageSourceResolvable

htmlEscape - if the message should be HTML-escaped

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getThemeMessage

public java.lang.String getThemeMessage(java.lang.String code,
                                        java.lang.String defaultMessage)

参数:

code - the code of the message

defaultMessage - the String to return if the lookup fails

返回:

the message

getThemeMessage

public java.lang.String getThemeMessage(java.lang.String code,
                                        @Nullable
                                        java.lang.Object[] args,
                                        java.lang.String defaultMessage)

参数:

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 java.lang.String getThemeMessage(java.lang.String code,
                                        @Nullable
                                        java.util.List<?> args,
                                        java.lang.String defaultMessage)

参数:

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 java.lang.String getThemeMessage(java.lang.String code)
                                 throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getThemeMessage

public java.lang.String getThemeMessage(java.lang.String code,
                                        @Nullable
                                        java.lang.Object[] args)
                                 throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

args - arguments for the message, or null if none

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getThemeMessage

public java.lang.String getThemeMessage(java.lang.String code,
                                        @Nullable
                                        java.util.List<?> args)
                                 throws org.springframework.context.NoSuchMessageException

参数:

code - the code of the message

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

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getThemeMessage

public java.lang.String getThemeMessage(org.springframework.context.MessageSourceResolvable resolvable)
                                 throws org.springframework.context.NoSuchMessageException

参数:

resolvable - the MessageSourceResolvable

返回:

the message

抛出:

org.springframework.context.NoSuchMessageException - if not found

getErrors

@Nullable
public org.springframework.validation.Errors getErrors(java.lang.String name)

参数:

name - the name of the bind object

返回:

the Errors instance, or null if not found

getErrors

@Nullable
public org.springframework.validation.Errors getErrors(java.lang.String name,
                                                                  boolean htmlEscape)

参数:

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 java.lang.Object getModelObject(java.lang.String modelName)

参数:

modelName - the name of the model object

返回:

the model object