net.hasor.web

类 WebController

java.lang.Object

net.hasor.web.WebController

所有已实现的接口:

Controller

public class WebController
extends Object
implements Controller

Controller
昨夜西风凋碧树。独上高楼，望尽天涯路。
衣带渐宽终不悔，为伊消得人憔悴。
众里寻她千百度，蓦然回首，那人却在灯火阑珊处。

版本:

: 2013-8-14

作者:

JFinal, 赵永春 (zyc@hasor.net)

构造器概要

构造器

构造器和说明
WebController()

方法概要

限定符和类型	方法和说明
protected WebController	addHeader(String key, String value) 设置HttpServletResponseHeader属性
AppContext	getAppContext()
protected <T> T	getAttr(String name) Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
protected Enumeration<String>	getAttrNames() Returns an Enumeration containing the names of the attributes available to this request.
protected String	getCookie(String name) Get cookie value by cookie name.
protected String	getCookie(String name, String defaultValue) Get cookie value by cookie name.
protected javax.servlet.http.Cookie	getCookieObject(String name) Get cookie object by cookie name.
protected javax.servlet.http.Cookie[]	getCookieObjects()
protected Integer	getCookieToInt(String name) Get cookie value by cookie name and convert to Integer.
protected Integer	getCookieToInt(String name, Integer defaultValue) Get cookie value by cookie name and convert to Integer.
protected Long	getCookieToLong(String name) Get cookie value by cookie name and convert to Long.
protected Long	getCookieToLong(String name, Long defaultValue) Get cookie value by cookie name and convert to Long.
protected <T> T	getData(String name) 返回 Invoker 保存的数据。
protected Set<String>	getDataNames() 返回 Invoker 保存的数据keys。
protected <T> T	getInstance(Class<T> modelClass)
protected <T> T	getInstance(Class<T> modelClass, String modelName)
protected Object	getInstance(String bindID)
protected Invoker	getInvoker()
protected List<FileItem>	getMultipart(String parameterName) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected List<FileItem>	getMultipart(String parameterName, Integer maxPostSize) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表,
protected List<FileItem>	getMultipart(String parameterName, String cacheDirectory, Integer maxPostSize) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.
protected List<FileItem>	getMultipart(String parameterName, String cacheDirectory, Integer maxPostSize, String encoding) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected Iterator<FileItemStream>	getMultipartIterator() 返回流式处理文件上传的迭代器。
protected Iterator<FileItemStream>	getMultipartIterator(Integer maxPostSize) 返回流式处理文件上传的迭代器。
protected Iterator<FileItemStream>	getMultipartIterator(Integer maxPostSize, String encoding) 返回流式处理文件上传的迭代器。
protected List<FileItem>	getMultipartList() 将 multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.
protected List<FileItem>	getMultipartList(FileItemFactory factory) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected List<FileItem>	getMultipartList(FileItemFactory factory, Integer maxPostSize) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected List<FileItem>	getMultipartList(FileItemFactory factory, Integer maxPostSize, String encoding) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected List<FileItem>	getMultipartList(Integer maxPostSize) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.
protected List<FileItem>	getMultipartList(String cacheDirectory, Integer maxPostSize) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.
protected List<FileItem>	getMultipartList(String cacheDirectory, Integer maxPostSize, String encoding) 将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。
protected String	getPara(String name) Returns the value of a request parameter as a String, or null if the parameter does not exist.
protected String	getPara(String name, String defaultValue) Returns the value of a request parameter as a String, or default value if the parameter does not exist.
protected Map<String,String[]>	getParaMap() Returns the values of the request parameters as a Map.
protected Enumeration<String>	getParaNames() Returns an Enumeration of String objects containing the names of the parameters contained in this request.
protected Boolean	getParaToBoolean(String name) Returns the value of a request parameter and convert to Boolean.
protected Boolean	getParaToBoolean(String name, Boolean defaultValue) Returns the value of a request parameter and convert to Boolean with a default value if it is null.
protected Integer	getParaToInt(String name) Returns the value of a request parameter and convert to Integer.
protected Integer	getParaToInt(String name, Integer defaultValue) Returns the value of a request parameter and convert to Integer with a default value if it is null.
protected Long	getParaToLong(String name) Returns the value of a request parameter and convert to Long.
protected Long	getParaToLong(String name, Long defaultValue) Returns the value of a request parameter and convert to Long with a default value if it is null.
protected String[]	getParaValues(String name) Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
protected Integer[]	getParaValuesToInt(String name) Returns an array of Integer objects containing all of the values the given request parameter has, or null if the parameter does not exist.
javax.servlet.http.HttpServletRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
protected javax.servlet.http.HttpSession	getSession()
protected javax.servlet.http.HttpSession	getSession(boolean create) Return HttpSession.
protected <T> T	getSessionAttr(String key) Return a Object from session.
void	initController(Invoker renderData) 在处理新请求之前，初始化这个控制器。
protected boolean	isMultipart() 返回为 Multipart 请求,通常 Multipart 请求都包含一个或多个的文件上传。
protected FileUpload	newFileUpload(Integer maxPostSize, String encoding) 创建原始的FileUpload对象。
protected WebController	putData(String name, Object value) 设置 Invoker 保存的数据。
protected WebController	removeAttr(String name) Removes an attribute from this request
protected WebController	removeCookie(String name) Remove Cookie with path = "/".
protected WebController	removeCookie(String name, String path) Remove Cookie.
protected WebController	removeCookie(String name, String path, String domain) Remove Cookie.
protected WebController	removeData(String name) 删除 Invoker 保存的数据。
protected WebController	removeSessionAttr(String key) Remove Object in session.
protected void	renderTo(String viewName) 更新渲染模版。
protected void	renderTo(String renderType, String viewName) 更新渲染模版。
protected WebController	setAttr(String name, Object value) Stores an attribute in this request
protected WebController	setAttrs(Map<String,Object> attrMap) Stores attributes in this request, key of the map as attribute name and value of the map as attribute value
protected WebController	setCookie(javax.servlet.http.Cookie cookie) Set Cookie to response.
protected WebController	setCookie(String name, String value, int maxAgeInSeconds) Set Cookie with path = "/".
protected WebController	setCookie(String name, String value, int maxAgeInSeconds, String path) Set Cookie to response.
protected WebController	setCookie(String name, String value, int maxAgeInSeconds, String path, String domain) Set Cookie to response.
protected WebController	setDatas(Map<String,Object> attrMap) 设置 Invoker 保存的数据。
protected WebController	setHeader(String key, String value) 设置HttpServletResponseHeader属性
protected WebController	setSessionAttr(String key, Object value) Store Object to session.

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

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

