SoapClient (hutool 5.8.36 API)

java.lang.Object
- cn.hutool.http.HttpBase<SoapClient>
- - cn.hutool.http.webservice.SoapClient

public class SoapClient
extends HttpBase<SoapClient>

SOAP客户端

此对象用于构建一个SOAP消息，并通过HTTP接口发出消息内容。 SOAP消息本质上是一个XML文本，可以通过调用getMsgStr(boolean) 方法获取消息体

使用方法：

 SoapClient client = SoapClient.create(url)
 .setMethod(methodName, namespaceURI)
 .setCharset(CharsetUtil.CHARSET_GBK)
 .setParam(param1, "XXX");

 String response = client.send(true);

Since:: 4.5.4
Author:: looly

Field Summary
- Fields inherited from class cn.hutool.http.HttpBase
  body, charset, DEFAULT_CHARSET, headers, HTTP_1_0, HTTP_1_1, httpVersion

Constructor Summary

Constructors
Constructor and Description
`SoapClient(String url)` 构造，默认使用soap1.1版本协议
`SoapClient(String url, SoapProtocol protocol)` 构造
`SoapClient(String url, SoapProtocol protocol, String namespaceURI)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SOAPHeaderElement`	`addSOAPHeader(QName name)` 增加SOAP头信息，方法返回`SOAPHeaderElement`可以设置具体属性和子节点
`SOAPHeaderElement`	`addSOAPHeader(QName name, String actorURI, String roleUri, Boolean mustUnderstand, Boolean relay)` 增加SOAP头信息，方法返回`SOAPHeaderElement`可以设置具体属性和子节点
`SOAPHeaderElement`	`addSOAPHeader(String localName)` 增加SOAP头信息，方法返回`SOAPHeaderElement`可以设置具体属性和子节点
`SOAPHeaderElement`	`addSOAPHeader(String localName, String value)` 增加SOAP头信息，方法返回`SOAPHeaderElement`可以设置具体属性和子节点
`SoapClient`	`charset(Charset charset)` 设置字符集
`static SoapClient`	`create(String url)` 创建SOAP客户端，默认使用soap1.1版本协议
`static SoapClient`	`create(String url, SoapProtocol protocol)` 创建SOAP客户端
`static SoapClient`	`create(String url, SoapProtocol protocol, String namespaceURI)` 创建SOAP客户端
`SOAPMessage`	`getMessage()` 获取SOAP消息对象 `SOAPMessage`
`SOAPBodyElement`	`getMethodEle()` 获取方法节点用于创建子节点等操作
`String`	`getMsgStr(boolean pretty)` 获取SOAP请求消息
`SoapClient`	`init(SoapProtocol protocol)` 初始化
`SoapClient`	`reset()` 重置SOAP客户端，用于客户端复用重置后需调用serMethod方法重新指定请求方法，并调用setParam方法重新定义参数
`String`	`send()` 执行Webservice请求，即发送SOAP内容
`String`	`send(boolean pretty)` 执行Webservice请求，即发送SOAP内容
`SOAPMessage`	`sendForMessage()` 执行Webservice请求，即发送SOAP内容
`HttpResponse`	`sendForResponse()` 发送请求，获取异步响应
`SoapClient`	`setCharset(Charset charset)` 设置编码
`SoapClient`	`setConnectionTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`SoapClient`	`setMethod(Name name, Map<String,Object> params, boolean useMethodPrefix)` 设置请求方法
`SoapClient`	`setMethod(QName name)` 设置请求方法
`SoapClient`	`setMethod(QName name, Map<String,Object> params, boolean useMethodPrefix)` 设置请求方法
`SoapClient`	`setMethod(String methodName)` 设置请求方法方法名自动识别前缀，前缀和方法名使用“:”分隔当识别到前缀后，自动添加xmlns属性，关联到默认的namespaceURI
`SoapClient`	`setMethod(String methodName, String namespaceURI)` 设置请求方法方法名自动识别前缀，前缀和方法名使用“:”分隔当识别到前缀后，自动添加xmlns属性，关联到传入的namespaceURI
`SoapClient`	`setParam(String name, Object value)` 设置方法参数，使用方法的前缀
`SoapClient`	`setParam(String name, Object value, boolean useMethodPrefix)` 设置方法参数
`SoapClient`	`setParams(Map<String,Object> params)` 批量设置参数，使用方法的前缀
`SoapClient`	`setParams(Map<String,Object> params, boolean useMethodPrefix)` 批量设置参数
`SoapClient`	`setReadTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`SoapClient`	`setUrl(String url)` 设置Webservice请求地址
`SoapClient`	`timeout(int milliseconds)` 设置超时，单位：毫秒超时包括： 1.
`SoapClient`	`write(OutputStream out)` 将SOAP消息的XML内容输出到流

