sviolet.slate.common.x.net.loadbalance.classic

类 MultiHostOkHttpClient.Request

java.lang.Object

sviolet.slate.common.x.net.loadbalance.classic.MultiHostOkHttpClient.Request

封闭类:

MultiHostOkHttpClient

public static class MultiHostOkHttpClient.Request
extends java.lang.Object

请求(该对象非线程安全, 请勿多线程操作同一个对象)

方法概要

限定符和类型	方法和说明
MultiHostOkHttpClient.Request	autoClose(boolean autoClose) [配置]异步请求专用: 配置响应实例(或输入流)是否在回调方法onSucceed结束后自动关闭, 默认true 注意:同步请求返回的ResponsePackage/InputStream是必须手动关闭的!!!
MultiHostOkHttpClient.Request	beanBody(java.lang.Object beanBody) [配置]POST请求专用: 请求报文体, JavaBean 注意: 必须配置DataConverter, 否则发送时会报错
MultiHostOkHttpClient.Request	body(byte[] body) [配置]POST请求专用: 请求报文体, byte[]类型
MultiHostOkHttpClient.Request	connectTimeout(int connectTimeout) [配置]该次请求的连接超时, 单位ms
MultiHostOkHttpClient.Request	dataConverter(DataConverter dataConverter) [配置]数据转换器, 用于将beanBody设置的JavaBean转换为byte[], 和将返回报文byte[]转换为JavaBean 客户端配置和此处配置的均生效(此处配置优先)
MultiHostOkHttpClient.Request	encode(java.lang.String encode) [配置]字符编码, 客户端配置和此处配置的均生效(此处配置优先)
MultiHostOkHttpClient.Stub	enqueue(MultiHostOkHttpClient.BeanCallback<?> callback) [请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常 注意: 必须配置DataConverter, 否则发送时会报错
MultiHostOkHttpClient.Stub	enqueue(MultiHostOkHttpClient.BytesCallback callback) [请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常,
MultiHostOkHttpClient.Stub	enqueue(MultiHostOkHttpClient.InputStreamCallback callback) [请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常,
MultiHostOkHttpClient.Stub	enqueue(MultiHostOkHttpClient.ResponsePackageCallback callback) [请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常, 该方法不会根据maxReadLength限定最大读取长度
MultiHostOkHttpClient.Request	formBody(java.util.Map<java.lang.String,java.lang.Object> formBody) [配置]POST请求专用: 请求报文体, 表单
MultiHostOkHttpClient.Request	httpHeader(java.lang.String key, java.lang.String value) [配置]添加一个HTTP请求头参数, 客户端配置和此处配置的均生效(此处配置优先)
MultiHostOkHttpClient.Request	httpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders) [配置]HTTP请求头参数, 客户端配置和此处配置的均生效(此处配置优先)
MultiHostOkHttpClient.Request	mediaType(java.lang.String mediaType) [配置]报文体MediaType, 客户端配置和此处配置的均生效(此处配置优先)
MultiHostOkHttpClient.Request	passiveBlockDuration(long passiveBlockDuration) [配置]设置被动检测到网络故障时阻断后端的时间, 客户端配置和此处配置的均生效(此处配置优先) 当请求服务端时, 发生特定的异常或返回特定的响应码(MultiHostOkHttpClient.needBlock方法决定), 客户端会将该 后端服务器的IP/PORT标记为暂不可用状态, 而阻断时长是不可用的时长
MultiHostOkHttpClient.Request	readTimeout(int readTimeout) [配置]该次请求的读数据超时, 单位ms
MultiHostOkHttpClient.ResponsePackage	send() [请求发送]同步请求并获取ResponsePackage返回, 如果响应码不为2XX, 会抛出HttpRejectException异常, 该方法不会根据maxReadLength限定最大读取长度
<T> T	sendForBean(java.lang.Class<T> type) [请求发送]同步请求并获取Bean返回, 如果响应码不为2XX, 会抛出HttpRejectException异常.
byte[]	sendForBytes() [请求发送]同步请求并获取byte[]返回, 如果响应码不为2XX, 会抛出HttpRejectException异常
java.io.InputStream	sendForInputStream() [请求发送]同步请求并获取InputStream返回, 如果响应码不为2XX, 会抛出HttpRejectException异常
java.lang.String	toString()
MultiHostOkHttpClient.Request	urlParam(java.lang.String key, java.lang.Object value) [配置]添加一个URL参数, 即HTTP请求中URL后面跟随的?
MultiHostOkHttpClient.Request	urlParams(java.util.Map<java.lang.String,java.lang.Object> urlParams) [配置]URL参数, 即HTTP请求中URL后面跟随的?
MultiHostOkHttpClient.Request	writeTimeout(int writeTimeout) [配置]该次请求的写数据超时, 单位ms

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

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

方法详细资料

urlParams

public MultiHostOkHttpClient.Request urlParams(java.util.Map<java.lang.String,java.lang.Object> urlParams)

[配置]URL参数, 即HTTP请求中URL后面跟随的?key=value&key=value

urlParam

public MultiHostOkHttpClient.Request urlParam(java.lang.String key,
                                              java.lang.Object value)

[配置]添加一个URL参数, 即HTTP请求中URL后面跟随的?key=value&key=value

body

public MultiHostOkHttpClient.Request body(byte[] body)

[配置]POST请求专用: 请求报文体, byte[]类型

formBody

public MultiHostOkHttpClient.Request formBody(java.util.Map<java.lang.String,java.lang.Object> formBody)

[配置]POST请求专用: 请求报文体, 表单

beanBody

public MultiHostOkHttpClient.Request beanBody(java.lang.Object beanBody)

[配置]POST请求专用: 请求报文体, JavaBean
注意: 必须配置DataConverter, 否则发送时会报错

httpHeaders

public MultiHostOkHttpClient.Request httpHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)

[配置]HTTP请求头参数, 客户端配置和此处配置的均生效(此处配置优先)

httpHeader

public MultiHostOkHttpClient.Request httpHeader(java.lang.String key,
                                                java.lang.String value)

[配置]添加一个HTTP请求头参数, 客户端配置和此处配置的均生效(此处配置优先)

passiveBlockDuration

public MultiHostOkHttpClient.Request passiveBlockDuration(long passiveBlockDuration)

[配置]设置被动检测到网络故障时阻断后端的时间, 客户端配置和此处配置的均生效(此处配置优先)

当请求服务端时, 发生特定的异常或返回特定的响应码(MultiHostOkHttpClient.needBlock方法决定), 客户端会将该 后端服务器的IP/PORT标记为暂不可用状态, 而阻断时长是不可用的时长

参数:

passiveBlockDuration - 阻断时长ms

mediaType

public MultiHostOkHttpClient.Request mediaType(java.lang.String mediaType)

[配置]报文体MediaType, 客户端配置和此处配置的均生效(此处配置优先)

encode

public MultiHostOkHttpClient.Request encode(java.lang.String encode)

[配置]字符编码, 客户端配置和此处配置的均生效(此处配置优先)

dataConverter

public MultiHostOkHttpClient.Request dataConverter(DataConverter dataConverter)

[配置]数据转换器, 用于将beanBody设置的JavaBean转换为byte[], 和将返回报文byte[]转换为JavaBean
客户端配置和此处配置的均生效(此处配置优先)

autoClose

public MultiHostOkHttpClient.Request autoClose(boolean autoClose)

[配置]异步请求专用: 配置响应实例(或输入流)是否在回调方法onSucceed结束后自动关闭, 默认true

注意:同步请求返回的ResponsePackage/InputStream是必须手动关闭的!!!

当autoClose=true时, onSucceed方法回调结束后, ResponsePackage/InputStream会被自动关闭, 无需手动调用close方法. 适用于 响应数据在回调方法中处理完的场合.
当autoClose=false时, onSucceed方法回调结束后, ResponsePackage/InputStream不会自动关闭, 需要手动调用ResponsePackage.close()关闭, 注意!!! 适用于响应数据需要交由其他的线程处理, 或暂时持有的场合使用.

connectTimeout

public MultiHostOkHttpClient.Request connectTimeout(int connectTimeout)

[配置]该次请求的连接超时, 单位ms

writeTimeout

public MultiHostOkHttpClient.Request writeTimeout(int writeTimeout)

[配置]该次请求的写数据超时, 单位ms

readTimeout

public MultiHostOkHttpClient.Request readTimeout(int readTimeout)

[配置]该次请求的读数据超时, 单位ms

sendForBean

public <T> T sendForBean(java.lang.Class<T> type)
                  throws NoHostException,
                         RequestBuildException,
                         HttpRejectException,
                         java.io.IOException

[请求发送]同步请求并获取Bean返回, 如果响应码不为2XX, 会抛出HttpRejectException异常.
注意: 必须配置DataConverter, 否则会报错

返回:

响应, 可能为null

抛出:

NoHostException - 当前没有可发送的后端(网络请求发送前的异常, 准备阶段异常)

RequestBuildException - 请求初始化异常(通常是网络请求发送前的异常, 准备阶段异常)

java.io.IOException - 网络通讯异常(通常是网络请求发送中的异常)

HttpRejectException - Http请求拒绝异常(网络请求发送后的异常, HTTP响应码不为2XX)

sendForBytes

public byte[] sendForBytes()
                    throws NoHostException,
                           RequestBuildException,
                           HttpRejectException,
                           java.io.IOException

[请求发送]同步请求并获取byte[]返回, 如果响应码不为2XX, 会抛出HttpRejectException异常

返回:

响应, 可能为null

抛出:

NoHostException - 当前没有可发送的后端(网络请求发送前的异常, 准备阶段异常)

RequestBuildException - 请求初始化异常(通常是网络请求发送前的异常, 准备阶段异常)

java.io.IOException - 网络通讯异常(通常是网络请求发送中的异常)

HttpRejectException - Http请求拒绝异常(网络请求发送后的异常, HTTP响应码不为2XX)

sendForInputStream

public java.io.InputStream sendForInputStream()
                                       throws NoHostException,
                                              RequestBuildException,
                                              HttpRejectException,
                                              java.io.IOException

[请求发送]同步请求并获取InputStream返回, 如果响应码不为2XX, 会抛出HttpRejectException异常

返回:

响应, 可能为null, InputStream用完后必须手动关闭!!!

抛出:

NoHostException - 当前没有可发送的后端(网络请求发送前的异常, 准备阶段异常)

RequestBuildException - 请求初始化异常(通常是网络请求发送前的异常, 准备阶段异常)

java.io.IOException - 网络通讯异常(通常是网络请求发送中的异常)

HttpRejectException - Http请求拒绝异常(网络请求发送后的异常, HTTP响应码不为2XX)

send

public MultiHostOkHttpClient.ResponsePackage send()
                                           throws NoHostException,
                                                  RequestBuildException,
                                                  java.io.IOException,
                                                  HttpRejectException

[请求发送]同步请求并获取ResponsePackage返回, 如果响应码不为2XX, 会抛出HttpRejectException异常, 该方法不会根据maxReadLength限定最大读取长度

返回:

响应, 可能为null, ResponsePackage用完后必须手动关闭!!!

抛出:

NoHostException - 当前没有可发送的后端(网络请求发送前的异常, 准备阶段异常)

RequestBuildException - 请求初始化异常(通常是网络请求发送前的异常, 准备阶段异常)

java.io.IOException - 网络通讯异常(通常是网络请求发送中的异常)

HttpRejectException - Http请求拒绝异常(网络请求发送后的异常, HTTP响应码不为2XX)

enqueue

public MultiHostOkHttpClient.Stub enqueue(MultiHostOkHttpClient.BeanCallback<?> callback)

[请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常
注意: 必须配置DataConverter, 否则发送时会报错

参数:

callback - 回调函数MultiHostOkHttpClient.BeanCallback

enqueue

public MultiHostOkHttpClient.Stub enqueue(MultiHostOkHttpClient.BytesCallback callback)

[请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常,

参数:

callback - 回调函数MultiHostOkHttpClient.BytesCallback

enqueue

public MultiHostOkHttpClient.Stub enqueue(MultiHostOkHttpClient.InputStreamCallback callback)

[请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常,

参数:

callback - 回调函数MultiHostOkHttpClient.InputStreamCallback

enqueue

public MultiHostOkHttpClient.Stub enqueue(MultiHostOkHttpClient.ResponsePackageCallback callback)

[请求发送]异步请求, 如果响应码不为2XX, 会回调onErrorAfterSend()方法给出HttpRejectException异常, 该方法不会根据maxReadLength限定最大读取长度

参数:

callback - 回调函数MultiHostOkHttpClient.BytesCallback/MultiHostOkHttpClient.InputStreamCallback/MultiHostOkHttpClient.ResponsePackageCallback

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object