构造器详细资料

WebController

public WebController()

方法详细资料

initController

public void initController(Invoker renderData)

从接口复制的说明: Controller

在处理新请求之前，初始化这个控制器。

指定者:

initController 在接口中 Controller

getInvoker

protected Invoker getInvoker()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

返回:

Return HttpServletRequest. Do not use HttpServletRequest Object in constructor of Controller

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

返回:

Return HttpServletResponse. Do not use HttpServletResponse Object in constructor of Controller

getAppContext

public AppContext getAppContext()

返回:

Return AppContext.

setHeader

protected WebController setHeader(String key,
                                  String value)

设置HttpServletResponseHeader属性

参数:

key - 参数 key

value - 参数值

返回:

返回this.

addHeader

protected WebController addHeader(String key,
                                  String value)

设置HttpServletResponseHeader属性

参数:

key - 参数 key

value - 参数值

返回:

返回this.

getPara

protected String getPara(String name)

Returns the value of a request parameter as a String, or null if the parameter does not exist.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParaValues(java.lang.String).

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

参数:

name - a String specifying the name of the parameter

返回:

a String representing the single value of the parameter

getPara

protected String getPara(String name,
                         String defaultValue)

Returns the value of a request parameter as a String, or default value if the parameter does not exist.

参数:

name - a String specifying the name of the parameter

defaultValue - a String value be returned when the value of parameter is null

返回:

a String representing the single value of the parameter

getParaMap

protected Map<String,String[]> getParaMap()

Returns the values of the request parameters as a Map.

返回:

a Map contains all the parameters name and value

getParaNames

protected Enumeration<String> getParaNames()

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

返回:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParaValues

protected String[] getParaValues(String name)

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist. If the parameter has a single value, the array has a length of 1.

参数:

name - a String containing the name of the parameter whose value is requested

返回:

an array of String objects containing the parameter's values

getParaValuesToInt

protected Integer[] getParaValuesToInt(String name)

Returns an array of Integer objects containing all of the values the given request parameter has, or null if the parameter does not exist. If the parameter has a single value, the array has a length of 1.

参数:

name - a String containing the name of the parameter whose value is requested

返回:

an array of Integer objects containing the parameter's values

getParaToInt

protected Integer getParaToInt(String name)

Returns the value of a request parameter and convert to Integer.

参数:

name - a String specifying the name of the parameter

返回:

a Integer representing the single value of the parameter

getParaToInt

protected Integer getParaToInt(String name,
                               Integer defaultValue)

Returns the value of a request parameter and convert to Integer with a default value if it is null.

参数:

name - a String specifying the name of the parameter

defaultValue - default value for the parameter

返回:

a Integer representing the single value of the parameter

getParaToLong

protected Long getParaToLong(String name)

Returns the value of a request parameter and convert to Long.

参数:

name - a String specifying the name of the parameter

返回:

a Integer representing the single value of the parameter

getParaToLong

protected Long getParaToLong(String name,
                             Long defaultValue)

Returns the value of a request parameter and convert to Long with a default value if it is null.

参数:

name - a String specifying the name of the parameter

defaultValue - default value for the parameter

返回:

a Integer representing the single value of the parameter

getParaToBoolean

protected Boolean getParaToBoolean(String name)

Returns the value of a request parameter and convert to Boolean.

参数:

name - a String specifying the name of the parameter

返回:

false if the value of the parameter is "false" or "0", true if it is "true" or "1", null if parameter is not exists

getParaToBoolean

protected Boolean getParaToBoolean(String name,
                                   Boolean defaultValue)

Returns the value of a request parameter and convert to Boolean with a default value if it is null.

参数:

name - a String specifying the name of the parameter

defaultValue - default value for the parameter

返回:

false if the value of the parameter is "false" or "0", true if it is "true" or "1", default value if it is null

getSession

protected javax.servlet.http.HttpSession getSession()

返回:

Return HttpSession.

getSession

protected javax.servlet.http.HttpSession getSession(boolean create)

Return HttpSession.

参数:

create - a boolean specifying create HttpSession if it not exists

返回:

Return HttpSession.

getSessionAttr

protected <T> T getSessionAttr(String key)

Return a Object from session.

参数:

key - a String specifying the key of the Object stored in session

返回:

return session attribute data.

setSessionAttr

protected WebController setSessionAttr(String key,
                                       Object value)

Store Object to session.

参数:

key - a String specifying the key of the Object stored in session

value - a Object specifying the value stored in session

返回:

返回this.

removeSessionAttr

protected WebController removeSessionAttr(String key)

Remove Object in session.

参数:

key - a String specifying the key of the Object stored in session

返回:

返回this.

getCookie

protected String getCookie(String name,
                           String defaultValue)

Get cookie value by cookie name.

参数:

name - cookie name

defaultValue - default value

返回:

return cookie value or default value.

getCookie

protected String getCookie(String name)

Get cookie value by cookie name.

参数:

name - cookie name

返回:

return cookie value or null.

getCookieToInt

protected Integer getCookieToInt(String name)

Get cookie value by cookie name and convert to Integer.

参数:

name - cookie name

返回:

return cookie value or null.

getCookieToInt

