3.4. Web Services サブシステムの設定

JBossWS では、追加の設定データを事前定義し、エンドポイント実装に関連付けることができます。事前定義されたエンドポイント設定は、Jakarta XML Web Services クライアントと Jakarta XML Web Services エンドポイントの設定に使用できます。エンドポイント設定には、Jakarta XML Web Services ハンドラーおよびキー/バリュープロパティー宣言を含めることができます。この機能は、ハンドラーを Web サービスのエンドポイントに追加し、JBossWS および Apache CXF 内部を制御する key/value プロパティーを設定する便利な方法を提供します。

webservices サブシステムを使用すると、エンドポイント設定データの名前付きセットを定義できます。各エンドポイント設定にはサブシステム内で一意な名前を付ける必要があります。その後、org.jboss.ws.api.annotation.EndpointConfig アノテーションを使用して、デプロイされたアプリケーションの Jakarta XML Web Services 実装にエンドポイント設定を割り当てることができます。エンドポイント設定の割り当ての詳細は、Assigning a Configuration を参照してください。

デフォルトの JBoss EAP 設定には、事前定義されたエンドポイント設定があります。

エンドポイント設定の追加

管理 CLI を使用して新しいエンドポイント設定を追加できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config:add

エンドポイント設定の設定

管理 CLI を使用してエンドポイント設定の key/value プロパティー宣言を追加できます。

/subsystem=webservices/endpoint-config=Standard-Endpoint-Config/property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

これらのエンドポイント設定の handler chains および handlers を設定できます。

エンドポイント設定の削除

管理 CLI を使用してエンドポイント設定を削除できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config:remove

各エンドポイント設定は PRE または POST ハンドラーチェーンに関連付けることができます。各ハンドラーチェーンにはメッセージに対して追加の処理を実行するための Jakarta XML Web Services 準拠のハンドラーが含まれることがあります。アウトバウンドメッセージの場合、PRE ハンドラーチェーンハンドラーは、@HandlerChain アノテーションなどの標準の Jakarta XML Web Services の手段を使用してエンドポイントにアタッチされたハンドラーの前に実行されます。POST ハンドラーチェーンハンドラーは、通常のエンドポイントハンドラーの後に実行されます。受信メッセージには、逆が適用されます。

Endpoint --> PRE Handlers --> Endpoint Handlers --> POST Handlers --> ... --> Client

Client --> ... --> POST Handlers --> Endpoint Handlers --> PRE Handlers --> Endpoint

ハンドラーチェーンの追加

以下の管理 CLI コマンドを使用すると、POST ハンドラーチェーンをエンドポイント設定に追加できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain:add

以下の管理 CLI コマンドを使用すると、PRE ハンドラーチェーンをエンドポイント設定に追加できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/pre-handler-chain=my-pre-handler-chain:add

ハンドラーチェーンの設定

protocol-bindings 属性を使用して、ハンドラーチェーンの開始をトリガーするプロトコルを設定します。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain:write-attribute(name=protocol-bindings,value=##SOAP11_HTTP)

ハンドラーチェーンのハンドラーの設定に関する詳細は、ハンドラー のセクションを参照してください。

ハンドラーチェーンの削除

管理 CLI を使用してハンドラーチェーンを削除できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain:remove

Jakarta XML Web Services ハンドラーはハンドラーチェーンに追加され、ハンドラークラスの完全修飾名を指定します。エンドポイントがデプロイされると、参照デプロイメントごとにそのクラスのインスタンスが作成されます。org.jboss.as.webservices.server.integration モジュールのデプロイメントクラスローダーまたはクラスローダーのいずれかがハンドラークラスをロードできる必要があります。

利用可能な ハンドラーのリストは、HandlerJavadocs を参照してください。

ハンドラーの追加

以下の管理 CLI コマンドを使用するとハンドラーをハンドラーチェーンに追加できます。ハンドラーのクラス名を指定する必要があります。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain/handler=my-handler:add(class="com.arjuna.webservices11.wsarj.handler.InstanceIdentifierInHandler")

ハンドラーの設定

管理 CLI を使用してハンドラーのクラスを更新できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain/handler=my-handler:add(class="org.jboss.ws.common.invocation.RecordingServerHandler")

ハンドラーの削除

管理 CLI を使用してハンドラーを削除できます。

/subsystem=webservices/endpoint-config=My-Endpoint-Config/post-handler-chain=my-post-handler-chain/handler=my-handler:

WSDL コントラクトで公開されるエンドポイントの <soap:address> 要素の書き換えがサポートされます。この機能は、各エンドポイントのクライアントに公開されるサーバーアドレスを制御するのに役立ちます。

以下の表は、この機能に設定できる属性を表しています。

管理 CLI を使用してこれらの属性を更新できます。例を以下に示します。

/subsystem=webservices:write-attribute(name=wsdl-uri-scheme, value=https)

各 Web サービスエンドポイントは、エンドポイント実装を提供するデプロイメントで公開されます。各エンドポイントはデプロイメントリソースとしてクエリーできます。各 Web サービスのエンドポイントは、Web コンテキストと WSDL URL を指定します。管理 CLI または管理コンソールを使用してこのランタイム情報にアクセスできます。

以下の管理 CLI コマンドは、jaxws-samples-handlerchain.war デプロイメントからの TestService エンドポイントの詳細を表示します。

/deployment="jaxws-samples-handlerchain.war"/subsystem=webservices/endpoint="jaxws-samples-handlerchain:TestService":read-resource(include-runtime=true)
{
    "outcome" => "success",
    "result" => {
        "average-processing-time" => 23L,
        "class" => "org.jboss.test.ws.jaxws.samples.handlerchain.EndpointImpl",
        "context" => "jaxws-samples-handlerchain",
        "fault-count" => 0L,
        "max-processing-time" => 23L,
        "min-processing-time" => 23L,
        "name" => "TestService",
        "request-count" => 1L,
        "response-count" => 1L,
        "total-processing-time" => 23L,
        "type" => "JAXWS_JSE",
        "wsdl-url" => "http://localhost:8080/jaxws-samples-handlerchain?wsdl"
    }
}

/subsystem=webservices:write-attribute(name=statistics-enabled,value=true)

管理コンソールの Runtime タブから、Web サービスエンドポイントのランタイム情報を表示することもできます。そのためには、該当するサーバーを選択し、Webservices を選択してエンドポイントを選択します。