org.jessma.mvc

类 ActionSupport

java.lang.Object

org.jessma.mvc.ActionSupport

所有已实现的接口:

Action

public class ActionSupport
extends Object
implements Action

Action 公共基类。

嵌套类概要

从接口继承的嵌套类/接口 org.jessma.mvc.Action

Action.BaseType, Action.Constant, Action.ResultType

字段概要

字段

限定符和类型	字段和说明
static String	ASYNC_COMPLETE 预定义异步 Action Result
static String	ASYNC_ERROR 预定义异步 Action Result
static String	ASYNC_TIMEOUT 预定义异步 Action Result

从接口继承的字段 org.jessma.mvc.Action

$0, $1, $2, $3, $4, $5, $6, $7, $8, $9, ACCEPT, ADD, ALL, ALLOW, AUTHENTICATE, AUTHORIZE, BACK, BOTH, CLEAR, COMPLETE, CONFIRM, CREATE, DELETE, DESTROY, DETAIL, EDIT, ELSE, EMPTY, ERASE, ERROR, EXCEPTION, EXIT, FAIL, FIND, FORBIDDEN, FORWARD, GET, HIDE, IGNORE, INPUT, LIST, LOAD, LOGIN, LOGOUT, NEW, NONE, PASS, PUT, QUERY, QUIT, REFRESH, REFUSE, RELOAD, RENEW, SEARCH, SET, SHOW, SUCCESS, SUMMARY, TIMEOUT, UPDATE, VERIFY, VIEW

构造器概要

构造器

构造器和说明
ActionSupport()

方法概要

方法

