cn.ponfee.commons.web

类 WebUtils

java.lang.Object

cn.ponfee.commons.web.WebUtils

public final class WebUtils
extends Object

web工具类

作者:

Ponfee

字段概要

字段

限定符和类型	字段和说明
static String	AUTH_COOKIE
static String	AUTH_HEADER authorization
static String	AUTH_PARAME
static String	COOKIE_ROOT_PATH
static String	INCLUDE_CONTEXT_PATH_ATTRIBUTE

构造器概要

构造器

构造器和说明
WebUtils()

方法概要

限定符和类型	方法和说明
static void	addCookie(javax.servlet.http.HttpServletResponse response, String name, String value) 设置cookie
static void	addCookie(javax.servlet.http.HttpServletResponse resp, String name, String value, String path, int maxAge) 设置cookie
static void	cors(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) ross-Origin Resource Sharing
static javax.servlet.http.Cookie	createCookie(String name, String value, String path, int maxAge) Creates a cookie
static void	delCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String name)
static void	delCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, String path, String name) Delete the cookie by spec name
static void	download(javax.servlet.http.HttpServletResponse resp, byte[] data, String filename)
static void	download(javax.servlet.http.HttpServletResponse resp, byte[] data, String filename, String charset, boolean isGzip, boolean withBom) Response as a stream attachment
static void	download(javax.servlet.http.HttpServletResponse resp, InputStream input, String filename) response to input stream
static void	download(javax.servlet.http.HttpServletResponse resp, InputStream input, String filename, String charset, boolean isGzip, boolean withBom) Response as a stream attachment
static LiteDevice	getClientDevice(javax.servlet.http.HttpServletRequest req) 获取客户端设备类型
static String	getClientIp(javax.servlet.http.HttpServletRequest req) 获取客户端ip
static String	getContextPath(javax.servlet.http.HttpServletRequest request) Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.
static String	getContextPath(javax.servlet.ServletContext context)
static String	getCookie(javax.servlet.http.HttpServletRequest req, String name) get cookie value
static Map<String,String>	getParams(javax.servlet.http.HttpServletRequest request) Gets the http servlet request parameters the parameter value is String type if is array parameter, then the value is based-join on "," as String
static String	getSessionTrace(javax.servlet.http.HttpServletRequest request) 会话跟踪
static String	getText(javax.servlet.http.HttpServletRequest request)
static String	getText(javax.servlet.http.HttpServletRequest request, String charset) get the text string from request input stream
static String	getUrlSuffix(javax.servlet.http.HttpServletRequest req) 获取请求地址后缀名
static boolean	isAjax(javax.servlet.http.HttpServletRequest req) 判断是否ajax请求
static String	normalize(String path) Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it.
static String	normalize(String path, boolean replaceBackSlash) Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it.
static void	respJson(javax.servlet.http.HttpServletResponse resp, Object data) 响应json数据
static void	respJson(javax.servlet.http.HttpServletResponse resp, Object data, String charset)
static void	respJsonp(javax.servlet.http.HttpServletResponse response, String callback, Object data)
static void	respJsonp(javax.servlet.http.HttpServletResponse resp, String callback, Object data, String charset) 响应jsonp数据
static void	response(javax.servlet.http.HttpServletResponse resp, byte[] data, ContentType contentType, boolean isGzip) 响应数据流，如图片数据 response(resp, image_byte_array, ContentType.IMAGE_JPEG.value(), false);
static void	response(javax.servlet.http.HttpServletResponse resp, ContentType contentType, String text, String charset) 响应数据到请求客户端
static void	response(javax.servlet.http.HttpServletResponse resp, InputStream input, ContentType contentType, boolean isGzip) 响应数据流，如图片数据 response(resp, image_file_input_stream, ContentType.IMAGE_JPEG.value(), false);
static void	setSessionTrace(javax.servlet.http.HttpServletResponse response, String token) 会话跟踪
static String	userAgent(javax.servlet.http.HttpServletRequest req) Returns the web browser user-agent
static String	xssReplace(String text)

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

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

字段详细资料

INCLUDE_CONTEXT_PATH_ATTRIBUTE

public static final String INCLUDE_CONTEXT_PATH_ATTRIBUTE

另请参阅:

常量字段值

AUTH_HEADER

public static final String AUTH_HEADER

authorization

另请参阅:

常量字段值

AUTH_COOKIE

public static final String AUTH_COOKIE

另请参阅:

常量字段值

AUTH_PARAME

public static final String AUTH_PARAME

另请参阅:

常量字段值

COOKIE_ROOT_PATH

public static final String COOKIE_ROOT_PATH

另请参阅:

常量字段值

构造器详细资料

WebUtils

public WebUtils()

方法详细资料

getParams

public static Map<String,String> getParams(javax.servlet.http.HttpServletRequest request)

Gets the http servlet request parameters the parameter value is String type if is array parameter, then the value is based-join on "," as String

参数:

request -

返回:

Map, the array param value use "," to join

getText

public static String getText(javax.servlet.http.HttpServletRequest request)

getText

public static String getText(javax.servlet.http.HttpServletRequest request,
                             String charset)

get the text string from request input stream

参数:

request - the HttpServletRequest

charset - the string encoding

返回:

string

getClientIp

public static String getClientIp(javax.servlet.http.HttpServletRequest req)

获取客户端ip

参数:

req -

返回:

getClientDevice

public static LiteDevice getClientDevice(javax.servlet.http.HttpServletRequest req)

获取客户端设备类型

返回:

isAjax

public static boolean isAjax(javax.servlet.http.HttpServletRequest req)

判断是否ajax请求

参数:

