パッケージ jakarta.jws
アノテーション型 WebParam
@RetentionSE(RUNTIMESE) @TargetSE(PARAMETERSE) public @interface WebParam
個々のパラメーターの Web サービスメッセージ部分および XML 要素へのマッピングをカスタマイズします。- 導入:
- 1.6
オプション要素のサマリー
オプション要素 修飾子と型 オプションの要素 説明 boolean
header
true の場合、パラメーターはメッセージ本文ではなくメッセージヘッダーから取得されます。WebParam.Mode
mode
パラメーターが流れる方向 (IN、OUT、INOUT のいずれか)。StringSE
name
パラメーターの名前。StringSE
partName
このパラメーターを表すwsdl:part
の名前。StringSE
targetNamespace
パラメーターの XML 名前空間。
要素の詳細
name
StringSE name
パラメーターの名前。操作が rpc スタイルで @WebParam.partName が指定されていない場合、これはパラメーターを表す wsdl:part の名前です。
操作がドキュメントスタイルの場合、またはパラメーターがヘッダーにマップされている場合、これはパラメーターを表す XML 要素のローカル名です。操作がドキュメントスタイルで、パラメータースタイルが BARE で、モードが OUT または INOUT の場合、名前を指定する必要があります。
- 戻り値:
- パラメーターの名前
- デフォルト:
- ""
partName
StringSE partName
このパラメーターを表すwsdl:part
の名前。これは、操作が rpc スタイルの場合、または操作がドキュメントスタイルでパラメータースタイルが BARE の場合にのみ使用されます。
- 戻り値:
wsdl:part
の名前- 導入:
- 2.0
- デフォルト:
- ""
targetNamespace
StringSE targetNamespace
パラメーターの XML 名前空間。操作がドキュメントスタイルであるか、パラメーターがヘッダーにマップされている場合にのみ使用されます。ターゲット名前空間が "" に設定されている場合、これは空の名前空間を表します。
- 戻り値:
- パラメーターの XML 名前空間
- デフォルト:
- ""
mode
WebParam.Mode mode
パラメーターが流れる方向 (IN、OUT、INOUT のいずれか)。OUT モードと INOUT モードは、Holder 型 (Jakarta XML Web Services Specification [5]、セクション 2.3.3) の定義に準拠するパラメーター型にのみ指定できます。ホルダー型であるパラメーターは、OUT または INOUT である必要があります。
- 戻り値:
- パラメーターの流れ方向
- デフォルト:
- jakarta.jws.WebParam.Mode.IN