Red Hat Training

A Red Hat training course is available for Red Hat Fuse

24.3.4.2. @WSDLDocumentation プロパティー

プロパティー説明

value

(必須) ドキュメントテキストを含む文字列。

placement

(オプション) WSDL ファイルのどこにこのドキュメントを表示するかを指定します。可能な配置値のリストについては、「WSDL コントラクトへの配置」 を参照してください。

faultClass

(任意) 配置が FAULT_MESSAGEPORT_TYPE_OPERATION_FAULT、または BINDING_OPERATION_FAULT に設定されている場合、このプロパティーも障害を表す Java クラスに設定する必要があります。

@WSDLDocumentationCollection annotation

@WSDLDocumentationCollection アノテーションは、org.apache.cxf.annotations.WSDLDocumentationCollection インターフェイスによって定義されます。SEI または SEI メソッドに配置できます。

この注釈は、単一の配置場所またはさまざまな配置場所に複数のドキュメント要素を挿入するために使用されます。

WSDL コントラクトへの配置

WSDL コントラクトでドキュメントが表示される場所を指定するには、タイプ WSDLDocumentation.Placementplacement プロパティーを指定します。プレースメントには、次のいずれかの値を指定できます。

  • WSDLDocumentation.Placement.BINDING
  • WSDLDocumentation.Placement.BINDING_OPERATION
  • WSDLDocumentation.Placement.BINDING_OPERATION_FAULT
  • WSDLDocumentation.Placement.BINDING_OPERATION_INPUT
  • WSDLDocumentation.Placement.BINDING_OPERATION_OUTPUT
  • WSDLDocumentation.Placement.DEFAULT
  • WSDLDocumentation.Placement.FAULT_MESSAGE
  • WSDLDocumentation.Placement.INPUT_MESSAGE
  • WSDLDocumentation.Placement.OUTPUT_MESSAGE
  • WSDLDocumentation.Placement.PORT_TYPE
  • WSDLDocumentation.Placement.PORT_TYPE_OPERATION
  • WSDLDocumentation.Placement.PORT_TYPE_OPERATION_FAULT
  • WSDLDocumentation.Placement.PORT_TYPE_OPERATION_INPUT
  • WSDLDocumentation.Placement.PORT_TYPE_OPERATION_OUTPUT
  • WSDLDocumentation.Placement.SERVICE
  • WSDLDocumentation.Placement.SERVICE_PORT
  • WSDLDocumentation.Placement.TOP
@WSDLDocumentation の例

「@WSDLDocumentation の使用」 に、@WSDLDocumentation アノテーションを SEI およびそのメソッドの 1 つに追加する方法を示します。