Inquiry UI APIは、ビジネス・サービス・コントロールのパフォーマンスを向上させるために実装されています。基本的な概念は、単一のAPIコールを使用してビジネス・サービス・コントロールに表示されるデータを取得することです。
このAPIには、get_entityDetailという1つの操作のみが含まれています。その入力には、次の問合せ仕様および出力形式が含まれています。
問合せ仕様は、標準のUDDI v3 APIデータ構造(find_business、find_services、find_binding、find_tModel、get_businessDetail、get_serviceDetail、get_bindingDetailおよびget_tModelDetail)のいずれかで構成されています。
出力の形式では、戻されるデータ構造およびその構造をプルーニングする方法が定義されます。
get_entityDetail操作によって、UDDIデータ構造のリストが戻されます。ACLは、取得されたデータにも適用されます。
たとえば、次のような照会を指定するとします。
<get_entityDetail xmlns="http://systinet.com/uddi/inquiryUI/6.0"> <outputFormat> <businessEntityMask descriptionIncluded="true" identifierBagIncluded="true"/> <businessServiceMask descriptionIncluded="true"/> </outputFormat> <find_binding serviceKey="uddi:systinet.com:demo:hr:employeesList" xmlns="urn:uddi-org:api_v3"/> </get_entityDetail>
出力は次のようになります。
<entityDetail xmlns="http://systinet.com/uddi/inquiryUI/6.0"> <businessEntity businessKey="uddi:systinet.com:demo:hr" xmlns="urn:uddi-org:api_v3"> <name>HR</name> <description>HR department</description> <businessServices> <businessService serviceKey="uddi:systinet.com:demo:hr:employeesList" businessKey="uddi:systinet.com:demo:hr"> <name>EmployeeList</name> <description>wsdl:type representing service</description> </businessService> </businessServices> <identifierBag> <keyedReference tModelKey="uddi:systinet.com:demo:departmentID" keyName="department id" keyValue="002"/> </identifierBag> </businessEntity> </entityDetail>
一致するbindingTemplateにはアクセス可能で、関連するbusinessServiceには(ACLが原因で)アクセスできない場合、このようなbindingTemplateは、bindingTemplateの別のリストの結果に含まれます。アクセスできないbusinessEntityのアクセス可能なbusinessServiceにも同じ動作が適用されます。
Inquiry UI APIでは、次の構造が使用されます。
bindingTemplateMask構造では、outputFormatのバインディング・テンプレートのマスクが指定されます。オプションの属性によって、entityDetailに戻される要素が定義されます。
表45 属性
属性 | 必須 |
---|---|
discoveryURLIncluded | いいえ |
descriptionIncluded | いいえ |
identifierBagIncluded | いいえ |
categoryBagIncluded | いいえ |
SignatureIncluded | いいえ |
businessEntityMask構造では、outputFormatのビジネス・エンティティのマスクが指定されます。この構造には、contactMaskも含まれています。オプションの属性によって、entityDetailに戻される要素が定義されます。
businessServiceMask構造では、outputFormatのビジネス・サービスのマスクが指定されます。オプションの属性によって、entityDetailに戻される要素が定義されます。
contactMask構造では、outputFormatのビジネス・エンティティ・マスクのサブマスクが指定されます。オプションの属性によって、entityDetailに戻される要素が定義されます。
tModelInstanceInfoMask構造では、outputFormatのtModelインスタンス情報のマスクが指定されます。オプションの属性によって、entityDetailに戻される要素が定義されます。
tModelMask構造では、outputFormatのtModelのマスクが指定されます。オプションの属性によって、entityDetailに戻される要素が定義されます。
この操作は、Inquiry UI APIの中心的な操作です。
uddi:authInfo: このオプションの引数は、認証トークンを含む要素です。
uddi:get_businessDetail、uddi:get_bindingDetail、uddi:get_tModelDetail、uddi:find_business、uddi:find_service、uddi:find_binding、uddi:find_tModel: 標準のUDDI v3構造。
正常に完了すると、entityDetail構造が戻されます。
WSDL仕様は、ファイルinquiryUI.wsdlで確認できます。
Inquiry UI APIエンドポイントは、http://<ホスト名>:<ポート>/<コンテキスト>/uddi/inquiryUIで確認できます。
Java APIは、WSDLから直接生成されます。詳細は、「org.systinet.uddi.client.v3.ui.InquiryUIApi」を参照してください。