Category  目次

Category APIは、Taxonomy APIを補完するAPIです。 Oracle Service Registryで内部分類の問合せおよび操作を行う場合に使用します。カテゴリは、階層的に編成できます。各カテゴリを最上位(親なし)にしたり、別のカテゴリの子にしたり、各カテゴリに子を含めることができます。レジストリ・コントロールで、この編成をドリルダウンできます。

データ構造  目次

Category APIでは、次の構造が使用されます。

Categories  目次

この構造は、0(ゼロ)個以上のcategory要素用のコンテナです。

category  目次

表22 属性

属性必須
disabledいいえ
leafいいえ

この要素には、カテゴリの値を定義するkeyedReference要素が1つ含まれています。

disabled属性は、カテゴリをkeyedReferencesの有効なオプションとして使用できないことを指定する場合に使用します。これは非推奨になっているか、または単なる他のカテゴリの親です。uddi-org:types分類のtModelキー値は、このような無効なカテゴリの1つです。

leaf属性は、カテゴリがカテゴリ・ツリー内のリーフであるかどうかを示します。

categoryList  目次

表23 属性

属性必須
truncatedいいえ

この構造は、オプションのlistDescriptionおよびカテゴリ構造用のコンテナとして機能します。truncated属性は、戻された分類のリストが切り捨てられるかどうかを示します。

操作  目次
add_category  目次

add_category APIコールは、keyedReferenceのtModelKeyによって識別される内部分類に新しいカテゴリを追加する場合に使用します。parentKeyedReference要素は、保存される新しいカテゴリの親カテゴリの定義する場合に使用します。parentKeyedReference要素がない場合、新しいカテゴリに親はありません。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • category:category: 追加されるカテゴリ。

  • parentKeyedReference: 新しいカテゴリの親として機能するオプションのkeyedReference。

パーミッション  目次

このAPIコールには、org.systinet.uddi.client.category.v3.CategoryApiおよびアクションadd_categoryに対するAPIマネージャ・パーミッションが必要です。

delete_category  目次

delete_category APIコールは、選択したカテゴリをOracle Service Registryから削除します。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • keyedReference: 削除されるカテゴリ。

パーミッション  目次

このAPIコールには、org.systinet.uddi.client.category.v3.CategoryApiおよびアクションdelete_categoryに対するAPIマネージャ・パーミッションが必要です。

find_category  目次

find_category APIコールは、指定した条件に一致したカテゴリのOracle Service Registryを問い合せる場合に使用します。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • category:findQualifiers: デフォルトの動作を変更するfindQualifiersのオプション・リスト。

  • uddi:keyedReference: 検索引数を含むカテゴリ。

動作  目次

FindByName findQualifierおよびfindByValue findQualifierは、コールの引数であるkeyedReferenceのkeyNameまたはkeyValueに基づいてコールによる検索が実行されるかどうかを指定する場合に使用します。デフォルトでは、値に基づいて検索が実行されます。

caseSensitiveMatch findQualifierおよびcaseInsensitiveMatch findQualifierは、検索で大/小文字が区別されるかどうかを制御する場合に使用します。デフォルトでは、大/小文字が区別されます。

ApproximateMatch findQualifierは、SQLワールドカードを使用して検索する場合に使用します。デフォルトのfindQualifierであるexactMatchを指定すると、検索で厳密な比較が実行されます。

最後に、カテゴリが戻される順番に影響を与えるfindQualifierには、次の4つがあります。

  • sortByNameAsc

  • sortByNameDesc

  • sortByValueAsc(デフォルト)

  • sortByValueDesc

これらの検索修飾子は排他的です。これらを組み合せると、例外が発生します。

戻り値  目次

このAPIコールは、成功時にCategoryListを戻します。

get_category  目次

get_category APIコールは、特定のkeyedReferenceによって識別されるカテゴリへのリレーションを持つカテゴリ(getQualifierによって識別)を取得する場合に使用します。getQualifierがchildCategoriesの場合は、このコールによって、その親として選択したカテゴリを持つカテゴリが戻されます。siblingCategories getQualifierを使用すると、選択したカテゴリと同じ親を持つカテゴリが戻されます。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • category:getQualifierおよびcategory:getQualifier: 検索動作を制御します。

  • uddi:keyedReference: 受信される関連カテゴリを持つカテゴリ。

戻り値  目次

このAPIは、成功時にCategoryListを戻します。

get_rootCategory  目次

get_rootCategory APIコールは、親を持っていない特定のtModelKeyによって識別される内部分類のすべてのカテゴリを戻します。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • uddi:tModelKey: 既存の分類tModelを表す必須のuddiKey値。

  • category:getQualifiers: 検索動作を制御します。

戻り値  目次

このAPIは、成功時にCategoryListを戻します。

get_rootPath  目次

get_rootPath APIコールは、ルート・カテゴリ、親の親、親、選択したカテゴリという順序で、ルート・カテゴリ、次にその子カテゴリ、最後に選択したカテゴリからカテゴリを戻します。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • uddi:keyedReference: 検索されるカテゴリ。

戻り値  目次

このAPIは、成功時にCategoryListを戻します。

move_category  目次

move_category APIコールは、選択したカテゴリを、現行の親カテゴリ(存在する場合)から新しい親カテゴリに移動する場合に使用します。newParentKeyedReferenceが定義されていない場合、そのカテゴリに親はありません。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • keyedReference: 削除されるカテゴリ。

  • newParentKeyedReference: カテゴリの新しい親となるオプションのカテゴリ。

パーミッション  目次

このAPIコールには、org.systinet.uddi.client.category.v3.CategoryApiおよびアクションmove_categoryに対するAPIマネージャ・パーミッションが必要です。

set_category  目次

set_category APIコールは、Oracle Service Registryで選択したカテゴリを更新する場合に使用します。

構文  目次
引数  目次
  • category:authInfo: このオプションの引数は、認証トークンを含む要素です。

  • oldKeyedReference: 更新される現行のカテゴリ。

  • category:category : 選択したカテゴリと置き換えられる新しいカテゴリ。

パーミッション  目次

このAPIコールには、org.systinet.uddi.client.category.v3.CategoryApiおよびアクションset_categoryに対するAPIマネージャ・パーミッションが必要です。

WSDL  目次

このAPIのWSDL仕様は、ファイルcategory.wsdlで確認できます。

APIエンドポイント  目次

Category APIエンドポイントは、http://<ホスト名>:<ポート>/<コンテキスト>/uddi/categoryで確認できます。

Java  目次

Java APIは、Category WSDLから生成されます。詳細は、「org.systinet.uddi.client.category.v3.CategoryApi」を参照してください。また、Categoryのデモを参照および試行することをお薦めします。