protected Integer getCookieToInt(String name,
                                 Integer defaultValue)

Get cookie value by cookie name and convert to Integer.

参数:

name - cookie name

defaultValue - default value

返回:

return cookie value or default value.

getCookieToLong

protected Long getCookieToLong(String name)

Get cookie value by cookie name and convert to Long.

参数:

name - cookie name

返回:

return cookie value or null.

getCookieToLong

protected Long getCookieToLong(String name,
                               Long defaultValue)

Get cookie value by cookie name and convert to Long.

参数:

name - cookie name

defaultValue - default value

返回:

return cookie value or default value.

getCookieObject

protected javax.servlet.http.Cookie getCookieObject(String name)

Get cookie object by cookie name.

参数:

name - cookie name

返回:

Cookie object

getCookieObjects

protected javax.servlet.http.Cookie[] getCookieObjects()

返回:

Get all cookie objects.

setCookie

protected WebController setCookie(javax.servlet.http.Cookie cookie)

Set Cookie to response.

参数:

cookie - new cookie.

返回:

返回this.

setCookie

protected WebController setCookie(String name,
                                  String value,
                                  int maxAgeInSeconds,
                                  String path)

Set Cookie to response.

参数:

name - cookie name

value - cookie value

maxAgeInSeconds - -1: clear cookie when close browser. 0: clear cookie immediately. n > 0 : max age in n seconds.

path - see Cookie.setPath(String)

返回:

返回this.

setCookie

protected WebController setCookie(String name,
                                  String value,
                                  int maxAgeInSeconds,
                                  String path,
                                  String domain)

Set Cookie to response.

参数:

name - cookie name

value - cookie value

maxAgeInSeconds - -1: clear cookie when close browser. 0: clear cookie immediately. n > 0 : max age in n seconds.

path - see Cookie.setPath(String)

domain - the domain name within which this cookie is visible; form is according to RFC 2109

返回:

返回this.

setCookie

protected WebController setCookie(String name,
                                  String value,
                                  int maxAgeInSeconds)

Set Cookie with path = "/".

参数:

name - cookie name

value - cookie value

maxAgeInSeconds - max age

返回:

返回this.

removeCookie

protected WebController removeCookie(String name)

Remove Cookie with path = "/".

参数:

name - cookie name

返回:

返回this.

removeCookie

protected WebController removeCookie(String name,
                                     String path)

Remove Cookie.

参数:

name - cookie name

path - cookie with path = "/".

返回:

返回this.

removeCookie

protected WebController removeCookie(String name,
                                     String path,
                                     String domain)

Remove Cookie.

参数:

name - cookie name

path - cookie with path = "/".

domain - domain

返回:

返回this.

getAttr

