Group APIは、Oracle Service Registryでユーザー・グループの問合せおよび管理を行う場合に使用します。
Group APIでは、次の構造が使用されます。
この要素には、1つのユーザー・グループに関する次の情報が含まれています。
必須のname要素には、グループの名前が保持されます。
オプションのdescription要素は、グループおよびその使用方法の記述に使用します。
owner要素には、このグループを作成したユーザーのloginNameが含まれています。
privateGroup要素は、グループがパブリックか、プライベートかを示します。
external要素は、グループが外部(LDAP内など)に存在するかどうかを示します。
この構造は、オプションのlistDescription構造およびgroupInfos構造用のコンテナとして機能します。truncated属性は、groupInfosのリストが切り捨てられるかどうかを示します。
add_user APIコールは、ユーザー・グループにユーザーを追加する場合に使用します。
authInfo: このオプションの引数は、認証トークンを含む要素です。
groupName: ユーザーが追加されるグループ。
account:userInfos: グループに追加されるユーザー。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションadd_userに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。
find_user APIコールは、ユーザー・グループ内でユーザーを検索する場合に使用します。
authInfo: このオプションの引数は、認証トークンを含む要素です。
name: ユーザーのログイン名。
account:findQualifier: 修飾子を検索します。
groupName: ユーザーが検索されるグループ。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションfind_userに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。
正常に完了すると、UserList構造が戻されます。
find_group APIコールは、Oracle Service Registryでグループを検索する場合に使用します。
authInfo: このオプションの引数は、認証トークンを含む要素です。
group:findQualifier: デフォルト動作の変更に使用するfindQualifierの集合。
name: 必須の値には、検索されるグループの名前が含まれています。
次のfindQualifierは、コールの動作に影響を与えます。exactMatch findQualifierが指定されている場合は、グループ名の完全一致が必要となります。また、デフォルトのapproximateMatch findQualifierの場合は、SQLワイルド・カード問合せが有効になります。findPrivateGroups findQualifierはプライベート・グループ間の検索、findPublicGroups findQualifierはパブリック・グループ間の検索、findMyGroups findQualifierはこのコールを実行したユーザーが所有しているグループ間のみの検索を実行します。sortByNameAsc findQualifierおよびsortByNameDesc findQualifierは、データが戻される順序を制御します。
findQualifierが定義されていない場合は、デフォルトのfindQualifierセットにapproximateMatch、findPrivateGroups、findPublicGroups、sortByNameAscのfindQualifierが含まれます。
正常に完了すると、groupList構造が戻されます。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションfind_groupに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。
get_group APIコールは、Oracle Service Registryにある1つ以上のグループの詳細を取得する場合に使用します。
authInfo: このオプションの引数は、認証トークンを含む要素です。
name: 必須の値には、戻されるグループの名前が含まれています。
brief: この属性を設定すると、結果にグループのメンバーが含まれなくなります。この属性の設定は、何千ものメンバーが含まれている大きなグループで操作を行う場合に役に立ちます。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションget_groupに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。ユーザー・パーミッションは、ユーザー自身のグループを取得する場合に必要です。マネージャ・パーミッションは、他のユーザーのグループを取得する場合に必要です。
save_group APIコールは、グループの集合をOracle Service Registryに保存する場合に使用します。
authInfo: このオプションの引数は、認証トークンを含む要素です。
group:groups: 保存されるグループ。
正常に完了すると、groups構造が戻されます。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションsave_groupに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。ユーザー・パーミッションは、ユーザー自身のグループを保存する場合に必要です。マネージャ・パーミッションは、他のユーザーのグループを更新する場合に必要です。
remove_user APIコールによって、グループからユーザーが削除されます。
authInfo: このオプションの引数は、認証トークンを含む要素です。
name: ユーザーのログイン名。
groupName: ユーザーが削除されるグループ。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションremove_userに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。
delete_group APIコールによって、指定した名前のグループがOracle Service Registryから削除されます。
authInfo: このオプションの引数は、認証トークンを含む要素です。
name: 必須の値には、削除されるグループの名前が含まれています。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションdelete_groupに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。ユーザー・パーミッションは、ユーザー自身のグループを削除する場合に必要です。マネージャ・パーミッションは、他のユーザーのグループを削除する場合に必要です。
where_amI APIコールによって、このコールを実行しているユーザーがメンバーであるグループのリストが戻されます。このコールでは、プライベートおよびパブリックの両方のグループが戻されます。
authInfo: このオプションの引数は、認証トークンを含む要素です。
loginName: この必須引数は、ユーザー・アカウントを一意に識別します。
正常に完了すると、groupList構造が戻されます。
このAPIコールには、org.systinet.uddi.client.group.GroupApiおよびアクションwhere_amIに対するAPIユーザー・パーミッションまたはAPIマネージャ・パーミッションが必要です。ユーザー・パーミッションは、ユーザー自身のグループを取得する場合に必要です。マネージャ・パーミッションは、他のユーザーのグループを取得する場合に必要です。
WSDL仕様は、ファイルgroup.wsdlで確認できます。
Group APIエンドポイントは、http://<ホスト名>:<ポート>/<コンテキスト>/uddi/groupで確認できます。
Java APIは、Group WSDLから生成されます。詳細は、「org.systinet.uddi.group.GroupApi」を参照してください。また、Groupのデモを参照および試行することをお薦めします。