AdminTask オブジェクトの WebServicesAdmin コマンド・グループ
Jython または Jacl スクリプト言語を使用すると、wsadmin ツールでセキュリティーを構成することができます。WebServicesAdmin グループのコマンドを使用して、すべての Web サービス、サービス参照、および属性のリスト、 特定 Web サービスの属性の検索、Web サービス・エンドポイントの判別、Web サービスのオペレーション名の判別を行います。
WebServicesAdmin グループ内のコマンドを使用して、インストールされた Web サービスの情報を照会します。 AdminTask オブジェクトについて詳しくは、AdminTask オブジェクトのコマンド情報を参照してください。
getWebService
getWebService は、Web サービスの属性を取得するコマンドです。このコマンドはエンタープライズ・アプリケーションにのみ適用されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -application
- デプロイ済みのエンタープライズ・アプリケーションの名前を指定します。(ストリング、必須)
- -module
- モジュールの名前を指定します。(ストリング、必須)
- -service
- Web サービスの名前を指定します。 (ストリング、必須)
オプション・パラメーター
- -client
- Web サービスがプロバイダーかクライアントかを指定します。 デフォルト値は false (サービス・プロバイダー) です。 true に設定すると、コマンドは Web サービス・クライアントのみを戻します。(ブール値、オプション)
戻り値
サービス名、そのサービスがプロバイダーまたはクライアントのいずれであるか、 およびサービス・タイプなどの属性のリストを戻します。 サービス・タイプ属性は、サービス・プロバイダーにのみ適用可能です。
バッチ・モードの使用例
AdminTask.getWebService('[–application application_name -module module_name -service webservice_name
-client false]')
'[[service {http://www.ibm.com}service1][type JAX-WS][client false]]'
対話モードの使用例
AdminTask.getWebService ('-interactive')
listServices
listServices コマンドは、サービス、エンドポイント、および操作の構成を照会します。 このコマンドは、このコマンド・グループ内の他のコマンドよりも汎用的な照会機能を提供します。これは、Java™ アプリケーション、および Web Services Notification (WSN) クライアントなどのその他の資産に適用できます。
ターゲット・オブジェクト
なし。
オプション・パラメーター
- -queryProps
- 該当するサービス・プロバイダーまたはクライアントの位置指定に使用されるプロパティーを指定します。例えば、[[type=JAX-WS][client=true]] と指定すると、このコマンドはエンタープライズ・アプリケーション内の各 JAX-WS クライアント参照を戻します。(プロパティー、オプション)-queryProps パラメーターは、いくつかのプロパティーを受け入れます。 1 つまたは複数のプロパティーを使用して照会基準を指定できます。 資産タイプの異なる照会プロパティーを混用しないようにしてください。 例えば、application と bus を指定すると、このコマンドはエラーを報告します。
- エンタープライズ・アプリケーションの照会を行うには、以下のプロパティーを指定し、-queryProps パラメーターを付加します。
表 1. エンタープライズ・アプリケーションの -queryProps パラメーターのプロパティー. これらのプロパティーを使用して、エンタープライズ・アプリケーションを照会します。 プロパティーと値 説明 assetType=J2EE Application 各 Java EE アプリケーションを照会します。 application=application_name 特定の Java EE アプリケーションを照会します。 module=module_name 特定の Java EE アプリケーション・モジュールを照会します。 アプリケーション・モジュールを照会するには、application プロパティーと module プロパティーを指定する必要があります。 - WSN クライアントの照会を行うには、以下のプロパティーを指定し、-queryProps パラメーターを付加します。
表 2. WSN クライアントを照会するためのプロパティー. これらのプロパティーを使用して、WSN クライアントを照会します。 プロパティーと値 説明 assetType=WSN Service 各 WSN サービス・クライアントを照会します。 bus=bus_name 特定のバスを照会します。 WSNService=WSN_service_name 特定の WSN サービスを照会します。 特定の WSN サービスを照会するには、bus プロパティーと WSNService プロパティーを指定する必要があります。 - すべての資産を照会するには、以下のプロパティーを指定し、-queryProps パラメーターを付加します。
表 3. すべての資産を照会する場合の -queryProps パラメーターのプロパティー. これらのプロパティーを使用して、すべての資産を照会します。 プロパティーと値 説明 serviceType=service_type サービス・タイプごとに照会します。 XML ベースの Web サービス資産の Java™ API を照会するには、JAX-WS を指定します。 Web Services Notification 資産を照会するには、JAX-WS (WSN) を指定します。 client=Boolean クライアントまたはプロバイダーを照会します。 クライアントを照会するには、true を指定します。 プロバイダーを照会するには、false を指定します。 service=service_name 特定サービスの論理エンドポイントおよび操作を照会します。 - client=true のとき、すべてのサービス参照または特定のサービス参照を照会するには、-queryProps パラメーターを使用して次のプロパティーを指定します。
表 4. サービス参照を照会する場合の -queryProps パラメーターのプロパティー. これらのプロパティーを使用して、サービス・クライアントのすべてのサービス参照を照会します。 プロパティーと値 説明 serviceRef=serviceref_name 特定のサービス参照を照会します。
アスタリスク (*) をワイルドカード文字として使用して、一致するサービス・クライアントのすべてのサービス参照を戻すように指定します。
- エンタープライズ・アプリケーションの照会を行うには、以下のプロパティーを指定し、-queryProps パラメーターを付加します。
- -expandResource
- サービス名のみを戻すか、サービスと詳細なリソース情報を戻すかを指定します。 logicalEndpoint または operation を指定します。 logicalEndpoint 値を指定すると、このコマンドは一致するサービス、およびそのサービス内の各エンドポイントを戻します。 operation 値を指定すると、このコマンドは一致するサービス、およびそれに対応するエンドポイントと操作を戻します。(ストリング、オプション)
- expandResource パラメーターを使用して、 サービス参照のエンドポイントと操作の詳細なリソース情報を戻すことができます。
戻り値
このコマンドは、各サービスのプロパティーのリストを戻します。また、エンドポイントおよび操作を照会する場合は、エンドポイントとオペレーションの詳細な情報も戻します。
バッチ・モードの使用例
[ [service {http://www.ibm.com}EchoService] [assetType [J2EE Application]]
[client false] [application MyWSApplication] [module ServicesModule.war] [serviceType JAX-WS] ]
[ [assetType [J2EE Application]] [service {http://www.ibm.com}EchoService]
[client false] [application MyWSApplication] [module ServicesModule.war] [serviceType JAX-WS]
[logicalEndpoint EchoServicePort] ]
[ [service {http://www.ibm.com}PingService] [assetType [J2EE Application]]
[client false] [application MyWSApplication] [module ServicesModule.war] [serviceType JAX-WS] ]
[ [assetType [J2EE Application]] [service {http://www.ibm.com}PingService]
[client false] [application MyWSApplication] [module ServicesModule.war] [serviceType JAX-WS]
[logicalEndpoint PingServicePort] ]
AdminTask.listServices('[-queryProps [[application MyWSApplication][client false]] -expandResource
logicalEndpoint]')
AdminTask.listServices(['–queryProps', '[[application myApplication][client false]]', '-expandResource',
'logicalEndpoint'])
次の例は、myBus バス下の各サービス・クライアントを照会します。 この例では -expandResource パラメーターが指定されていないため、各サービス・クライアントの論理エンドポイントまたはオペレーションは戻されません。
AdminTask.listServices('[–queryProps [[bus myBus][client true]] ]')
AdminTask.listServices(['–queryProps', '[[bus myBus][client true]]'])
次の例は、JaxWSServicesSamples アプリケーションの各サービス・クライアントで testRef という名前のサービス参照を照会します。 この例では、-expandResource パラメーターが指定されているため、各サービス参照の論理エンドポイントまたは操作に対する詳細なリソース情報が戻されます。
AdminTask.listServices('[-queryProps [[client true] [application JaxWSServicesSamples] [module SampleClientSei.war]
[serviceRef testRef] -expandResource logicalEndpoint]')
AdminTask.listServices(['-queryProps', '[[application JaxWSServicesSamples][client true][module SampleClientSei.war]
[serviceRef testRef]', '-expandResource', 'logicalEndpoint'])
'[ [serviceRef testRef] [service {http://www.ibm.com}TestService] [assetType [J2EE Application]] [client true]
[application JaxWSServicesSamples] [module SampleClientSei.war] [serviceType JAX-WS] ]
[ [serviceRef testRef] [module SampleClientSei.war] [serviceType JAX-WS] [client true] [service {http://www.ibm.com}TestService] [assetType [J2EE Application]] [logicalEndpoint portA] [application JaxWSServicesSamples] ]
[ [serviceRef testRef] [module SampleClientSei.war] [serviceType JAX-WS] [client true] [service {http://www.ibm.com/}TestService] [assetType [J2EE Application]] [logicalEndpoint portB] [application JaxWSServicesSamples] ]'
対話モードの使用例
AdminTask.listServices('-interactive')
listWebServices
listWebServices は、1 つまたはすべてのアプリケーションの使用可能な Web サービスのリストを取得するコマンドです。アプリケーション名が提供されていない場合、コマンドはすべての Web サービスをリストします。 このコマンドはエンタープライズ・アプリケーションにのみ適用されます。
ターゲット・オブジェクト
なし。
必須パラメーター
なし。
オプション・パラメーター
- -application
- デプロイ済みのエンタープライズ・アプリケーションの名前を指定します。このパラメーターを指定しない場合、コマンドはセル内のすべての Web サービスを戻します。 (ストリング、オプション)
- -client
- Web サービスがプロバイダーかクライアントかを指定します。 デフォルト値は false (サービス・プロバイダー) です。 true に設定すると、コマンドは Web サービス・クライアントのみを戻します。(ブール値、オプション)
戻り値
指定されたアプリケーションに対するすべての Web サービス。このコマンドは、各 Web サービスに対して、アプリケーション名、モジュール名、サービス名、 Web サービスがサービス・プロバイダーまたはクライアントのいずれであるか、およびサービス・タイプといった属性と、対応する値を戻します。サービス・タイプは、Web サービスがサービス・プロバイダーである場合にのみ指定されます。
バッチ・モードの使用例
AdminTask.listWebServices('[–application application1 -client false]')
AdminTask.listWebServices(['–application', 'application1', '-client', 'false'])
'[[service {http://www.ibm.com}service1][application application1][module webapp1.war][type JAX-WS][client false]]'
対話モードの使用例
AdminTask.listWebServices('-interactive')
listWebServiceEndpoints
listWebServiceEndpoints コマンドは、Web サービスの論理エンドポイントのリストを戻します。論理エンドポイント名は、Web サービス記述言語 (WSDL) 文書内のポート名です。 このコマンドはエンタープライズ・アプリケーションにのみ適用されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -application
- デプロイ済みのエンタープライズ・アプリケーションの名前を指定します。(ストリング、必須)
- -module
- モジュールの名前を指定します。(ストリング、必須)
- -service
- Web サービスの名前を指定します。 (ストリング、必須)
オプション・パラメーター
- -client
- Web サービスがプロバイダーかクライアントかを指定します。 デフォルト値は false (サービス・プロバイダー) です。 true に設定すると、コマンドは Web サービス・クライアントのみを戻します。(ブール値、オプション)
戻り値
指定された Web サービスの論理エンドポイント名を戻します。
バッチ・モードの使用例
AdminTask.listWebServiceEndpoints('[–application application_name -module module_name -service webservice_name -client false]')
AdminTask.listWebServiceEndpoints(['–application', 'application_name', '-module', 'module_name', '-service', 'webservice_name', '-client', 'false'])
'[[logicalEndpoint QuotePort01]]'
対話モードの使用例
AdminTask.listWebServiceEndpoints('-interactive')
listWebServiceOperations
listWebServiceOperations コマンドは、Web サービス・オペレーションのリストを戻します。このコマンドはエンタープライズ・アプリケーションにのみ適用されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -application
- デプロイ済みのエンタープライズ・アプリケーションの名前を指定します。(ストリング、必須)
- -module
- モジュールの名前を指定します。(ストリング、必須)
- -service
- Web サービスの名前を指定します。 (ストリング、必須)
- -logicalEndpoint
- Web サービス記述言語 (WSDL) 文書内のポート名。 (ストリング、必須)
オプション・パラメーター
- -client
- Web サービスがプロバイダーまたはクライアントのいずれであるかどうか。 デフォルト値は false (サービス・プロバイダー) です。 true に設定すると、コマンドは Web サービス・クライアントのみを戻します。(ブール値、オプション)
戻り値
指定された Web サービスのオペレーション名を戻します。
バッチ・モードの使用例
AdminTask.listWebServiceOperations('[–application application_name -module
module_name -service webservice_name -client false -logicalEndpoint endpoint_name]')
AdminTask.listWebServiceOperations(['–application', 'application_name', '-module', 'module_name', '-service', 'webservice_name', '-client', 'false', '-logicalEndpoint', 'endpoint_name'])
'[[operation ivt_app_op1][operation ivt_app_op2]]'
対話モードの使用例
AdminTask.listWebServiceOperations('-interactive')