限定符和类型	方法和说明
void	addCookie(javax.servlet.http.Cookie cookie) 添加 Cookie
void	addCookie(String name, String value) 添加 Cookie
void	addError(String key, String message) 添加验证错误信息
void	addErrorByResource(String key, String resKey, Object... params) 添加验证错误信息（根据默认 ResourceBundle 和默认 Locale 设置内容）
void	addErrorByResource(String key, String resKey, String bundle, Locale locale, Object... params) 添加验证错误信息（根据指定 ResourceBundle 和指定 Locale 设置内容）
protected void	checkTaskType(AsyncTask task) 检测 AsyncTask 的实际类型是否为 ActionTask 的子类 如果不是 ActionTask 的子类则抛出 IllegalArgumentException 异常 该方法在 startAsync(AsyncTask, AsyncListener...)
<T> T	createFormBean(Class<T> clazz) 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)
<T> T	createFormBean(Class<T> clazz, Map<String,String> keyMap) 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)
<T> T	createFormBeanByFieldValues(Class<T> clazz) 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 成员变量名完全一致)
<T> T	createFormBeanByFieldValues(Class<T> clazz, Map<String,String> keyMap) 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 成员变量)
<T> T	createFormBeanByProperties(Class<T> clazz) 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)
<T> T	createFormBeanByProperties(Class<T> clazz, Map<String,String> keyMap) 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)
javax.servlet.http.HttpSession	createSession() 创建 HttpSession 对象，如果已存在则返回原对象。
protected <T> void	dispatchResult(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, T result) 处理异步任务返回的 Result
String	execute() 默认 Action 入口方法（返回 Action.SUCCESS）
<T> void	fillFormBeanFieldValues(T bean) 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 成员变量名完全一致)
<T> void	fillFormBeanFieldValues(T bean, Map<String,String> keyMap) 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 成员变量)
<T> void	fillFormBeanProperties(T bean) 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)
<T> void	fillFormBeanProperties(T bean, Map<String,String> keyMap) 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)
<T> void	fillFormBeanPropertiesOrFieldValues(T bean) 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)
<T> void	fillFormBeanPropertiesOrFieldValues(T bean, Map<String,String> keyMap) 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)
Map<String,List<String>>	getAllErrors() 获取所有验证错误信息
<T> T	getApplicationAttribute(String name) 获取 ServletContext 的指定属性值
protected <T> T	getAsyncCompleteResult() 预定义异步 Action 任务返回值：ASYNC_COMPLETE
protected <T> T	getAsyncErrorResult() 预定义异步 Action 任务返回值：ASYNC_ERROR 异步 Action 任务执行出错（发生 AsyncListener.onError(AsyncEvent) 事件）， 应用框架通过该方法获取出错情形下的 Result，该 Result 为 Action 最终处理结果
protected <T> T	getAsyncTimeoutResult() 预定义异步 Action 任务返回值：ASYNC_TIMEOUT 异步 Action 任务执行超时（发生 AsyncListener.onTimeout(AsyncEvent) 事件）， 应用框架通过该方法获取超时情形下的 Result，该 Result 为 Action 最终处理结果
protected static BeanValidator	getBeanValidator() 获取 BeanValidator （Bean 验证器）对象
Boolean	getBooleanParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
boolean	getBooleanParam(String name, boolean def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
Byte	getByteParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
byte	getByteParam(String name, byte def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
Character	getCharParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
char	getCharParam(String name, char def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
javax.servlet.http.Cookie	getCookie(String name) 获取指定名称的 Cookie
javax.servlet.http.Cookie[]	getCookies() 获取所有 Cookie
String	getCookieValue(String name) 获取指定名称的 Cookie 值，失败返回 null
Locale	getCurrentLocale() 获取当前请求的实际 Locale 属性
Date	getDateParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
Date	getDateParam(String name, String format) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
String	getDefaultApplicationBundle() 获取默认 Application Bundle
String	getDefaultValidationBundle() 获取默认 Validation Bundle
Double	getDoubleParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
double	getDoubleParam(String name, double def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
String	getError(String key, int index) 获取指定键的第 index 条验证错误信息
List<String>	getErrors(String key) 获取指定键的验证错误信息列表
String	getfirstError(String key) 获取指定键的第一条验证错误信息
Float	getFloatParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
float	getFloatParam(String name, float def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
protected Object	getFormBean() 获取由 FormBean 声明的当前入口方法的 Form Bean 对象
Integer	getIntParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
int	getIntParam(String name, int def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
Locale	getLocale() 获取当前 HttpSession 的 Locale 属性
Locale	getLocaleByCookie() 通过 Cookie 获取当前用户的 Locale 属性
Long	getLongParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
long	getLongParam(String name, long def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
String	getParam(String name) 获取 HttpServletRequest 的指定请求参数值，并去除前后空格
Map<String,String[]>	getParamMap() 获取 HttpServletRequest 的所有参数名称和值
List<String>	getParamNames() 获取 HttpServletRequest 的参数名称集合
String	getParamNoTrim(String name) 获取 HttpServletRequest 的指定请求参数值
List<String>	getParamValues(String name) 获取 HttpServletRequest 的指定请求参数值集合
javax.servlet.http.HttpServletRequest	getRequest() 获取 HttpServletRequest
<T> T	getRequestAttribute(String name) 获取 HttpServletRequest 的指定属性值
String	getRequestBasePath() 获取 URL 的 BASE 路径
Locale	getRequestLocale() 获取客户端 Locale
List<Locale>	getRequestLocales() 获取客户端 Locale 列表
String	getRequestRealPath(String path) 获取 URL 地址在文件系统的绝对路径, Servlet 2.4 以上通过 request.getServletContext().getRealPath() 获取, Servlet 2.4 以下通过 request.getRealPath() 获取。
String	getResourceMessage(String bundle, Locale locale, String resKey, Object... params) 获取 bundle 资源的 locale 本地化文件中名字为 resKey 的字符串资源，并代入 params 参数
String	getResourceMessage(String resKey, Object... params) 获取默认 bundle 资源的当前 locale 本地化文件中名字为 resKey 的字符串资源，并代入 params 参数
javax.servlet.http.HttpServletResponse	getResponse() 获取 HttpServletResponse
javax.servlet.ServletContext	getServletContext() 获取 ServletContext
javax.servlet.http.HttpSession	getSession() 获取 HttpSession 对象，如果没有则进行创建。
javax.servlet.http.HttpSession	getSession(boolean create) 获取 HttpSession 对象，如果没有则根据参数决定是否创建。
<T> T	getSessionAttribute(String name) 获取 HttpSession 的指定属性值
Short	getShortParam(String name) 获取 HttpServletRequest 的指定请求参数值，失败返回 null
short	getShortParam(String name, short def) 获取 HttpServletRequest 的指定请求参数值，失败返回默认值
protected Class<?>[]	getValidationGroups() 获取当前 Action 入口方法的自动验证组
void	invalidateSession() 销毁 HttpSession
protected boolean	isAutoValidation() 检查当前 Action 入口方法是否执行自动验证
protected static boolean	isBeanValidationEnable() 检查 Bean Validation 机制是否开启
boolean	isSessionExist() 检查 HttpSession 对象是否存在
void	removeApplicationAttribute(String name) 删除 ServletContext 的指定属性值
void	removeRequestAttribute(String name) 删除 HttpServletRequest 的指定属性值
void	removeSessionAttribute(String name) 删除 HttpSession 的指定属性值
<T> void	setApplicationAttribute(String name, T value) 设置 ServletContext 的指定属性值
void	setLocale(Locale locale) 设置当前 HttpSession 的 Locale 属性
void	setLocaleByCookie(Locale locale) 通过 Cookie 设置当前用户的 Locale 属性
void	setLocaleByCookie(Locale locale, int maxAge) 通过 Cookie 设置当前用户的 Locale 属性
void	setLocaleByCookie(Locale locale, int maxAge, String domain, String path) 通过 Cookie 设置当前用户的 Locale 属性
void	setLocaleByCookie(Locale locale, int maxAge, String domain, String path, boolean secure, boolean httpOnly, int version, String comment) 设置当前 Cookie 的 Locale 属性
void	setNoCacheHeader() 禁止浏览器缓存当前页面
void	setRequest(javax.servlet.http.HttpServletRequest request) 设置 HttpServletRequest
<T> void	setRequestAttribute(String name, T value) 设置 HttpServletRequest 的指定属性值
void	setResponse(javax.servlet.http.HttpServletResponse response) 设置 HttpServletResponse
void	setServletContext(javax.servlet.ServletContext servletContext) 设置 ServletContext
<T> void	setSessionAttribute(String name, T value) 设置 HttpSession 的指定属性值
protected void	startAsync(AsyncTask task, javax.servlet.AsyncListener... listeners) 启动异步任务（使用系统默认超时值），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)
protected void	startAsync(AsyncTask task, AsyncTaskLauncher launcher, javax.servlet.AsyncListener... listeners) 启动异步任务（使用系统默认超时值），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)
protected void	startAsync(AsyncTask task, long timeout, javax.servlet.AsyncListener... listeners) 启动异步任务，参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)
protected void	startAsync(AsyncTask task, long timeout, AsyncTaskLauncher launcher, javax.servlet.AsyncListener... listeners) 启动异步任务
protected void	startAsyncNoTimeout(AsyncTask task, javax.servlet.AsyncListener... listeners) 启动异步任务（永不超时），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)
protected void	startAsyncNoTimeout(AsyncTask task, AsyncTaskLauncher launcher, javax.servlet.AsyncListener... listeners) 启动异步任务（永不超时），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)
boolean	validate() Action.validate() 的默认实现
protected Set<javax.validation.ConstraintViolation<Object>>	validateBean(Object bean, Class<?>... groups) 验证 Bean 对象，并返回验证结果集
protected boolean	validateBeanAndAddErrors(Object bean, Class<?>... groups) 验证 Bean 对象，并把错误信息记录到 Action 的 errors 集合中

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

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

字段详细资料

ASYNC_COMPLETE

public static final String ASYNC_COMPLETE

预定义异步 Action Result

另请参阅:

常量字段值

ASYNC_TIMEOUT

public static final String ASYNC_TIMEOUT

预定义异步 Action Result

另请参阅:

常量字段值

ASYNC_ERROR

public static final String ASYNC_ERROR

预定义异步 Action Result

另请参阅:

常量字段值

构造器详细资料

ActionSupport

public ActionSupport()

方法详细资料

execute

public String execute()
               throws Exception

默认 Action 入口方法（返回 Action.SUCCESS）

指定者:

execute 在接口中 Action

抛出:

Exception

validate

public boolean validate()

Action.validate() 的默认实现

指定者:

validate 在接口中 Action

validateBeanAndAddErrors

protected final boolean validateBeanAndAddErrors(Object bean,
                               Class<?>... groups)

验证 Bean 对象，并把错误信息记录到 Action 的 errors 集合中

validateBean

protected final Set<javax.validation.ConstraintViolation<Object>> validateBean(Object bean,
                                                             Class<?>... groups)

验证 Bean 对象，并返回验证结果集

getBeanValidator

protected static final BeanValidator getBeanValidator()

获取 BeanValidator （Bean 验证器）对象

isBeanValidationEnable

protected static final boolean isBeanValidationEnable()

检查 Bean Validation 机制是否开启

getFormBean

protected final Object getFormBean()

获取由 FormBean 声明的当前入口方法的 Form Bean 对象

isAutoValidation

protected final boolean isAutoValidation()

检查当前 Action 入口方法是否执行自动验证

getValidationGroups

protected final Class<?>[] getValidationGroups()

获取当前 Action 入口方法的自动验证组

addError

public final void addError(String key,
            String message)

添加验证错误信息

addErrorByResource

public final void addErrorByResource(String key,
                      String resKey,
                      Object... params)

添加验证错误信息（根据默认 ResourceBundle 和默认 Locale 设置内容）

addErrorByResource

public final void addErrorByResource(String key,
                      String resKey,
                      String bundle,
                      Locale locale,
                      Object... params)

添加验证错误信息（根据指定 ResourceBundle 和指定 Locale 设置内容）

getfirstError

public final String getfirstError(String key)

获取指定键的第一条验证错误信息

getError

public final String getError(String key,
              int index)

获取指定键的第 index 条验证错误信息

getErrors

public final List<String> getErrors(String key)

获取指定键的验证错误信息列表

getAllErrors

public final Map<String,List<String>> getAllErrors()

获取所有验证错误信息

getResourceMessage

public final String getResourceMessage(String resKey,
                        Object... params)

获取默认 bundle 资源的当前 locale 本地化文件中名字为 resKey 的字符串资源，并代入 params 参数

getResourceMessage

public final String getResourceMessage(String bundle,
                        Locale locale,
                        String resKey,
                        Object... params)

获取 bundle 资源的 locale 本地化文件中名字为 resKey 的字符串资源，并代入 params 参数

getDefaultApplicationBundle

public final String getDefaultApplicationBundle()

获取默认 Application Bundle

getDefaultValidationBundle

public final String getDefaultValidationBundle()

获取默认 Validation Bundle

getCurrentLocale

public final Locale getCurrentLocale()

获取当前请求的实际 Locale 属性

getRequestLocale

public final Locale getRequestLocale()

获取客户端 Locale

getRequestLocales

public final List<Locale> getRequestLocales()

获取客户端 Locale 列表

getRequestAttribute

public final <T> T getRequestAttribute(String name)

获取 HttpServletRequest 的指定属性值

setRequestAttribute

public final <T> void setRequestAttribute(String name,
                           T value)

设置 HttpServletRequest 的指定属性值

removeRequestAttribute

public final void removeRequestAttribute(String name)

删除 HttpServletRequest 的指定属性值

getSessionAttribute

public final <T> T getSessionAttribute(String name)

获取 HttpSession 的指定属性值

setSessionAttribute

public final <T> void setSessionAttribute(String name,
                           T value)

设置 HttpSession 的指定属性值

removeSessionAttribute

public final void removeSessionAttribute(String name)

删除 HttpSession 的指定属性值

invalidateSession

public final void invalidateSession()

销毁 HttpSession

getApplicationAttribute

public final <T> T getApplicationAttribute(String name)

获取 ServletContext 的指定属性值

setApplicationAttribute

public final <T> void setApplicationAttribute(String name,
                               T value)

设置 ServletContext 的指定属性值

removeApplicationAttribute

public final void removeApplicationAttribute(String name)

删除 ServletContext 的指定属性值

getParam

public final String getParam(String name)

获取 HttpServletRequest 的指定请求参数值，并去除前后空格

getParamNoTrim

public final String getParamNoTrim(String name)

获取 HttpServletRequest 的指定请求参数值

getParamNames

public final List<String> getParamNames()

获取 HttpServletRequest 的参数名称集合

getParamValues

public final List<String> getParamValues(String name)

获取 HttpServletRequest 的指定请求参数值集合

getParamMap

public final Map<String,String[]> getParamMap()

获取 HttpServletRequest 的所有参数名称和值

getBooleanParam

public final Boolean getBooleanParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getBooleanParam

public final boolean getBooleanParam(String name,
                      boolean def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getByteParam

public final Byte getByteParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getByteParam

public final byte getByteParam(String name,
                byte def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getCharParam

public final Character getCharParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getCharParam

public final char getCharParam(String name,
                char def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getShortParam

public final Short getShortParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getShortParam

public final short getShortParam(String name,
                  short def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getIntParam

public final Integer getIntParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getIntParam

public final int getIntParam(String name,
              int def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getLongParam

public final Long getLongParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getLongParam

public final long getLongParam(String name,
                long def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getFloatParam

public final Float getFloatParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getFloatParam

public final float getFloatParam(String name,
                  float def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getDoubleParam

public final Double getDoubleParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getDoubleParam

public final double getDoubleParam(String name,
                    double def)

获取 HttpServletRequest 的指定请求参数值，失败返回默认值

getDateParam

public final Date getDateParam(String name)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

getDateParam

public final Date getDateParam(String name,
                String format)

获取 HttpServletRequest 的指定请求参数值，失败返回 null

createFormBean

public final <T> T createFormBean(Class<T> clazz)

使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)

createFormBean

public final <T> T createFormBean(Class<T> clazz,
                   Map<String,String> keyMap)

使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)

createFormBeanByProperties

public final <T> T createFormBeanByProperties(Class<T> clazz)

使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)

createFormBeanByProperties

public final <T> T createFormBeanByProperties(Class<T> clazz,
                               Map<String,String> keyMap)

使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)

createFormBeanByFieldValues

public final <T> T createFormBeanByFieldValues(Class<T> clazz)

使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 成员变量名完全一致)

createFormBeanByFieldValues

public final <T> T createFormBeanByFieldValues(Class<T> clazz,
                                Map<String,String> keyMap)

使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 成员变量)

fillFormBeanProperties

public final <T> void fillFormBeanProperties(T bean)

使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)

fillFormBeanProperties

public final <T> void fillFormBeanProperties(T bean,
                              Map<String,String> keyMap)

使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)

fillFormBeanFieldValues

public final <T> void fillFormBeanFieldValues(T bean)

使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 成员变量名完全一致)