Methods inherited from class cn.hutool.http.HttpBase
addHeaders, bodyBytes, charset, charset, clearHeaders, header, header, header, header, header, header, header, header, headerList, headerMap, headers, httpVersion, httpVersion, removeHeader, removeHeader, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SoapClient
```
public SoapClient(String url)
```
    构造，默认使用soap1.1版本协议
    
    Parameters:
    
    url - WS的URL地址
  - SoapClient
```
public SoapClient(String url,
                  SoapProtocol protocol)
```
    构造
    
    Parameters:
    
    url - WS的URL地址
    
    protocol - 协议版本，见SoapProtocol
  - SoapClient
```
public SoapClient(String url,
                  SoapProtocol protocol,
                  String namespaceURI)
```
    构造
    
    Parameters:
    
    url - WS的URL地址
    
    protocol - 协议版本，见SoapProtocol
    
    namespaceURI - 方法上的命名空间URI
    
    Since:
    
    4.5.6
- Method Detail
  - create
```
public static SoapClient create(String url)
```
    创建SOAP客户端，默认使用soap1.1版本协议
    
    Parameters:
    
    url - WS的URL地址
    
    Returns:
    
    this
  - create
```
public static SoapClient create(String url,
                                SoapProtocol protocol)
```
    创建SOAP客户端
    
    Parameters:
    
    url - WS的URL地址
    
    protocol - 协议，见SoapProtocol
    
    Returns:
    
    this
  - create
```
public static SoapClient create(String url,
                                SoapProtocol protocol,
                                String namespaceURI)
```
    创建SOAP客户端
    
    Parameters:
    
    url - WS的URL地址
    
    protocol - 协议，见SoapProtocol
    
    namespaceURI - 方法上的命名空间URI
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - init
```
public SoapClient init(SoapProtocol protocol)
```
    初始化
    
    Parameters:
    
    protocol - 协议版本枚举，见SoapProtocol
    
    Returns:
    
    this
  - reset
```
public SoapClient reset()
```
    重置SOAP客户端，用于客户端复用
    重置后需调用serMethod方法重新指定请求方法，并调用setParam方法重新定义参数
    
    Returns:
    
    this
    
    Since:
    
    4.6.7
  - setCharset
```
public SoapClient setCharset(Charset charset)
```
    设置编码
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
    
    See Also:
    
    charset(Charset)
  - charset
```
public SoapClient charset(Charset charset)
```
    Description copied from class: HttpBase
    
    设置字符集
    
    Overrides:
    
    charset in class HttpBase<SoapClient>
    
    Parameters:
    
    charset - 字符集
    
    Returns:
    
    T 自己
    
    See Also:
    
    CharsetUtil
  - setUrl
```
public SoapClient setUrl(String url)
```
    设置Webservice请求地址
    
    Parameters:
    
    url - Webservice请求地址
    
    Returns:
    
    this
  - addSOAPHeader
```
public SOAPHeaderElement addSOAPHeader(QName name,
                                       String actorURI,
                                       String roleUri,
                                       Boolean mustUnderstand,
                                       Boolean relay)
```
    增加SOAP头信息，方法返回SOAPHeaderElement可以设置具体属性和子节点
    
    Parameters:
    
    name - 头信息标签名
    
    actorURI - 中间的消息接收者
    
    roleUri - Role的URI
    
    mustUnderstand - 标题项对于要对其进行处理的接收者来说是强制的还是可选的
    
    relay - relay属性
    
    Returns:
    
    SOAPHeaderElement
    
    Since:
    
    5.4.4
  - addSOAPHeader
```
public SOAPHeaderElement addSOAPHeader(String localName)
```
    增加SOAP头信息，方法返回SOAPHeaderElement可以设置具体属性和子节点
    
    Parameters:
    
    localName - 头节点名称
    
    Returns:
    
    SOAPHeaderElement
    
    Since:
    
    5.4.7
  - addSOAPHeader
```
public SOAPHeaderElement addSOAPHeader(String localName,
                                       String value)
```
    增加SOAP头信息，方法返回SOAPHeaderElement可以设置具体属性和子节点
    
    Parameters:
    
    localName - 头节点名称
    
    value - 头节点的值
    
    Returns:
    
    SOAPHeaderElement
    
    Since:
    
    5.4.7
  - addSOAPHeader
```
public SOAPHeaderElement addSOAPHeader(QName name)
```
    增加SOAP头信息，方法返回SOAPHeaderElement可以设置具体属性和子节点
    
    Parameters:
    
    name - 头节点名称
    
    Returns:
    
    SOAPHeaderElement
    
    Since:
    
    5.4.4
  - setMethod
```
public SoapClient setMethod(Name name,
                            Map<String,Object> params,
                            boolean useMethodPrefix)
```
    设置请求方法
    
    Parameters:
    
    name - 方法名及其命名空间
    
    params - 参数
    
    useMethodPrefix - 是否使用方法的命名空间前缀
    
    Returns:
    
    this
  - setMethod
