javax.xml.ws

インタフェース LogicalMessage

public interface LogicalMessage

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

導入されたバージョン:

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。