モジュール java.xml.ws

パッケージ javax.xml.ws

インタフェースLogicalMessage

public interface LogicalMessage

LogicalMessageインタフェースは、プロトコルにとらわれないXMLメッセージを表現し、メッセージのペイロードへのアクセスを提供するメソッドを含みます。

導入されたバージョン:

1.6, JAX-WS 2.0

メソッドのサマリー

修飾子と型	メソッド	説明
Source	getPayload()	XMLソースとしてメッセージのペイロードを取得します。同じLogicalMessageインスタンスに対して複数回呼び出されることもあり、メッセージ・ペイロード全体を取得するために使用できる新しいSourceを常に返します。
Object	getPayload(JAXBContext context)	JAXBオブジェクトとしてメッセージ・ペイロードを取得します。
void	setPayload(Object payload, JAXBContext context)	メッセージのペイロードを設定します
void	setPayload(Source payload)	メッセージのペイロードを設定します

メソッドの詳細

getPayload

Source getPayload()

XMLソースとしてメッセージのペイロードを取得します。同じLogicalMessageインスタンスに対して複数回呼び出されることもあり、メッセージ・ペイロード全体を取得するために使用できる新しいSourceを常に返します。

戻り値のSourceがDOMSourceインスタンスの場合、カプセル化されたDOMツリーを変更するとメッセージ・ペイロードがインプレースに変更され、あとでsetPayloadを呼び出す必要がありません。 ほかの型のSourceは、メッセージ・ペイロードへの読取りアクセスのみを提供します。

戻り値:

含まれているメッセージ・ペイロード。このメッセージにペイロードがない場合はnullを返す。

setPayload

void setPayload(Source payload)

メッセージのペイロードを設定します

パラメータ:

payload - メッセージのペイロード

例外:

WebServiceException - このメッセージのペイロードの設定中にエラーが発生した場合

UnsupportedOperationException - この操作がサポートされていない場合

getPayload

Object getPayload(JAXBContext context)

JAXBオブジェクトとしてメッセージ・ペイロードを取得します。 戻り値のオブジェクトとメッセージ・ペイロードの間に何の関係もない場合、ペイロードを変更するためにsetPayloadを呼び出す必要があります。

パラメータ:

context - メッセージ・ペイロードを非整列化するために使用するJAXBContext

戻り値:

含まれているメッセージ・ペイロード。このメッセージにペイロードがない場合はnullを返す

例外:

WebServiceException - ペイロードを非整列化するために提供されたJAXBContextの使用時にエラーが発生した場合。 WebServiceExceptionの原因は、元のJAXBException。

setPayload

void setPayload(Object payload,
                JAXBContext context)

メッセージのペイロードを設定します

パラメータ:

payload - メッセージのペイロード

context - ペイロードを整列化するために使用するJAXBContext

例外:

UnsupportedOperationException - この操作がサポートされていない場合

WebServiceException - ペイロードを整列化するために提供されたJAXBContextの使用時にエラーが発生した場合。 WebServiceExceptionの原因は、元のJAXBException。