fillFormBeanFieldValues

public final <T> void fillFormBeanFieldValues(T bean,
                               Map<String,String> keyMap)

使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 成员变量)

fillFormBeanPropertiesOrFieldValues

public final <T> void fillFormBeanPropertiesOrFieldValues(T bean)

使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)

fillFormBeanPropertiesOrFieldValues

public final <T> void fillFormBeanPropertiesOrFieldValues(T bean,
                                           Map<String,String> keyMap)

使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)

getCookies

public final javax.servlet.http.Cookie[] getCookies()

获取所有 Cookie

getCookie

public final javax.servlet.http.Cookie getCookie(String name)

获取指定名称的 Cookie

getCookieValue

public final String getCookieValue(String name)

获取指定名称的 Cookie 值，失败返回 null

addCookie

public final void addCookie(javax.servlet.http.Cookie cookie)

添加 Cookie

addCookie

public final void addCookie(String name,
             String value)

添加 Cookie

getLocale

public final Locale getLocale()

获取当前 HttpSession 的 Locale 属性

setLocale

public final void setLocale(Locale locale)

设置当前 HttpSession 的 Locale 属性

getLocaleByCookie

public final Locale getLocaleByCookie()

通过 Cookie 获取当前用户的 Locale 属性

setLocaleByCookie

