SOAPFAULT ADD

将信息添加到现有 SOAPFAULT 对象。只能在从 CICS®提供的 SOAP 消息处理程序调用的程序中使用此命令。

语法

SOAPFAULT ADD

条件: CHANNELERR ， INVREQ 和 LENGERR

此命令是线程安全的。

NOHANDLE、RESP 和 RESP2是常用选项，可添加到所有 EXEC CICS 命令中以处理错误条件。命令语法图和选项说明中没有明确包含这些选项。有关这些常用选项和 EXEC CICS 命令语法的信息，请参阅 EXEC CICS 命令格式和编程注意事项.

描述

此命令将信息添加到使用先前的 SOAPFAULT CREATE 命令创建的 SOAPfault 对象。可以添加的信息包括:

子代码
特定本地语言的故障字符串。如果故障已包含该语言的故障字符串，那么此命令将替换该语言的故障字符串。在 SOAP 1.1中，仅使用原始语言的故障字符串。

此命令需要在所提供 SOAP 消息处理程序的通道上的容器中保存的信息。要使用此命令，您必须具有对通道的访问权。只有以下类型的程序具有此访问权:

作为 SOAP 头处理程序调用的程序
直接从 CICS提供的 SOAP 消息处理程序调用的程序
使用具有通道接口的 CICS Web Service 助手部署的程序。具有 COMMAREA 接口的程序没有对通道的访问权。
正在使用全局用户出口来监视 Web Service 的程序。

此命令上的许多选项适用于 SOAP 1.1 和 SOAP 1.2 故障，尽管它们的行为对于每个 SOAP 级别都略有不同。其他选项适用于一个 SOAP 级别或另一个 SOAP 级别，但不适用于这两个级别，如果在消息使用其他级别的 SOAP 时指定其中任何选项，那么该命令会产生 INVREQ 条件。为了帮助您确定适用于消息的 SOAP 级别，容器 DFHWS-SOAPLEVEL 包含具有下列其中一个值的二进制全字:

1: 请求或响应是 SOAP 1.1 消息。
2: 请求或响应是 SOAP 1.2 消息。
10: 请求或响应不是 SOAP 消息。

选项

SUBCODESTR(data-value)

指定要添加到 SOAPfault 对象的 <Subcode> 元素的内容。子代码的长度最多可以是 64 个字符，并且必须是 XML 限定名 (QName)。

对于 SOAP 1.1，将忽略此选项。
对于 SOAP 1.2，此选项提供 <Subcode> 元素的内容。

SUBCODELEN(data-value)

指定 SUBCODESTR 选项中指定的 <Subcode> 元素的长度 (作为全字二进制值)。

FAULTSTRING(data-value)

指定故障的人类可读解释。 FaulTSTRING 值的长度最多可以为 2056 个字符。

对于 SOAP 1.1，此选项提供 <faultstring> 元素的内容。
对于 SOAP 1.2，此选项提供 <Reason> 元素的内容。

FAULTSTRLEN(data-value)

以全字二进制值的形式指定 fault TSTRING 选项的长度。

FROMCCSID(data-value)

指定要放入 SOAP 故障中的字符数据的当前编码字符集标识 (CCSID) 作为全字二进制数。如果未指定此选项，那么 CICS 将使用 LOCALCCSID 系统初始化参数中指定的值。有关 CCSID 的更多信息以及 CICS支持的 CCSID 列表，请参阅 CICS支持的转换。

NATLANG(data-value)

指定包含用于 FAULTSTRING的本地语言的 8 字符字段。该语言是使用 XML 1.0 语言标识指定的。缺省值为 'en' (英语)。

当语言标识短于 8 个字符时，必须在右边填充 FROMCCSID 选项 (或 CICS LOCALCCSID) 中指定的字符集中的空格字符。例如，如果使用 FROMCCSID (1208) 指定 UTF-8 字符集，那么必须使用 X'20' 字符填充 NATLANG 值。

此选项仅用于 SOAP 1.2 故障。

条件

122 CHANNELERR

RESP2 值有：

3: 要添加此 SOAPfault 对象的通道是只读的。

16 INVREQ

RESP2 值有：

3: 该命令是在 CICS提供的 SOAP 处理程序的环境外部发出的。
7: 不存在 SOAP 故障
11: 子代码无效

22 LENGERR

RESP2 值有：

6: Fault TSTRLEN 值无效
10: SUBCODELEN 值无效