简介
HTTP相关的核心类型,主要服务于基于HTTP协议的连接器节点。类型主要为:HttpRequest、HttpRespoonse、HttpHeader、HttpCookie等类型。
HttpRequest
简介
引擎用来描述发送HTTP Request请求时的数据结构。
基于HTTP协议的连接器节点(例如HTTP节点),访问对端系统时,引擎会根据节点的配置内容自动生成此种类型的对象。
集成流的触发节点(例如HTTP API Listener节点)的输出消息Payload中,会生成该类型对象,供后续节点使用。
坐标:com.alibaba.bwif.script.core.protocol.http.HttpRequest
构造方式
只能由集成流引擎构造,不支持在脚本中构造。
方法列表
方法 | 说明 |
String getPath() | 获取整个请求路径,不包含Domain、协议和query部分,例如http://abc.com/a/b/c?q1=1,则此方法返回/a/b/c。 |
String getHttpMethod() | 获取请求的 HttpMethod,例如GET、POST等。 |
Entity getBody() | 获取请求Body对象,Body 对象为 Entity 类型。会根据HTTP Request请求中的content-type做为Entity的MIME Type。 |
String getParam(String key) | 根据key获取指定的参数的值,如果有重复key,则默认取出第一个。支持对Path参数、Query参数。 |
List getHeaders() | 获取所有Headers信息,返回结构为com.alibaba.bwif.script.core.protocol.http.HttpHeader, 详见HttpHeader。 |
String getHeader(String key) | 获取指定key的value,如果header中存在重复的key,则默认取出第一个返回。value会统一转换成String类型,例如header['Content-Length']=2,获得到的结果为"2"。 |
String getPathParam(String key) | 根据key获取指定的参数的值,值的类型统一为String。如果有重复的key,则取一个返回。 |
Map getPathParamMap() | 按照Path参数key、value结构组成Map,value类型为String。如果有重复值,默认只取一个返回。 |
String getQueryString() | 获取整个QueryString,例如q1=v1&q2=v2。 |
String getQueryParam(String key) | 按照key获取值,默认取第一个。 |
HttpResponse
简介
引擎用来描述返回HTTP Response时的数据结构。
基于HTTP协议的连接器节点(例如HTTP节点),访问对端系统时,引擎会根据对端的HTTP Response内容自动生成此种类型的对象,供后续节点使用。
集成流的最后一个节点(例如HTTP API Reply节点),会根据集成流中的节点配置,生成HTTP Response内容,返回给集成流的请求方。
坐标:com.alibaba.bwif.script.core.protocol.http.HttpResponse。
构造方式
只能由集成流引擎构造,不支持在脚本中构造。
方法列表
方法 | 说明 |
Entity getBody() | 获取对端接口返回的HTTP Response Body内容,类型为Entity。MIME Type根据HTTP Response的content type决定。 |
long getBodyLength() | 获取对端接口返回的HTTP Response的Content-Length。 |
int getStatusCode() | 获取对端接口返回的HTTP Status Code,例如200、404等。 |
List getHeaders() | 获取对端接口返回的HTTP Response 的Header全部信息,返回类型为 List<HttpHeader>,类型为 com.alibaba.bwif.script.core.protocol.http.HttpHeader,详情请参见HttpHeader。 Header中如果包含Cookie信息,则仍然按照header类型返回。 |
List getCookies() | 获取对端接口返回的HTTP Response 的Header中的Cookies全部信息,返回类型为 List<HttpCookie>,类型为 com.alibaba.bwif.script.core.protocol.http.HttpCookie,详情请参见HttpCookie。 |
HttpHeader
简介
配合HttpRequest、HttpResponse类使用,用于描述一个header的key、value结构。
坐标:com.alibaba.bwif.script.core.protocol.http.HttpHeader。
构造方式
引擎自动构建,脚本中不提供构造方法。
方法列表
方法 | 说明 |
String getKey() | 返回header的key。 |
String getValue() | 返回header的value,String类型。例如header中的Content-Length=2,也会转换成String。 |
HttpCookie
简介
配合HttpRequest、HttpResponse类使用,用于描述Cookie结构。
坐标:com.alibaba.bwif.script.core.protocol.http.HttpCookie。
构造方式
引擎自动构建,脚本中不提供构造方法。
方法列表
方法 | 说明 |
String getName() | 返回Cookie的Name。 |
String getValue() | 返回Cookie的Value,类型为String。 |
- 本页导读 (1)