パッケージ jakarta.xml.ws
インターフェース LogicalMessage
public interface LogicalMessage
LogicalMessage
インターフェースは、プロトコルに依存しない XML メッセージを表し、メッセージのペイロードへのアクセスを提供するメソッドが含まれています。- 導入:
- 1.6、JAX-WS 2.0
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 SourceSE
getPayload()
メッセージペイロードを XML ソースとして取得し、同じ LogicalMessage インスタンスで複数回呼び出すことができ、メッセージペイロード全体を取得するために使用できる新しいSource
を常に返します。ObjectSE
getPayload(JAXBContext context)
メッセージペイロードを Jakarta XML Binding オブジェクトとして取得します。void
setPayload(ObjectSE payload, JAXBContext context)
メッセージペイロードを設定しますvoid
setPayload(SourceSE payload)
メッセージペイロードを設定します
メソッドの詳細
getPayload
SourceSE getPayload()
メッセージペイロードを XML ソースとして取得し、同じ LogicalMessage インスタンスで複数回呼び出すことができ、メッセージペイロード全体を取得するために使用できる新しいSource
を常に返します。返された
Source
がDOMSource
のインスタンスである場合、カプセル化された DOM ツリーを変更すると、メッセージペイロードがインプレースで変更されるため、setPayload
を頻繁に呼び出す必要はありません。他の型のSource
は、メッセージペイロードへの読み取りアクセスのみを提供します。- 戻り値:
- 含まれているメッセージペイロード。このメッセージにペイロードが存在しない場合は、
null
を返します。
setPayload
void setPayload(SourceSE payload)
メッセージペイロードを設定します- パラメーター:
payload
- メッセージペイロード- 例外:
WebServiceException
- このメッセージのペイロードの設定中にエラーが発生した場合UnsupportedOperationExceptionSE
- この操作がサポートされていない場合
getPayload
ObjectSE getPayload(JAXBContext context)
メッセージペイロードを Jakarta XML Binding オブジェクトとして取得します。返されたオブジェクトとメッセージペイロードの間に接続がないことに注意してください。ペイロードを変更するには、setPayload
を呼び出す必要があります。- パラメーター:
context
- メッセージペイロードのマーシャリングを解除するために使用する必要がある JAXBContext- 戻り値:
- 含まれているメッセージペイロード。このメッセージにペイロードが存在しない場合、
null
を返します - 例外:
WebServiceException
- 提供された JAXBContext を使用してペイロードをマーシャリング解除するときにエラーが発生した場合。WebServiceException の原因は、元の JAXBException です。
setPayload
void setPayload(ObjectSE payload, JAXBContext context)
メッセージペイロードを設定します- パラメーター:
payload
- メッセージペイロードcontext
- ペイロードをマーシャリングするために使用する必要がある JAXBContext- 例外:
UnsupportedOperationExceptionSE
- この操作がサポートされていない場合WebServiceException
- 提供された JAXBContext を使用してペイロードをマーシャリングするときにエラーが発生した場合。WebServiceException の原因は、元の JAXBException です。