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, 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 の原因は、元の 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 配列