javax.xml.ws.handler.soap
接口 SOAPMessageContext

所有超级接口：

Map<String,Object>, MessageContext

public interface SOAPMessageContext
extends MessageContext

接口 SOAPMessageContext 提供对 RPC 请求或响应的 SOAP 消息的访问。javax.xml.soap.SOAPMessage 为带有附件的 SOAP 1.1 消息表示形式指定标准的 Java API。

从以下版本开始：

JAX-WS 2.0

另请参见：

SOAPMessage

嵌套类摘要

从接口 javax.xml.ws.handler.MessageContext 继承的嵌套类/接口

MessageContext.Scope

从接口 java.util.Map 继承的嵌套类/接口

Map.Entry<K,V>

字段摘要

从接口 javax.xml.ws.handler.MessageContext 继承的字段

HTTP_REQUEST_HEADERS, HTTP_REQUEST_METHOD, HTTP_RESPONSE_CODE, HTTP_RESPONSE_HEADERS, INBOUND_MESSAGE_ATTACHMENTS, MESSAGE_OUTBOUND_PROPERTY, OUTBOUND_MESSAGE_ATTACHMENTS, PATH_INFO, QUERY_STRING, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE

方法摘要

Object[]	getHeaders(QName header, JAXBContext context, boolean allRoles) 从消息上下文的消息中获得具有特定限定名的头。
SOAPMessage	getMessage() 从此消息上下文中获取 SOAPMessage。
Set<String>	getRoles() 获取与执行处理程序链关联的 SOAP 参与者角色。
void	setMessage(SOAPMessage message) 在此消息上下文中设置 SOAPMessage。

从接口 javax.xml.ws.handler.MessageContext 继承的方法

getScope, setScope

从接口 java.util.Map 继承的方法

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

方法详细信息

getMessage

SOAPMessage getMessage()

从此消息上下文中获取 SOAPMessage。对返回的 SOAPMessage 所做的修改会原地更改消息，因此没有必要随后调用 setMessage。

返回：

返回 SOAPMessage；如果此消息上下文中没有 SOAPMessage，则返回 null。

setMessage

void setMessage(SOAPMessage message)

在此消息上下文中设置 SOAPMessage。

参数：

message - SOAP 消息

抛出：

WebServiceException - 如果在此消息上下文中设置 SOAPMessage 时发生任何错误

UnsupportedOperationException - 如果此操作不受支持

getHeaders

Object[] getHeaders(QName header,
                    JAXBContext context,
                    boolean allRoles)

从消息上下文的消息中获得具有特定限定名的头。注意，SOAP 消息可以包含具有相同限定名的多个头。

参数：

header - SOAP 头的 XML 限定名。

context - 应该用于解组头的 JAXBContext

allRoles - 如果该参数为 true，则返回所有 SOAP 角色的头；如果该参数为 false，则只返回以此 SOAP 节点当前正扮演的角色为目标的头，请参见 getRoles。

返回：

已解组的头的数组；如果此消息上下文中没有消息，或者没有与提供的限定名相匹配的头，则返回空数组。

抛出：

WebServiceException - 如果在使用提供的 JAXBContext 进行解组时发生错误。WebServiceException 的 cause 是初始 JAXBException。

getRoles

Set<String> getRoles()

获取与执行处理程序链关联的 SOAP 参与者角色。注意，SOAP 参与者角色适用于 SOAP 节点，并使用 SOAPBinding.setRoles 和 SOAPBinding.getRoles 进行管理。处理程序链中的处理程序实例使用有关 SOAP 参与者角色的信息来处理 SOAP 头块。注意，在通过处理程序链处理 SOAP 消息的过程中，SOAP 参与者角色是不变的。

返回：

SOAP 参与者角色的 String 数组