com.alibaba.csb.sdk

类 HttpParameters.Builder

java.lang.Object

com.alibaba.csb.sdk.HttpParameters.Builder

封闭类:

HttpParameters

public static class HttpParameters.Builder
extends Object

内部静态类，用来设置HttpCaller调用的相关参数 只能有以下组合： 1. paramsMap: paramsMap以form表单方式提交 2. contentbody: 以json或二进制的 body 方式提交 3. paramsMap + contentBody: paramsMap以query方式提交，contentBody通过httpBody提交 4. paramsMap + attatchFileMap: multi part的 form 方式提交 5. contentbody + attatchFileMap: 暂不支持，因为http协议需要给contentBody命名 6. paramsMap+ contentbody + attatchFileMap: 暂不支持，因为http协议需要给contentBody命名

构造器概要

构造器

构造器和说明
Builder()

方法概要

限定符和类型	方法和说明
String	accessKey()
HttpParameters.Builder	accessKey(String ak) 设置安全参数ak
HttpParameters.Builder	addAttachFile(String key, File file) 增加附件
HttpParameters.Builder	addAttachFile(String key, File file, ContentEncoding contentEncoding) 增加附件
HttpParameters.Builder	addAttachFile(String key, String fileName, InputStream inputStream) 增加附件
HttpParameters.Builder	addAttachFile(String key, String fileName, InputStream inputStream, ContentEncoding contentEncoding) 增加附件
HttpParameters.Builder	addTraceHeader() 添加trace header
String	api()
HttpParameters.Builder	api(String api) 设置服务的api名
HttpParameters.Builder	bizId(String bizId) bizId不存在时设置, 适用于中间环节
HttpParameters	build() 生成最终的参数集合
HttpParameters.Builder	clearHeaderParamsMap() 清除所有已经设置的HTTP Header参数对
HttpParameters.Builder	clearParamsMap() 清除已经设置的参数对
ContentBody	contentBody()
HttpParameters.Builder	contentBody(ContentBody cb) 设置contentBody
ContentEncoding	contentEncoding()
org.apache.http.entity.ContentType	contentType()
HttpParameters.Builder	contentType(String contentTypeStr) 设置contentType
HttpParameters.Builder	copy()
HttpParameters.Builder	diagnostic(boolean diagnostic) 是否返回diagnostic信息
String	getBizId() 获取bizId
String	getRequestId() 获取requestId
String	getRpcId() 获取RpcId
String	getSignAlgorithm() 获取签名算法
int	getTotalFileSize()
String	getTraceId() 获取TraceId
Map<String,String>	headerMap()
String	method()
HttpParameters.Builder	method(String method) 设置调用的方式： 目前支持的取值是: get, post
HttpParameters.Builder	nonce(boolean nonceFlag)
Map<String,List<String>>	paramsMap()
HttpParameters.Builder	putHeaderParamsMap(String key, String value) 设置一个HTTP Header参数对
HttpParameters.Builder	putHeaderParamsMapAll(Map<String,String> map) 添加所有的Http Header参数对集合
HttpParameters.Builder	putParamsMap(Map<String,List<String>> map) 设置参数对集合
HttpParameters.Builder	putParamsMap(String key, List<String> valueList) 设置一个参数对列表
HttpParameters.Builder	putParamsMap(String key, String... value) 设置一个参数对列表
HttpParameters.Builder	putParamsMapAll(Map<String,String> map) 设置参数对集合
HttpParameters.Builder	putParamsMapListAll(Map<String,List<String>> map) 设置参数对集合
HttpParameters.Builder	requestId(String requestId)
HttpParameters.Builder	requestURL(String url) 设置HTTP请求的URL串
HttpParameters.Builder	restfulProtocolVersion(String restfulProtocolVersion) 设置open restful version，1.0 is enable restful path
String	secretKey()
HttpParameters.Builder	secretKey(String sk) 设置安全参数sk
HttpParameters.Builder	setBizId(String bizId) 设置bizId, 若已存在则覆盖
HttpParameters.Builder	setContentEncoding(ContentEncoding contentEncoding) 设置是否对 paramsMap和contentBody 进行压缩
HttpParameters.Builder	setRequest(javax.servlet.http.HttpServletRequest request) 设置Http Request，用于trace()前
HttpParameters.Builder	sginContentBody(boolean sign) 对ContentBody内设置的json串进行签名 注意： 对目前的任何CSB Broker版本，都还不支持对contentBody的签名验证， 所以设置该选择为true时，会导致验签失败！
HttpParameters.Builder	signAlgorithm(SpasSigner.SigningAlgorithm signAlgorithm) 签名算法
HttpParameters.Builder	signImpl(String signImpl) 设置SPI签名实现类, 不使用默认的签名实现方法，而是使用自定义的并且与CSB-Broker协商过的实现
HttpParameters.Builder	timestamp(boolean timestampFlag)
HttpParameters.Builder	trace() 启用trace，需先设置request，未引入TraceFilter时调用
HttpParameters.Builder	trace(javax.servlet.http.HttpServletRequest request) 启用trace，未引入TraceFilter时调用
String	url()
HttpParameters.Builder	verifySignImpl(String verifySignImpl) 设置SPI验签实现类, 不使用默认的验签实现方法，而是使用自定义的并且与CSB-Broker协商过的实现
String	version()
HttpParameters.Builder	version(String version) 设置服务的版本

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

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

