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, REFERENCE_PARAMETERS, 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 actorロールを取得します。
void	setMessage(SOAPMessage message) このメッセージ・コンテキストにSOAPMessageを設定します

インタフェース javax.xml.ws.handler.MessageContextから継承されたメソッド

getScope, setScope

インタフェース java.util.Mapから継承されたメソッド

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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の原因は、元の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 actorロールのString配列