Cosminexus アプリケーションサーバ V8 Webサービス開発の手引

[目次][用語][索引][前へ][次へ]

13.2.1 アノテーション一覧

カスタマイズ時に使用できるアノテーション,および自動生成されるアノテーションを次の表に示します。各アノテーションについては,JAX-WS 2.1仕様を参照してください。

表13-11 カスタマイズ時に使用するアノテーションの一覧

項番 アノテーション 説明 定義の可否
アノテーション名 要素名
1 com.sun.xml.ws.developer.StreamingAttachment dir 受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディを一時ファイルとして出力する際に,一時ファイルを生成するディレクトリ名です。
parseEagerly 受信した添付ファイルを含むSOAPメッセージを詳細に解析するかどうかを設定します。
memoryThreshold 受信した添付ファイルを含むSOAPメッセージに含まれるMIMEボディをメモリ上に展開するかどうかを判定するためのしきい値です。
2 javax.jws.HandlerChain file ハンドラチェインファイルの場所を指すURLおよび相対パスです。
3 javax.jws.soap.SOAPBinding parameterStyle メソッドのパラメタのスタイル(Document wrappedまたはDocument Bareスタイル)です。
style メッセージのエンコードスタイルです。CosminexusのJAX-WS機能ではdocumentだけ指定できます。
use メッセージのフォーマットスタイルです。CosminexusのJAX-WS機能ではliteralだけ指定できます。
4 javax.jws.WebMethod action SOAPアクションを決定する文字列です。
exclude Webメソッドとして,公開の可否を指定します。
operationName メソッドに一致するwsdl:operation要素名です。
5 javax.jws.WebParam header メッセージのヘッダから,パラメタを取得するかどうかを表します。
mode パラメタの流れの方向(in,inout,およびout)です。
name パラメタを表すXML要素のローカル名です。
partName パラメタを表すwsdl:part要素名です。
targetNamespace XMLの名前空間名です。
6 javax.jws.WebResult header メッセージのヘッダから,戻り値を取得するかどうかを表します。
name 戻り値を表すXML要素のローカル名です。
partName 戻り値を表すwsdl:part要素名です。
targetNamespace XMLの名前空間名です。
7 javax.jws.WebService endpointInterface Webサービスの抽象Webサービス規約を定義する,SEIの完全修飾名です。
name Webサービス名を表すwsdl:portType要素名です。
portName Webサービスのポート名を表すwsdl:port要素名です。
serviceName Webサービスのサービス名を表すwsdl:service要素名です。
targetNamespace Webサービスの名前空間名です。
wsdlLocation WebサービスのWSDLを示すURLです。 ※1
8 javax.xml.bind.annotation.XmlMimeType value Java型に関連づけるMIMEタイプのテキストを表します。
9 javax.xml.ws.Action fault アドレッシング・ヘッダのwsa:Action要素の値です。Webサービスがフォルトメッセージを送信する場合に必要です。
input アドレッシング・ヘッダのwsa:Action要素の値です。Webサービスがリクエストメッセージを受信する場合に必要です。
output アドレッシング・ヘッダのwsa:Action要素の値です。Webサービスがレスポンスメッセージを送信する場合に必要です。
10 javax.xml.ws.BindingType value SEIを公開するときに使用するバインディングです。
11 javax.xml.ws.FaultAction className 例外クラス名です。
value アドレッシング・ヘッダのwsa:Action要素の値です。classNameに指定した例外クラス名に該当するフォルトメッセージを,Webサービスから送信する場合に必要です。
12 javax.xml.ws.RequestWrapper className リクエストbeanクラス名です。
localName 対象要素のローカル名です。
targetNamespace 対象要素の名前空間名です。
13 javax.xml.ws.ResponseWrapper className レスポンスbeanクラス名です。
localName 対象要素のローカル名です。
targetNamespace 対象要素の名前空間名です。
14 javax.xml.ws.ServiceMode value サービスモードです。
15 javax.xml.ws.soap.Addressing enabled アドレッシング機能を有効にするかどうかを設定します。
required Webサービスを呼び出す場合にアドレッシング・ヘッダを必須とするかどうかを設定します。
response エンドポイントが匿名のレスポンスまたは非匿名のレスポンスを必須とするかどうかを設定します。
16 javax.xml.ws.soap.MTOM enabled MTOM/XOP仕様形式の添付ファイルを使用するかどうかを設定します。
threshold バイナリデータをMTOM/XOP仕様形式の添付ファイルとして送信するためのしきい値を設定します。
17 javax.xml.ws.WebFault faultBean フォルトbeanクラス名です。
name 対象要素のローカル名です。
targetNamespace 対象要素の名前空間名です。
18 javax.xml.ws.WebServiceProvider targetNamespace Webサービスの名前空間名です。
portName Webサービスのポート名です。
serviceName Webサービスのサービス名です。
wsdlLocation WebサービスのWSDLを示すURLです。
19 javax.xml.ws.RespectBinding※1 enabled wsdl:binding要素の内容が有効かどうかを表します。 ※1
20 javax.xml.ws.WebEndpoint※2 name ポートのローカル名です。 ×※2
21 javax.xml.ws.WebServiceClient※2 name Webサービスのローカル名です。 ×※2
targetNamespace Webサービスの名前空間名です。 ×※2
wsdlLocation WebサービスのWSDLを示すURLです。 ×※2

注※1
指定した値は無視されます(警告メッセージは表示されません)。

注※2
WSDLから生成されたクラスに自動的に付与されるアノテーションになるため,指定できません。

JSR-181仕様およびJAX-WS 2.1仕様のアノテーションのうち,次の表に示すアノテーションは指定できません。指定した場合,動作は保証されません。

表13-12 サポート外のアノテーションの一覧

項番 アノテーション 備考
1 javax.xml.ws.WebServiceRef JSR109仕様に関連する機能はサポートしていません。
2 javax.xml.ws.WebServiceRefs JSR109仕様に関連する機能はサポートしていません。
3 javax.xml.ws.spi.WebServiceFeatureAnnotation このアノテーションを使用するためのAPI(フィーチャーをパラメタに取るメソッド)はサポートしていません。
4 javax.jws.Oneway one-wayパターンはサポートしていません。
5 javax.jws.soap.InitParam JSR181仕様で推奨していません(廃止対象)。
6 javax.jws.soap.SOAPMessageHandler JSR181仕様で推奨していません(廃止対象)。
7 javax.jws.soap.SOAPMessageHandlers JSR181仕様で推奨していません(廃止対象)。