req -

返回:

userAgent

public static String userAgent(javax.servlet.http.HttpServletRequest req)

Returns the web browser user-agent

参数:

req - the HttpServletRequest

返回:

web browser user-agent

response

public static void response(javax.servlet.http.HttpServletResponse resp,
                            ContentType contentType,
                            String text,
                            String charset)

响应数据到请求客户端

参数:

resp -

contentType -

text -

charset -

respJson

public static void respJson(javax.servlet.http.HttpServletResponse resp,
                            Object data)

响应json数据

参数:

resp -

data -

respJson

public static void respJson(javax.servlet.http.HttpServletResponse resp,
                            Object data,
                            String charset)

respJsonp

public static void respJsonp(javax.servlet.http.HttpServletResponse response,
                             String callback,
                             Object data)

respJsonp

public static void respJsonp(javax.servlet.http.HttpServletResponse resp,
                             String callback,
                             Object data,
                             String charset)

响应jsonp数据

参数:

resp -

callback -

data -

charset -

download

public static void download(javax.servlet.http.HttpServletResponse resp,
                            byte[] data,
                            String filename)

download

public static void download(javax.servlet.http.HttpServletResponse resp,
                            byte[] data,
                            String filename,
                            String charset,
                            boolean isGzip,
                            boolean withBom)

Response as a stream attachment

参数:

resp - the HttpServletResponse

data - the resp byte array data

filename - the resp attachment filename

charset - the attachment filename encoding

isGzip - true to use gzip compress

withBom - true with bom header

download

public static void download(javax.servlet.http.HttpServletResponse resp,
                            InputStream input,
                            String filename)

response to input stream

参数:

resp - the HttpServletResponse

input - the input stream

filename - the resp attachment filename

download

public static void download(javax.servlet.http.HttpServletResponse resp,
                            InputStream input,
                            String filename,
                            String charset,
                            boolean isGzip,
                            boolean withBom)

Response as a stream attachment

参数:

resp - the HttpServletResponse

input - the input stream

filename - the resp attachment filename

charset - the attachment filename encoding

isGzip - true to use gzip compress

withBom - true with bom header

response

public static void response(javax.servlet.http.HttpServletResponse resp,
                            byte[] data,
                            ContentType contentType,
                            boolean isGzip)

响应数据流，如图片数据 response(resp, image_byte_array, ContentType.IMAGE_JPEG.value(), false);

参数:

resp - the HttpServletResponse

data - the byte array data

contentType - the content-type

isGzip - whether to encode gzip

response

public static void response(javax.servlet.http.HttpServletResponse resp,
                            InputStream input,
                            ContentType contentType,
                            boolean isGzip)

响应数据流，如图片数据 response(resp, image_file_input_stream, ContentType.IMAGE_JPEG.value(), false);

参数:

resp - the HttpServletResponse

input - the input stream

contentType - the content-type

isGzip - whether to encode gzip

cors

public static void cors(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp)

ross-Origin Resource Sharing

参数:

req - the HttpServletRequest

resp - the HttpServletResponse

getUrlSuffix

public static String getUrlSuffix(javax.servlet.http.HttpServletRequest req)

获取请求地址后缀名

参数:

req -

返回:

xssReplace

public static String xssReplace(String text)

getCookie

public static String getCookie(javax.servlet.http.HttpServletRequest req,
                               String name)

get cookie value

参数:

req -

name -

返回:

delCookie

public static void delCookie(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             String name)

delCookie

public static void delCookie(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             String path,
                             String name)

Delete the cookie by spec name

参数:

req - the HttpServletRequest

resp - the HttpServletResponse

path - the cookie path

name - the cookie name

addCookie

public static void addCookie(javax.servlet.http.HttpServletResponse response,
                             String name,
                             String value)

设置cookie

参数:

response -

name -

value -

addCookie

public static void addCookie(javax.servlet.http.HttpServletResponse resp,
                             String name,
                             String value,
                             String path,
                             int maxAge)

设置cookie

参数:

resp -

name -

value -

path -

maxAge -

createCookie

public static javax.servlet.http.Cookie createCookie(String name,
                                                     String value,
                                                     String path,
                                                     int maxAge)

Creates a cookie

参数:

name -

value -

path -

maxAge -

返回:

an object of cookie

setSessionTrace

public static void setSessionTrace(javax.servlet.http.HttpServletResponse response,
                                   String token)

会话跟踪

getSessionTrace

public static String getSessionTrace(javax.servlet.http.HttpServletRequest request)

会话跟踪

getContextPath

public static String getContextPath(javax.servlet.ServletContext context)

getContextPath

public static String getContextPath(javax.servlet.http.HttpServletRequest request)

Return the context path for the given request, detecting an include request URL if called within a RequestDispatcher include.

As the value returned by request.getContextPath() is not decoded by the servlet container, this method will decode it.

参数:

request - current HTTP request

返回:

the context path

normalize

public static String normalize(String path)

Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it. WARNING - This method is useful only for normalizing application-generated paths. It does not try to perform security checks for malicious input. Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in Tomcat trunk, r939305

参数:

path - Relative path to be normalized

返回:

normalized path

normalize

public static String normalize(String path,
                               boolean replaceBackSlash)

Normalize a relative URI path that may have relative values ("/./", "/../", and so on ) it it. WARNING - This method is useful only for normalizing application-generated paths. It does not try to perform security checks for malicious input. Normalize operations were was happily taken from org.apache.catalina.util.RequestUtil in Tomcat trunk, r939305

参数:

path - Relative path to be normalized

replaceBackSlash - Should '\\' be replaced with '/'

返回:

normalized path