javax.jws

注釈型 WebParam

@Retention(value=RUNTIME)
@Target(value=PARAMETER)
public @interface WebParam

Web サービスのメッセージ部分と XML 要素に対する個別のパラメータのマッピングをカスタマイズします。

オプション要素のサマリー

省略可能な要素

修飾子と型	省略可能な要素と説明
boolean	header true の場合、パラメータはメッセージ本文からではなく、メッセージのヘッダーから取得されます。
WebParam.Mode	mode パラメータの流れの方向です (IN、OUT、INOUT のいずれか)。
String	name パラメータの名前です。
String	partName このパラメータを表す wsdl:part の名前です。
String	targetNamespace パラメータの XML 名前空間です。

要素の詳細

name

public abstract String name

パラメータの名前です。

操作が RPC スタイルの場合は、@WebParam.partName が指定されていないと、パラメータを表す wsdl:part の名前になります。
操作がドキュメントスタイルであるか、パラメータがヘッダーにマッピングされている場合、パラメータを表す XML 要素のローカル名になります。

操作がドキュメントスタイル、パラメータスタイルが BARE、およびモードが OUT または INOUT である場合は、必ず名前を指定してください。

デフォルト:

""

partName

public abstract String partName

このパラメータを表す wsdl:part の名前です。

これは、操作が RPC スタイルである場合、または操作がドキュメントスタイルでパラメータスタイルが BARE の場合にのみ使用されます。

導入されたバージョン:

2.0

デフォルト:

""

targetNamespace

public abstract String targetNamespace

パラメータの XML 名前空間です。

操作がドキュメントスタイルである場合、またはパラメータがヘッダーにマッピングされている場合にのみ使用されます。ターゲット名前空間が "" に設定されている場合は、空の名前空間を表します。

デフォルト:

""

mode

public abstract WebParam.Mode mode

パラメータの流れの方向です (IN、OUT、INOUT のいずれか)。

OUT モードと INOUT モードは、パラメータ型が Holder 型の定義に準拠している場合にのみ指定できます (JAX-WS 2.0[5]、セクション 2.3.3)。Holder 型のパラメータは必ず OUT または INOUT です。

デフォルト:

javax.jws.WebParam.Mode.IN

header

public abstract boolean header

true の場合、パラメータはメッセージ本文からではなく、メッセージのヘッダーから取得されます。

デフォルト:

false