public final void setLocaleByCookie(Locale locale)

通过 Cookie 设置当前用户的 Locale 属性

setLocaleByCookie

public final void setLocaleByCookie(Locale locale,
                     int maxAge)

通过 Cookie 设置当前用户的 Locale 属性

setLocaleByCookie

public final void setLocaleByCookie(Locale locale,
                     int maxAge,
                     String domain,
                     String path)

通过 Cookie 设置当前用户的 Locale 属性

setLocaleByCookie

public final void setLocaleByCookie(Locale locale,
                     int maxAge,
                     String domain,
                     String path,
                     boolean secure,
                     boolean httpOnly,
                     int version,
                     String comment)

设置当前 Cookie 的 Locale 属性

getRequestRealPath

public final String getRequestRealPath(String path)

获取 URL 地址在文件系统的绝对路径, Servlet 2.4 以上通过 request.getServletContext().getRealPath() 获取, Servlet 2.4 以下通过 request.getRealPath() 获取。

getRequestBasePath

public final String getRequestBasePath()

获取 URL 的 BASE 路径

setNoCacheHeader

public final void setNoCacheHeader()

禁止浏览器缓存当前页面

getServletContext

public final javax.servlet.ServletContext getServletContext()

获取 ServletContext

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

设置 ServletContext

