org.xutils.http

类 RequestParams

java.lang.Object

org.xutils.http.RequestParams

public class RequestParams
extends java.lang.Object

Created by wyouflf on 15/7/17. 网络请求参数实体

构造器概要

构造器

构造器和说明
RequestParams() 使用空构造创建时必须, 必须是带有@HttpRequest注解的子类.
RequestParams(java.lang.String uri)
RequestParams(java.lang.String uri, ParamsBuilder builder, java.lang.String[] signs, java.lang.String[] cacheKeys)

方法概要

限定符和类型	方法和说明
void	addBodyParameter(java.lang.String name, java.io.File value) 添加body参数
void	addBodyParameter(java.lang.String name, java.lang.Object value, java.lang.String contentType) 添加body参数
void	addBodyParameter(java.lang.String name, java.lang.Object value, java.lang.String contentType, java.lang.String fileName) 添加body参数
void	addBodyParameter(java.lang.String name, java.lang.String value) 添加参数至Body
void	addHeader(java.lang.String name, java.lang.String value)
void	addParameter(java.lang.String name, java.lang.Object value) 添加请求参数(根据请求谓词, 将参数加入QueryString或Body.)
void	addQueryStringParameter(java.lang.String name, java.lang.String value) 添加参数至Query String
void	clearParams()
java.lang.String	getBodyContent()
java.util.HashMap<java.lang.String,java.lang.String>	getBodyParams()
java.lang.String	getCacheDirName()
java.lang.String	getCacheKey()
long	getCacheSize()
java.lang.String	getCharset()
int	getConnectTimeout()
java.util.concurrent.Executor	getExecutor()
java.util.HashMap<java.lang.String,java.lang.Object>	getFileParams()
java.util.HashMap<java.lang.String,java.lang.String>	getHeaders()
HttpRetryHandler	getHttpRetryHandler()
int	getMaxRetryCount()
HttpMethod	getMethod()
Priority	getPriority()
java.net.Proxy	getProxy()
java.util.HashMap<java.lang.String,java.lang.String>	getQueryStringParams()
RedirectHandler	getRedirectHandler()
RequestBody	getRequestBody()
java.lang.String	getSaveFilePath() 获取下载文件时文件保存的路径和文件名
javax.net.ssl.SSLSocketFactory	getSslSocketFactory()
java.lang.String	getStringParameter(java.lang.String name)
java.util.HashMap<java.lang.String,java.lang.String>	getStringParams()
java.lang.String	getUri()
boolean	isAsJsonContent() 用json形式的bodyContent上传
boolean	isAutoRename() 是否根据头信息自动命名文件
boolean	isAutoResume() 是否在下载是自动断点续传
boolean	isCancelFast() 是否可以被立即停止.
boolean	isMultipart()
void	removeParameter(java.lang.String name)
void	setAsJsonContent(boolean asJsonContent) 以json形式提交body参数
void	setAutoRename(boolean autoRename) 设置是否根据头信息自动命名文件
void	setAutoResume(boolean autoResume) 设置是否在下载是自动断点续传
void	setBodyContent(java.lang.String content)
void	setCacheDirName(java.lang.String cacheDirName)
void	setCacheSize(long cacheSize)
void	setCancelFast(boolean cancelFast) 是否可以被立即停止.
void	setCharset(java.lang.String charset)
void	setConnectTimeout(int connectTimeout)
void	setExecutor(java.util.concurrent.Executor executor)
void	setHttpRetryHandler(HttpRetryHandler httpRetryHandler)
void	setMaxRetryCount(int maxRetryCount)
void	setMethod(HttpMethod method)
void	setMultipart(boolean multipart)
void	setPriority(Priority priority)
void	setProxy(java.net.Proxy proxy)
void	setRedirectHandler(RedirectHandler redirectHandler) 自定义重定向接口, 默认系统自动重定向.
void	setRequestBody(RequestBody requestBody)
void	setSaveFilePath(java.lang.String saveFilePath) 设置下载文件时文件保存的路径和文件名
void	setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)
java.lang.String	toString()

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

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

构造器详细资料

RequestParams

public RequestParams()

使用空构造创建时必须, 必须是带有@HttpRequest注解的子类.

RequestParams

public RequestParams(java.lang.String uri)

参数:

uri - 不可为空

RequestParams

public RequestParams(java.lang.String uri,
                     ParamsBuilder builder,
                     java.lang.String[] signs,
                     java.lang.String[] cacheKeys)

参数:

uri - 不可为空

builder -

signs -

cacheKeys -

方法详细资料

getUri

public java.lang.String getUri()

getCacheKey

public java.lang.String getCacheKey()

setSslSocketFactory

public void setSslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)

getSslSocketFactory

public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

setMethod

public void setMethod(HttpMethod method)

getMethod

public HttpMethod getMethod()

setCharset

public void setCharset(java.lang.String charset)

