Module java.xml.ws

软件包 javax.xml.ws.handler.soap

Interface SOAPMessageContext

All Superinterfaces:

Map<String,Object> ， MessageContext

public interface SOAPMessageContext
extends MessageContext

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

从以下版本开始：

1.6，JAX-WS 2.0

另请参见：

SOAPMessage

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface javax.xml.ws.handler.MessageContext

MessageContext.Scope

Field Summary

Fields inherited from interface 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, REFERENCE_PARAMETERS, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE

方法摘要

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

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface javax.xml.ws.handler.MessageContext

getScope, setScope

方法详细信息

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是原来的JAXBException 。

getRoles

Set<String> getRoles()

获取与执行处理程序链相关联的SOAP actor角色。 请注意，SOAP actor角色适用于SOAP节点，并使用SOAPBinding.setRoles(java.util.Set<java.lang.String>)和SOAPBinding.getRoles()进行管理。 处理程序链中的Handler实例使用有关SOAP actor角色的此信息来处理SOAP标头块。 请注意，在通过处理程序链处理SOAP消息期间，SOAP actor角色是不变的。

结果

用于SOAP角色的 String数组