构造器详细资料

Builder

public Builder()

方法详细资料

copy

public HttpParameters.Builder copy()

setContentEncoding

public HttpParameters.Builder setContentEncoding(ContentEncoding contentEncoding)

设置是否对 paramsMap和contentBody 进行压缩

addAttachFile

public HttpParameters.Builder addAttachFile(String key,
                                            String fileName,
                                            InputStream inputStream)

增加附件

addAttachFile

public HttpParameters.Builder addAttachFile(String key,
                                            File file)

增加附件

addAttachFile

public HttpParameters.Builder addAttachFile(String key,
                                            File file,
                                            ContentEncoding contentEncoding)

增加附件

addAttachFile

public HttpParameters.Builder addAttachFile(String key,
                                            String fileName,
                                            InputStream inputStream,
                                            ContentEncoding contentEncoding)

增加附件

getTotalFileSize

public int getTotalFileSize()

api

public HttpParameters.Builder api(String api)

设置服务的api名

参数:

api -

返回:

version

public HttpParameters.Builder version(String version)

设置服务的版本

参数:

version -

返回:

accessKey

public HttpParameters.Builder accessKey(String ak)

设置安全参数ak

参数:

ak -

返回:

secretKey

public HttpParameters.Builder secretKey(String sk)

设置安全参数sk

参数:

sk -

返回:

bizId

public HttpParameters.Builder bizId(String bizId)

bizId不存在时设置, 适用于中间环节

参数:

bizId -

返回:

setBizId

public HttpParameters.Builder setBizId(String bizId)

设置bizId, 若已存在则覆盖

参数:

bizId -

返回:

requestId

public HttpParameters.Builder requestId(String requestId)

signAlgorithm

public HttpParameters.Builder signAlgorithm(SpasSigner.SigningAlgorithm signAlgorithm)

签名算法

参数:

signAlgorithm -

返回:

setRequest

public HttpParameters.Builder setRequest(javax.servlet.http.HttpServletRequest request)

设置Http Request，用于trace()前

参数:

request -

返回:

trace

public HttpParameters.Builder trace(javax.servlet.http.HttpServletRequest request)

启用trace，未引入TraceFilter时调用

参数:

request -

返回:

trace

public HttpParameters.Builder trace()

启用trace，需先设置request，未引入TraceFilter时调用

返回:

addTraceHeader

public HttpParameters.Builder addTraceHeader()

添加trace header

返回:

restfulProtocolVersion

public HttpParameters.Builder restfulProtocolVersion(String restfulProtocolVersion)

设置open restful version，1.0 is enable restful path

参数:

restfulProtocolVersion -

返回:

method

public HttpParameters.Builder method(String method)

设置调用的方式： 目前支持的取值是: get, post

参数:

method -

返回:

timestamp

public HttpParameters.Builder timestamp(boolean timestampFlag)

参数:

timestampFlag, - 是否生成时间戳，默认是生成的

返回:

nonce

public HttpParameters.Builder nonce(boolean nonceFlag)

参数:

nonceFlag, - 是否生成nonce header

返回:

requestURL

public HttpParameters.Builder requestURL(String url)

设置HTTP请求的URL串

参数:

url -

返回:

clearParamsMap

public HttpParameters.Builder clearParamsMap()

清除已经设置的参数对

返回:

putParamsMap

public HttpParameters.Builder putParamsMap(String key,
                                           List<String> valueList)

设置一个参数对列表

参数:

key -

valueList -

返回:

putParamsMap

public HttpParameters.Builder putParamsMap(String key,
                                           String... value)

设置一个参数对列表

参数:

key -

value -

返回:

putParamsMapAll

public HttpParameters.Builder putParamsMapAll(Map<String,String> map)

设置参数对集合

参数:

map -

返回:

putParamsMap

public HttpParameters.Builder putParamsMap(Map<String,List<String>> map)

设置参数对集合

参数:

map -

返回:

putParamsMapListAll

public HttpParameters.Builder putParamsMapListAll(Map<String,List<String>> map)

设置参数对集合

参数:

map -

返回:

clearHeaderParamsMap

public HttpParameters.Builder clearHeaderParamsMap()

清除所有已经设置的HTTP Header参数对

返回:

putHeaderParamsMap

public HttpParameters.Builder putHeaderParamsMap(String key,
                                                 String value)

设置一个HTTP Header参数对

参数:

key -

value -

返回:

putHeaderParamsMapAll

public HttpParameters.Builder putHeaderParamsMapAll(Map<String,String> map)

添加所有的Http Header参数对集合

参数:

map -

返回:

contentType

public HttpParameters.Builder contentType(String contentTypeStr)

设置contentType

参数:

contentTypeStr -

返回:

contentBody

public HttpParameters.Builder contentBody(ContentBody cb)

设置contentBody

参数:

cb -

返回:

sginContentBody

public HttpParameters.Builder sginContentBody(boolean sign)

对ContentBody内设置的json串进行签名 注意： 对目前的任何CSB Broker版本，都还不支持对contentBody的签名验证， 所以设置该选择为true时，会导致验签失败！

参数:

sign -

返回:

signImpl

public HttpParameters.Builder signImpl(String signImpl)

设置SPI签名实现类, 不使用默认的签名实现方法，而是使用自定义的并且与CSB-Broker协商过的实现

参数:

signImpl -

返回:

verifySignImpl

public HttpParameters.Builder verifySignImpl(String verifySignImpl)

设置SPI验签实现类, 不使用默认的验签实现方法，而是使用自定义的并且与CSB-Broker协商过的实现

参数:

verifySignImpl -

返回:

diagnostic

public HttpParameters.Builder diagnostic(boolean diagnostic)

是否返回diagnostic信息

参数:

diagnostic -

返回:

build

public HttpParameters build()

生成最终的参数集合

返回:

getTraceId

public String getTraceId()

获取TraceId

返回:

getRpcId

public String getRpcId()

获取RpcId

返回:

getBizId

public String getBizId()

获取bizId

返回:

getRequestId

public String getRequestId()

获取requestId

返回:

getSignAlgorithm

public String getSignAlgorithm()

获取签名算法

返回:

api

public String api()

version

public String version()

accessKey

public String accessKey()

secretKey

public String secretKey()

method

public String method()

url

public String url()

paramsMap

public Map<String,List<String>> paramsMap()

headerMap

public Map<String,String> headerMap()

contentBody

public ContentBody contentBody()

contentType

public org.apache.http.entity.ContentType contentType()

contentEncoding

public ContentEncoding contentEncoding()