指定者:

setServletContext 在接口中 Action

getRequest

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

获取 HttpServletRequest

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

设置 HttpServletRequest

指定者:

setRequest 在接口中 Action

getResponse

public final javax.servlet.http.HttpServletResponse getResponse()

获取 HttpServletResponse

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

设置 HttpServletResponse

指定者:

setResponse 在接口中 Action

isSessionExist

public final boolean isSessionExist()

检查 HttpSession 对象是否存在

getSession

public final javax.servlet.http.HttpSession getSession()

获取 HttpSession 对象，如果没有则进行创建。

getSession

public final javax.servlet.http.HttpSession getSession(boolean create)

获取 HttpSession 对象，如果没有则根据参数决定是否创建。

createSession

public final javax.servlet.http.HttpSession createSession()

创建 HttpSession 对象，如果已存在则返回原对象。

getAsyncCompleteResult

protected <T> T getAsyncCompleteResult()

预定义异步 Action 任务返回值：ASYNC_COMPLETE

getAsyncTimeoutResult

protected <T> T getAsyncTimeoutResult()

预定义异步 Action 任务返回值：ASYNC_TIMEOUT
异步 Action 任务执行超时（发生 AsyncListener.onTimeout(AsyncEvent) 事件）， 应用框架通过该方法获取超时情形下的 Result，该 Result 为 Action 最终处理结果