protected <T> T getAttr(String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

参数:

name - a String specifying the name of the attribute

返回:

an Object containing the value of the attribute, or null if the attribute does not exist

setAttr

protected WebController setAttr(String name,
                                Object value)

Stores an attribute in this request

参数:

name - a String specifying the name of the attribute

value - the Object to be stored

返回:

返回this.

removeAttr

protected WebController removeAttr(String name)

Removes an attribute from this request

参数:

name - a String specifying the name of the attribute to remove

返回:

返回this.

setAttrs

protected WebController setAttrs(Map<String,Object> attrMap)

Stores attributes in this request, key of the map as attribute name and value of the map as attribute value

参数:

attrMap - key and value as attribute of the map to be stored

返回:

返回this.

getAttrNames

protected Enumeration<String> getAttrNames()

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

返回:

an Enumeration of strings containing the names of the request's attributes

getData

protected <T> T getData(String name)

返回 Invoker 保存的数据。

返回:

返回数据

putData

protected WebController putData(String name,
                                Object value)

设置 Invoker 保存的数据。

返回:

返回 this

removeData

protected WebController removeData(String name)

删除 Invoker 保存的数据。

返回:

返回 this

setDatas

protected WebController setDatas(Map<String,Object> attrMap)

设置 Invoker 保存的数据。

返回:

返回 this

getDataNames

protected Set<String> getDataNames()

返回 Invoker 保存的数据keys。

返回:

返回数据

getInstance

protected <T> T getInstance(Class<T> modelClass,
                            String modelName)

返回:

Get model from AppContext.

getInstance

protected <T> T getInstance(Class<T> modelClass)

返回:

Get model from AppContext.

getInstance

protected Object getInstance(String bindID)

返回:

Get model from AppContext.

renderTo

protected void renderTo(String viewName)

更新渲染模版。

renderTo

protected void renderTo(String renderType,
                        String viewName)

更新渲染模版。

参数:

renderType - 如果注释了 Produces注解那么该参数将会失效。

viewName - 模版名称

isMultipart

protected boolean isMultipart()

返回为 Multipart 请求,通常 Multipart 请求都包含一个或多个的文件上传。

返回:

返回为 Multipart 请求,通常 Multipart 请求都包含一个或多个的文件上传。

另请参阅:

FileUpload.isMultipartContent(HttpServletRequest)

getMultipartList

protected List<FileItem> getMultipartList()
                                   throws IOException

将 multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(Integer maxPostSize)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.

参数:

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(String cacheDirectory,
                                          Integer maxPostSize)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.

参数:

cacheDirectory - 缓存目录

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(String cacheDirectory,
                                          Integer maxPostSize,
                                          String encoding)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

cacheDirectory - 缓存目录(默认配置位于:"hasor.fileupload.cacheDirectory")

maxPostSize - 最大单个 body 大小

encoding - 字符编码。

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(FileItemFactory factory)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

factory - 缓存策略

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(FileItemFactory factory,
                                          Integer maxPostSize)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

factory - 缓存策略

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipartList

protected List<FileItem> getMultipartList(FileItemFactory factory,
                                          Integer maxPostSize,
                                          String encoding)
                                   throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

factory - 缓存策略

maxPostSize - 最大单个 body 大小

encoding - 字符编码。

抛出:

IOException

getMultipart

protected List<FileItem> getMultipart(String parameterName)
                               throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

parameterName - 要获取的制定参数表单名

抛出:

IOException

getMultipart

protected List<FileItem> getMultipart(String parameterName,
                                      Integer maxPostSize)
                               throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表,

参数:

parameterName - 要获取的制定参数表单名

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipart

protected List<FileItem> getMultipart(String parameterName,
                                      String cacheDirectory,
                                      Integer maxPostSize)
                               throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表.

参数:

parameterName - 要获取的制定参数表单名

cacheDirectory - 缓存目录

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipart

protected List<FileItem> getMultipart(String parameterName,
                                      String cacheDirectory,
                                      Integer maxPostSize,
                                      String encoding)
                               throws IOException

将 Multipart 请求数据缓存到一个目录下,同时返回 FileItem 列表。

参数:

parameterName - 要获取的制定参数表单名

cacheDirectory - 缓存目录

maxPostSize - 最大单个 body 大小

encoding - 字符编码。

抛出:

IOException

getMultipartIterator

protected Iterator<FileItemStream> getMultipartIterator()
                                                 throws IOException

返回流式处理文件上传的迭代器。

抛出:

IOException

getMultipartIterator

protected Iterator<FileItemStream> getMultipartIterator(Integer maxPostSize)
                                                 throws IOException

返回流式处理文件上传的迭代器。

参数:

maxPostSize - 最大单个 body 大小

抛出:

IOException

getMultipartIterator

protected Iterator<FileItemStream> getMultipartIterator(Integer maxPostSize,
                                                        String encoding)
                                                 throws IOException

返回流式处理文件上传的迭代器。

参数:

maxPostSize - 最大单个 body 大小

encoding - 字符编码。

抛出:

IOException

newFileUpload

protected FileUpload newFileUpload(Integer maxPostSize,
                                   String encoding)

创建原始的FileUpload对象。

参数:

maxPostSize - 最大单个 body 大小

encoding - 字符编码。