SOAPFAULT CREATE

创建作为对 Web Service 请求的响应返回的 SOAP 故障响应消息。未处理 Web Service 应用程序响应。

语法

SOAPFAULT CREATE

条件: CCSIDERR ， CHANNELERR ， INVREQ 和 ENGERR

此命令是线程安全的。

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

描述

SOAPFAULT CREATE 创建 SOAP 故障。如果消息处理程序正在处理的 SOAP 消息的上下文中已存在 SOAP 故障，那么将覆盖现有故障。此命令只能在从提供的 SOAP 处理程序连接的程序中使用。在 CICS® 的 Java™ 管道中托管的 Axis2 应用程序无法使用此命令。

此命令需要在所提供 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 消息。

选项

DETAIL(data-value)

指定以下内容:

对于 SOAP 1.1，此选项提供 SOAP 故障的 <detail> 元素的内容。
对于 SOAP 1.2，此选项提供 SOAP 故障的 <Detail> 元素的内容。

它应包含一个或多个有效的名称空间限定 XML 元素或空格。请参阅相应的 SOAP 规范，以获取元素的有效内容的完整描述。

该元素包含与 <Body> 元素相关的特定于应用程序的错误信息，并且在无法成功处理 <Body> 元素的内容时使用。对于 SOAP 1.1，如果无法成功处理 <Body> 元素的内容，那么 <detail> 元素必须存在; 对于 SOAP 1.2， <Detail> 元素是可选元素。

如果在头处理程序中发出 SOAPFAULT CREATE 命令，那么将在 SOAP 1.1的头块中携带详细信息内容。对于 SOAP 1.2 ， <Detail> 元素在 SOAP 故障中携带。

DETAILLENGTH(data-value)

指定 DETAIL 选项的长度 (作为全字二进制值)。

FAULTACTLEN(data-value)

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

FAULTACTOR(data-value)

指定以下内容:

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

fault TACTOR 选项的长度最多可以是 2056 个字符，并且必须是有效的 URI (anyURI)。

FAULTCODE(cvda)

CVDA 值如下：

CLIENT: 对于 SOAP 1.1，应指定 CVDA 值 Client 。但是，如果对 SOAP 1.1 故障响应消息指定 Sender ，那么 CICS 将使用 CVDA 值 Client。
发件人: 对于 SOAP 1.2，应指定 CVDA 值 Sender 。但是，如果对 SOAP 1.2 故障响应消息指定 Client ，那么 CICS 将使用 CVDA 值 Sender。
SERVER: 对于 SOAP 1.1，应指定 CVDA 值 Server 。但是，如果对 SOAP 1.1 故障响应消息指定 Receiver ，那么 CICS 将使用 CVDA 值 Server。
Receiver: 对于 SOAP 1.2，应指定 CVDA 值 Receiver 。但是，如果对 SOAP 1.2 故障响应消息指定 Server ，那么 CICS 将使用 CVDA 值 Receiver。

FAULTCODELEN(data-value)

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

FAULTCODESTR(data-value)

为 SOAP 1.1 消息指定用户定义的 SOAP 故障代码。故障代码的长度最多可以是 64 个字符，并且必须是 XML 限定名 (QName)。不支持使用点 (.) 字符来分隔故障代码值。对于 SOAP 1.1，此选项提供 <faultcode> 元素的内容。

如果为 SOAP 1.2 消息设置此选项，那么将发生 INVREQ 条件。

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 故障。

ROLE(data-value)

指定用于描述生成故障的 SOAP 节点的角色的 URI。 ROLE 选项的长度最多可以是 2056 个字符，并且必须是有效的 URI (XML 类型 anyURI)。

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

ROLELENGTH(data-value)

指定 ROLE 选项的长度 (作为全字二进制值)。

条件

123 CCSIDERR

RESP2 值有：

13: 指定了无效的 CCSID。
14: 指定了不受支持的 CCSID。

122 CHANNELERR

RESP2 值有：

3: 创建此 SOAPfault 对象的通道是只读的。

16 INVREQ

RESP2 值有：

3: 该命令是在 CICS提供的 SOAP 处理程序的环境外部发出的。
11: 指定的 fault TCODE 无效，或者为 SOAP 1.2故障指定了 fault TCODESTR 。
13: DETAIL 选项不包含有效的名称空间限定的 XML 或空格。

22 LENGERR

RESP2 值有：

5: fault TCODELEN 值无效
6: fault TSTRLEN 值无效
7: ROLEL定为值无效
8: fault TACTLEN 值无效
9: DETAILLENGTH 值无效