getCharset

public java.lang.String getCharset()

getProxy

public java.net.Proxy getProxy()

setProxy

public void setProxy(java.net.Proxy proxy)

getPriority

public Priority getPriority()

setPriority

public void setPriority(Priority priority)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

getCacheDirName

public java.lang.String getCacheDirName()

setCacheDirName

public void setCacheDirName(java.lang.String cacheDirName)

getCacheSize

public long getCacheSize()

setCacheSize

public void setCacheSize(long cacheSize)

getExecutor

public java.util.concurrent.Executor getExecutor()

setExecutor

public void setExecutor(java.util.concurrent.Executor executor)

isAutoResume

public boolean isAutoResume()

是否在下载是自动断点续传

setAutoResume

public void setAutoResume(boolean autoResume)

设置是否在下载是自动断点续传

参数:

autoResume -

isAutoRename

public boolean isAutoRename()

是否根据头信息自动命名文件

setAutoRename

public void setAutoRename(boolean autoRename)

设置是否根据头信息自动命名文件

参数:

autoRename -

getSaveFilePath

public java.lang.String getSaveFilePath()

获取下载文件时文件保存的路径和文件名

setSaveFilePath

public void setSaveFilePath(java.lang.String saveFilePath)

设置下载文件时文件保存的路径和文件名

参数:

saveFilePath -

getMaxRetryCount

public int getMaxRetryCount()

setMaxRetryCount

public void setMaxRetryCount(int maxRetryCount)

isMultipart

public boolean isMultipart()

setMultipart

public void setMultipart(boolean multipart)

isCancelFast

public boolean isCancelFast()

是否可以被立即停止.

返回:

true: 为请求创建新的线程, 取消时请求线程被立即中断; false: 请求建立过程可能不被立即终止.

setCancelFast

public void setCancelFast(boolean cancelFast)

是否可以被立即停止.

参数:

cancelFast - true: 为请求创建新的线程, 取消时请求线程被立即中断; false: 请求建立过程可能不被立即终止.

getHttpRetryHandler

public HttpRetryHandler getHttpRetryHandler()

setHttpRetryHandler

public void setHttpRetryHandler(HttpRetryHandler httpRetryHandler)

getRedirectHandler

public RedirectHandler getRedirectHandler()

setRedirectHandler

public void setRedirectHandler(RedirectHandler redirectHandler)

自定义重定向接口, 默认系统自动重定向.

参数:

redirectHandler -

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

addParameter

public void addParameter(java.lang.String name,
                         java.lang.Object value)

添加请求参数(根据请求谓词, 将参数加入QueryString或Body.)

参数:

name - 参数名

value - 可以是String, File, InputStream 或 byte[]

addQueryStringParameter

public void addQueryStringParameter(java.lang.String name,
                                    java.lang.String value)

添加参数至Query String

参数:

name -

value -

addBodyParameter

public void addBodyParameter(java.lang.String name,
                             java.lang.String value)

添加参数至Body

参数:

name -

value -

addBodyParameter

public void addBodyParameter(java.lang.String name,
                             java.io.File value)

添加body参数

addBodyParameter

public void addBodyParameter(java.lang.String name,
                             java.lang.Object value,
                             java.lang.String contentType)

添加body参数

参数:

name - 参数名

value - 可以是String, File, InputStream 或 byte[]

contentType - 可为null

addBodyParameter

public void addBodyParameter(java.lang.String name,
                             java.lang.Object value,
                             java.lang.String contentType,
                             java.lang.String fileName)

添加body参数

参数:

name - 参数名

value - 可以是String, File, InputStream 或 byte[]

contentType - 可为null

fileName - 服务端看到的文件名

isAsJsonContent

public boolean isAsJsonContent()

用json形式的bodyContent上传

返回:

setAsJsonContent

public void setAsJsonContent(boolean asJsonContent)

以json形式提交body参数

参数:

asJsonContent -

setBodyContent

public void setBodyContent(java.lang.String content)

getBodyContent

public java.lang.String getBodyContent()

getHeaders

public java.util.HashMap<java.lang.String,java.lang.String> getHeaders()

getQueryStringParams

public java.util.HashMap<java.lang.String,java.lang.String> getQueryStringParams()

getBodyParams

public java.util.HashMap<java.lang.String,java.lang.String> getBodyParams()

getFileParams

public java.util.HashMap<java.lang.String,java.lang.Object> getFileParams()

getStringParams

public java.util.HashMap<java.lang.String,java.lang.String> getStringParams()

getStringParameter

public java.lang.String getStringParameter(java.lang.String name)

clearParams

public void clearParams()

removeParameter

public void removeParameter(java.lang.String name)

setRequestBody

public void setRequestBody(RequestBody requestBody)

getRequestBody

public RequestBody getRequestBody()
                           throws java.io.IOException

抛出:

java.io.IOException

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object