getAsyncErrorResult

protected <T> T getAsyncErrorResult()

预定义异步 Action 任务返回值：ASYNC_ERROR
异步 Action 任务执行出错（发生 AsyncListener.onError(AsyncEvent) 事件）， 应用框架通过该方法获取出错情形下的 Result，该 Result 为 Action 最终处理结果

checkTaskType

protected void checkTaskType(AsyncTask task)

检测 AsyncTask 的实际类型是否为 ActionTask 的子类
如果不是 ActionTask 的子类则抛出 IllegalArgumentException 异常
该方法在 startAsync(AsyncTask, AsyncListener...) 内部调用

dispatchResult

protected <T> void dispatchResult(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      T result)
                       throws javax.servlet.ServletException,
                              IOException

处理异步任务返回的 Result

抛出:

javax.servlet.ServletException

IOException

startAsync

protected void startAsync(AsyncTask task,
              javax.servlet.AsyncListener... listeners)

启动异步任务（使用系统默认超时值），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)

参数:

task - : 异步任务对象

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0

startAsync

protected void startAsync(AsyncTask task,
              long timeout,
              javax.servlet.AsyncListener... listeners)

启动异步任务，参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)

参数:

task - : 异步任务对象

timeout - : 任务超时值（毫秒），应用框架会以 getAsyncTimeoutResult() 得到的值作为 Action 的最终处理结果，并立刻返回到客户端。此时， AsyncTask 的 run() 方法仍然继续执行，但会忽略其结果。

• 小于 0：使用 Web 容器的默认超时值
• 等于 0：永不超时
• 大于 0：使用设定的超时值

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0

startAsync

protected void startAsync(AsyncTask task,
              AsyncTaskLauncher launcher,
              javax.servlet.AsyncListener... listeners)

启动异步任务（使用系统默认超时值），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)

参数:

task - : 异步任务对象

launcher - : 异步任务启动器，如果为 null 则使用容器内置的线程池启动异步任务。

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0

startAsyncNoTimeout

protected void startAsyncNoTimeout(AsyncTask task,
                       javax.servlet.AsyncListener... listeners)

启动异步任务（永不超时），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)

参数:

task - : 异步任务对象

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0

startAsyncNoTimeout

protected void startAsyncNoTimeout(AsyncTask task,
                       AsyncTaskLauncher launcher,
                       javax.servlet.AsyncListener... listeners)

启动异步任务（永不超时），参考：startAsync(AsyncTask, long, AsyncTaskLauncher, AsyncListener...)

参数:

task - : 异步任务对象

launcher - : 异步任务启动器，如果为 null 则使用容器内置的线程池启动异步任务。

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0

startAsync

protected void startAsync(AsyncTask task,
              long timeout,
              AsyncTaskLauncher launcher,
              javax.servlet.AsyncListener... listeners)

启动异步任务

参数:

task - : 异步任务对象

timeout - : 任务超时值（毫秒），应用框架会以 getAsyncTimeoutResult() 得到的值作为 Action 的最终处理结果，并立刻返回到客户端。此时， AsyncTask 的 run() 方法仍然继续执行，但会忽略其结果。

• 小于 0：使用 Web 容器的默认超时值
• 等于 0：永不超时
• 大于 0：使用设定的超时值

launcher - : 异步任务启动器，如果为 null 则使用容器内置的线程池启动异步任务。

listeners - : 异步任务监听器，用于监听异步任务执行状态。

从以下版本开始:

Servlet 3.0