インターフェース SOAPMessageContext
- すべてのスーパーインターフェース:
MapSE<StringSE,ObjectSE>
,MessageContext
public interface SOAPMessageContext extends MessageContext
インターフェースSOAPMessageContext
は、RPC リクエストまたはレスポンスの SOAP メッセージへのアクセスを提供します。jakarta.xml.soap.SOAPMessage
は、添付ファイル付きの SOAP 1.1 メッセージを表すための標準 Java API を指定します。- 導入:
- 1.6、JAX-WS 2.0
- 関連事項:
SOAPMessage
ネストされたクラスのサマリー
インターフェース java.util.MapSE から継承されたネストクラス / インターフェース
Map.EntrySE<KSE extends ObjectSE,VSE extends ObjectSE>
インターフェース jakarta.xml.ws.handler.MessageContext から継承されたネストクラス / インターフェース
MessageContext.Scope
フィールドサマリー
インターフェース jakarta.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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 ObjectSE[]
getHeaders(QNameSE header, JAXBContext context, boolean allRoles)
メッセージコンテキストのメッセージから特定の修飾名を持つヘッダーを取得します。SOAPMessage
getMessage()
このメッセージコンテキストからSOAPMessage
を取得します。SetSE<StringSE>
getRoles()
ハンドラーチェーンの実行に関連付けられた SOAP アクターロールを取得します。void
setMessage(SOAPMessage message)
このメッセージコンテキストに SOAPMessage を設定しますインターフェース java.util.MapSE から継承されたメソッド
clear, computeSE, computeIfAbsentSE, computeIfPresentSE, containsKeySE, containsValueSE, entrySet, equalsSE, forEachSE, getSE, getOrDefaultSE, hashCode, isEmpty, keySet, mergeSE, putSE, putAllSE, putIfAbsentSE, removeSE, removeSE, replaceSE, replaceSE, replaceAllSE, size, values
インターフェース jakarta.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
の設定中にエラーが発生した場合UnsupportedOperationExceptionSE
- この操作がサポートされていない場合
getHeaders
ObjectSE[] getHeaders(QNameSE header, JAXBContext context, boolean allRoles)
メッセージコンテキスト内のメッセージから特定の修飾名を持つヘッダーを取得します。SOAP メッセージには、同じ修飾名を持つ複数のヘッダーを含めることができることに注意してください。- パラメーター:
header
- SOAP ヘッダーの XML 修飾名。context
- ヘッダーのマーシャリングを解除するために使用する必要がある JAXBContextallRoles
-true
がすべての SOAP ロールのヘッダーを返す場合、false
がこの SOAP ノードによって現在再生されているロールをターゲットとするヘッダーのみを返す場合は、getRoles
を参照してください。- 戻り値:
- マーシャリングされていないヘッダーの配列。このメッセージコンテキストにメッセージが存在しない場合、または指定された修飾名に一致するヘッダーがない場合は、空の配列を返します。
- 例外:
WebServiceException
- 付属のJAXBContext
を使用してマーシャリングを解除するときにエラーが発生した場合。WebServiceException
の原因は、元のJAXBException
です。
getRoles
SetSE<StringSE> getRoles()
ハンドラーチェーンの実行に関連付けられた SOAP アクターロールを取得します。SOAP アクターのロールは SOAP ノードに適用され、SOAPBinding.setRoles(java.util.Set<java.lang.String>)
およびSOAPBinding.getRoles()
を使用して管理されることに注意してください。ハンドラーチェーンのHandler
インスタンスは、SOAP アクターロールに関するこの情報を使用して、SOAP ヘッダーブロックを処理します。ハンドラーチェーンを介した SOAP メッセージの処理中、SOAP アクターのロールは不変であることに注意してください。- 戻り値:
- SOAP アクターロールの
String
の配列