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 陣列