Group  Locate

Group API is used to query and manage user groups in Oracle Service Registry.

Data Structures  Locate

The following structures are used by the Group API:

group  Locate

This element serves as a container for groupInfo and userInfos structures.

groups  Locate

This element serves as a container for one or more group structures.

groupInfo  Locate

This element contains information about one user group:

  • The required name element holds the name of the group.

  • The optional description element is used to describe group and its usage.

  • The owner element contains the loginName of the user who created this group.

  • The privateGroup element indicates whether the group is public or private.

  • The external element indicates whether the group is external (For example, in LDAP) or not.

groupInfos  Locate

This element serves as a container for one or more groupInfo elements.

groupList  Locate

Table 52. Attributes

AttributeRequired
truncatedNo

This structure server as a container for optional listDescription and optional groupInfos structures. The truncated attribute indicates whether the list of groupInfos is truncated.

Operations  Locate
add_user  Locate

The add_user API call is used to add a user to a user group.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • groupName - the group to which the user will be added.

  • account:userInfos - user that will be added to the group.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action add_user.

find_user  Locate

The find_user API call is used to find user within the user group.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • name - login name of the user

  • account:findQualifier - find qualifier

  • groupName - the group in which the user will be searched.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action find_user.

Returns  Locate

Upon successful completion, the UserList structure is returned.

find_group  Locate

The find_group API call is used to search groups in Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • group:findQualifier - The collection of findQualifier used to alter default behavior.

  • name - The required value contains name of the group to be searched.

Behavior  Locate

The following findQualifiers affect behavior of the call. The exactMatch findQualifier causes that exact match on group name is required, while default approximateMatch findQualifier enables SQL wildcard query. The findPrivateGroups findQualifier enables search between private groups, findPublicGroups enables search between public groups and findMyGroups will cause the search to be performed only between groups owned by the user who executed this call. The sortByNameAsc and sortByNameDesc findQualifiers controls order, in which the data is returned.

If no findQualifier is defined, default findQualifier set contains approximateMatch, findPrivateGroups, findPublicGroups and sortByNameAsc findQualifiers.

Returns  Locate

Upon successful completion, the groupList structure is returned.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action find_group.

get_group  Locate

The get_group API call is used to get details for one or more groups in Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • name - The required value contains name of the group to be returned.

  • brief - if you set this attribute, the result will not contain members of the group. Setting the attribute is useful when working with large groups with thousands of members.

Returns  Locate

Upon successful completion, the groups structure is returned.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action get_group. The user permission is needed to get user's own groups, the manager permission is required to get other users' groups.

save_group  Locate

The save_group API call is used to save collection of groups to Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • group:groups - The groups to be saved.

Returns  Locate

Upon successful completion, the groups structure is returned.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action save_group. The user permission is needed to save user's own groups, the manager permission is required to update other users' groups.

remove_user  Locate

The remove_user API call removes user from the group.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • name - login name of the user

  • groupName - the group from which the user will be removed

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action remove_user.

delete_group  Locate

The delete_group API call causes that groups identified by their names will be removed from Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • name - The required value contains names of the groups to be deleted.

Returns  Locate

Upon successful completion, the groups structure is returned.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action delete_group. The user permission is needed to delete user's own groups, the manager permission is required to delete other users' groups.

where_amI  Locate

The where_amI API call is there to return list of groups where the user executing this call is member. The call returns both private and public groups.

Syntax  Locate
Arguments  Locate
  • authInfo - This optional argument is an element that contains an authentication token.

  • loginName - This required argument uniquely identifies the user account.

Returns  Locate

Upon successful completion, the groupList structure is returned.

Permissions  Locate

This API call requires API user or manager permission for org.systinet.uddi.client.group.GroupApi and the action where_amI. The user permission is needed to get groups for the user himself, the manager permission is required to get groups for other user.

WSDL  Locate

You can find the WSDL specification in the file group.wsdl.

API Endpoint  Locate

You can find the Group API endpoint at http://<host name>:<port>/<context>/uddi/group.

Java  Locate

The Java API is generated from Group WSDL. You are encouraged to browse org.systinet.uddi.group.GroupApi and to read and try Group demos.