```
public SoapClient setMethod(QName name,
                            Map<String,Object> params,
                            boolean useMethodPrefix)
```
    设置请求方法
    
    Parameters:
    
    name - 方法名及其命名空间
    
    params - 参数
    
    useMethodPrefix - 是否使用方法的命名空间前缀
    
    Returns:
    
    this
  - setMethod
```
public SoapClient setMethod(String methodName)
```
    设置请求方法
    方法名自动识别前缀，前缀和方法名使用“:”分隔
    当识别到前缀后，自动添加xmlns属性，关联到默认的namespaceURI
    
    Parameters:
    
    methodName - 方法名
    
    Returns:
    
    this
  - setMethod
```
public SoapClient setMethod(String methodName,
                            String namespaceURI)
```
    设置请求方法
    方法名自动识别前缀，前缀和方法名使用“:”分隔
    当识别到前缀后，自动添加xmlns属性，关联到传入的namespaceURI
    
    Parameters:
    
    methodName - 方法名（可有前缀也可无）
    
    namespaceURI - 命名空间URI
    
    Returns:
    
    this
  - setMethod
```
public SoapClient setMethod(QName name)
```
    设置请求方法
    
    Parameters:
    
    name - 方法名及其命名空间
    
    Returns:
    
    this
  - setParam
```
public SoapClient setParam(String name,
                           Object value)
```
    设置方法参数，使用方法的前缀
    
    Parameters:
    
    name - 参数名
    
    value - 参数值，可以是字符串或Map或SOAPElement
    
    Returns:
    
    this
  - setParam
```
public SoapClient setParam(String name,
                           Object value,
                           boolean useMethodPrefix)
```
    设置方法参数
    
    Parameters:
    
    name - 参数名
    
    value - 参数值，可以是字符串或Map或SOAPElement
    
    useMethodPrefix - 是否使用方法的命名空间前缀
    
    Returns:
    
    this
  - setParams
```
public SoapClient setParams(Map<String,Object> params)
```
    批量设置参数，使用方法的前缀
    
    Parameters:
    
    params - 参数列表
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - setParams
```
public SoapClient setParams(Map<String,Object> params,
                            boolean useMethodPrefix)
```
    批量设置参数
    
    Parameters:
    
    params - 参数列表
    
    useMethodPrefix - 是否使用方法的命名空间前缀
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - getMethodEle
```
public SOAPBodyElement getMethodEle()
```
    获取方法节点
    用于创建子节点等操作
    
    Returns:
    
    SOAPBodyElement
    
    Since:
    
    4.5.6
  - getMessage
```
public SOAPMessage getMessage()
```
    获取SOAP消息对象 SOAPMessage
    
    Returns:
    
    SOAPMessage
    
    Since:
    
    4.5.6
  - getMsgStr
```
public String getMsgStr(boolean pretty)
```
    获取SOAP请求消息
    
    Parameters:
    
    pretty - 是否格式化
    
    Returns:
    
    消息字符串
  - write
```
public SoapClient write(OutputStream out)
```
    将SOAP消息的XML内容输出到流
    
    Parameters:
    
    out - 输出流
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - timeout
```
public SoapClient timeout(int milliseconds)
```
    设置超时，单位：毫秒
    超时包括：
```
 1. 连接超时
 2. 读取响应超时
 
```
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
    
    See Also:
    
    setConnectionTimeout(int), setReadTimeout(int)
  - setConnectionTimeout
```
public SoapClient setConnectionTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - setReadTimeout
```
public SoapClient setReadTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
    
    Since:
    
    4.5.6
  - sendForMessage
```
public SOAPMessage sendForMessage()
```
    执行Webservice请求，即发送SOAP内容
    
    Returns:
    
    返回结果
  - send
```
public String send()
```
    执行Webservice请求，即发送SOAP内容
    
    Returns:
    
    返回结果
  - send
```
public String send(boolean pretty)
```
    执行Webservice请求，即发送SOAP内容
    
    Parameters:
    
    pretty - 是否格式化
    
    Returns:
    
    返回结果
  - sendForResponse
```
public HttpResponse sendForResponse()
```
    发送请求，获取异步响应
    
    Returns:
    
    响应对象

Class SoapClient

Field Summary

Fields inherited from class cn.hutool.http.HttpBase

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.http.HttpBase

Methods inherited from class java.lang.Object

Constructor Detail

SoapClient

SoapClient

SoapClient

Method Detail

create

create

create

init

reset

setCharset

charset

setUrl

addSOAPHeader

addSOAPHeader

addSOAPHeader

addSOAPHeader

setMethod

setMethod

setMethod

setMethod

setMethod

setParam

setParam

setParams

setParams

getMethodEle

getMessage

getMsgStr

write

timeout

setConnectionTimeout

setReadTimeout

sendForMessage

send

send

sendForResponse