Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle Access Management Mobile and Social
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.security.idaas.rest.jaxrs.client.sdk.userprofile
Class GroupsClient

java.lang.Object
  extended by oracle.security.idaas.rest.jaxrs.client.sdk.userprofile.BaseClient
      extended by oracle.security.idaas.rest.jaxrs.client.sdk.userprofile.GroupsClient

public class GroupsClient
extends BaseClient

Constructor Summary
GroupsClient(ClientSDKConfig config)
          Sets the config info such as uri for the people REST service, which is then used on requests.

 

Method Summary
 java.lang.String addGroupMember(java.lang.String existingGroupName, java.lang.String existingGroupMemberName, Headers headers)
          Add a group to a group via group-members uri.
 java.lang.String addGroupOwner(java.lang.String existingGroupName, java.lang.String existingOwnerGroupName, Headers headers)
          Add a group to a group as an owner via group-groupOwner uri.
 java.lang.String addMemberOf(java.lang.String existingGroupName, java.lang.String existingMemberGroupName, Headers headers)
          Add a user to a group via group-groupMemberOf uri.
 java.lang.String addOwnerOf(java.lang.String existingGroupName, java.lang.String existingOwnerGroupName, Headers headers)
          Add a group as an owner to a group via group-groupOwnerOf uri.
 java.lang.String addPersonMember(java.lang.String existingGroupName, java.lang.String existingUserUid, Headers headers)
          Add a user to a group via group-members uri.
 java.lang.String addPersonOwner(java.lang.String existingGroupName, java.lang.String existingUserUid, Headers headers)
          Add a person to a group as an owner via group-personOwner uri.
 java.lang.String addUserToGroup(java.lang.String existingGroupName, java.lang.String existingUserUid, Headers headers)
          Deprecated. 
 java.lang.String createGroup(java.util.Map<java.lang.String,java.lang.Object> groupAttributes, Headers headers)
          Create a new group.
 boolean deleteGroup(java.lang.String existingGroupName, Headers headers)
          Delete a group.
 boolean deleteGroupMember(java.lang.String existingGroupName, java.lang.String memberGroupName, Headers headers)
          Delete a group's membership from a group.
 boolean deleteGroupOwner(java.lang.String existingGroupName, java.lang.String ownershipId, Headers headers)
          Delete a group's ownership from a group via via group-groupOwner uri.
 boolean deleteMemberFromGroup(java.lang.String existingGroupName, java.lang.String membershipId, Headers headers)
          Deprecated. 
 boolean deleteMemberOf(java.lang.String existingGroupName, java.lang.String existingMemberGroupName, Headers headers)
          Delete a group's membership from a group via group-groupMemberOf uri.
 boolean deleteOwnerOf(java.lang.String existingGroupName, java.lang.String ownershipId, Headers headers)
          Delete a group's ownership from a group via group-groupOwnerOf uri.
 boolean deletePersonMember(java.lang.String existingGroupName, java.lang.String membershipId, Headers headers)
          Delete a user's membership from a group.
 boolean deletePersonOwner(java.lang.String existingGroupName, java.lang.String ownershipId, Headers headers)
          Delete a user's ownership from a group via via group-personOwner uri.
 java.lang.String getGroupMember(java.lang.String existingGroupName, java.lang.String memberGroupName, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the info of a specific membership of a group via group-groupMembers uri..
 java.lang.String getGroupOwner(java.lang.String existingGroupName, java.lang.String ownershipId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the info of a specific group ownership via group-groupOwner uri.
 java.lang.String getInfoGroupMembership(java.lang.String existingGroupName, java.lang.String membershipId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Deprecated. 
 java.lang.String getMemberOf(java.lang.String existingGroupName, java.lang.String existingMemberGroupName, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the mermbership info of a specific group of which a group is a member via group-groupMemberOf uri.
 java.lang.String getOwnerOf(java.lang.String existingGroupName, java.lang.String ownershipId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the ownership info for the group of which a group is an owner via group-groupOwnerOf uri.
 java.lang.String getPersonMember(java.lang.String existingGroupName, java.lang.String membershipId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the info of a specific membership of a group via group-members uri..
 java.lang.String getPersonOwner(java.lang.String existingGroupName, java.lang.String ownershipId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          Get the info of a specific ownership via group-personOwner uri.
 java.lang.String readGroup(java.lang.String groupUriId, java.util.Map<java.lang.String,java.lang.String> queryParameters, Headers headers)
          get the details of an existing group.
 JSONCollection searchGroupMembers(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the group members of a group.
 JSONCollection searchGroupMembership(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Deprecated. 
 JSONCollection searchGroupOwners(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the group owners of a group via group-groupOwner uri.
 JSONCollection searchGroups(java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Does a search on groups collection resource.
 JSONCollection searchMemberOf(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the groups of which the group is a member of via group-groupMemberOf uri.
 JSONCollection searchOwnerOf(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the groups of which the group is an owner of via group-groupOwnerOf uri.
 JSONCollection searchPersonMembers(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the members of a group.
 JSONCollection searchPersonOwners(java.lang.String existingGroupName, java.util.Map<java.lang.String,java.lang.String> queryParams, Headers headers)
          Get all the person owners of a group via group-personOwner uri.
 java.lang.String updateGroup(java.lang.String groupUriId, java.util.Map<java.lang.String,java.lang.Object> resourceAttrs, Headers headers)
          For the set of attributed that the client wants changed, the client would set the group's attribute keys and values into a map and then call this method.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

GroupsClient

public GroupsClient(ClientSDKConfig config)
             throws OICClientException
Sets the config info such as uri for the people REST service, which is then used on requests. To consume APIs for group operations which relate with member/memberOf/owner/ownerOf URI, the calling application needs to pass in UserProfileClientSDKConfig, instead of ClientSDKConfig.
Parameters:
config - which has info such as serviceURI etc
Throws:
OICClientException

Method Detail

readGroup

public java.lang.String readGroup(java.lang.String groupUriId,
                                  java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                  Headers headers)
                           throws OICClientException
get the details of an existing group. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors
Parameters:
groupUriId - is the uid of the group to be read.
queryParameters - contains additional url query parameters
headers - are any http headers to be included in request.
Returns:
the raw JSON string results.
Throws:
OICClientException

updateGroup

public java.lang.String updateGroup(java.lang.String groupUriId,
                                    java.util.Map<java.lang.String,java.lang.Object> resourceAttrs,
                                    Headers headers)
                             throws OICClientException
For the set of attributed that the client wants changed, the client would set the group's attribute keys and values into a map and then call this method. For example, client might do this:: Map<String, Object> resourceAttrs = new HashMap<String, Object>(); resourceAttrs.put("description", "description2"); //call constructor with //rest host machine name GroupClient pc = new GroupClient(groupURI); Then for the group uri-id .../group/grp1 or whatever the user's URI is, add the last path fragment for the person-uri-id String groupUriid="grp1"; gc.updateGroup(groupUriId, resourceAttrs);
Parameters:
groupUriId - is theuid of the group to be updated.
resourceAttrs - is the map of attribute names and new values to be updated.
headers - are any http headers to be included in request.
Returns:
the JSON representation of the updated group.
Throws:
OICClientException

createGroup

public java.lang.String createGroup(java.util.Map<java.lang.String,java.lang.Object> groupAttributes,
                                    Headers headers)
                             throws OICClientException
Create a new group. cn and description are attributes to send in json aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups
Parameters:
groupAttributes - is the map of attribute names and new values related to the group to be created.
headers - are any http headers to be included in request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchGroups

public JSONCollection searchGroups(java.util.Map<java.lang.String,java.lang.String> queryParams,
                                   Headers headers)
                            throws OICClientException
Does a search on groups collection resource. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups
Parameters:
queryParams - contains query parameters for the request.
headers - contains authorization headers for the request.
Throws:
OICClientException

deleteGroup

public boolean deleteGroup(java.lang.String existingGroupName,
                           Headers headers)
                    throws OICClientException
Delete a group. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/doctors
Parameters:
existingGroupName - is the name of the group to be deleted.
headers - are any http headers to be included in request.
Returns:
true if the deletion is successful.
Throws:
OICClientException

addUserToGroup

@Deprecated
public java.lang.String addUserToGroup(java.lang.String existingGroupName,
                                                  java.lang.String existingUserUid,
                                                  Headers headers)
                                throws OICClientException
Deprecated. 
Add a user to a group via group-members uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/members need to pass in person-uri and group-uri in json. response contains same info, plus "uri" field
Parameters:
existingGroupName - such as "doctors"
existingUserUid - such as "alice123"
headers - contains authorization headers for the request
Returns:
the raw JSON string results.
Throws:
OICClientException

searchGroupMembership

@Deprecated
public JSONCollection searchGroupMembership(java.lang.String existingGroupName,
                                                       java.util.Map<java.lang.String,java.lang.String> queryParams,
                                                       Headers headers)
                                     throws OICClientException
Deprecated. 
Get all the members of a group. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/ members
Parameters:
existingGroupName - is the name of the group from which the members are searched for.
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the users are contained in json "elements" array field. Values may be person-uri for each object item in array
Throws:
OICClientException

getInfoGroupMembership

@Deprecated
public java.lang.String getInfoGroupMembership(java.lang.String existingGroupName,
                                                          java.lang.String membershipId,
                                                          java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                                          Headers headers)
                                        throws OICClientException
Deprecated. 
Get the info of a specific membership of a group. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/members/alice
Parameters:
existingGroupName - is the group name
membershipId - is the person name
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the raw JSON string results.
Throws:
OICClientException

deleteMemberFromGroup

@Deprecated
public boolean deleteMemberFromGroup(java.lang.String existingGroupName,
                                                java.lang.String membershipId,
                                                Headers headers)
                              throws OICClientException
Deprecated. 
Delete a user's membership from a group. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/members/alice
Parameters:
existingGroupName - is the name of the group to be deleted.
membershipId - is the person name
headers - are any http headers to be included in request.
Returns:
true if the deletion is successful.
Throws:
OICClientException

addPersonMember

public java.lang.String addPersonMember(java.lang.String existingGroupName,
                                        java.lang.String existingUserUid,
                                        Headers headers)
                                 throws OICClientException
Add a user to a group via group-members uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/members
Parameters:
existingGroupName - such as "doctors".
existingUserUid - such as "alice123".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchPersonMembers

public JSONCollection searchPersonMembers(java.lang.String existingGroupName,
                                          java.util.Map<java.lang.String,java.lang.String> queryParams,
                                          Headers headers)
                                   throws OICClientException
Get all the members of a group. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/members *
Parameters:
existingGroupName - is the name of the group from which the members are searched for.
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the users are contained in json "elements" array field. Values may be person-uri for each object item in array
Throws:
OICClientException

getPersonMember

public java.lang.String getPersonMember(java.lang.String existingGroupName,
                                        java.lang.String membershipId,
                                        java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                        Headers headers)
                                 throws OICClientException
Get the info of a specific membership of a group via group-members uri.. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/members/alice *
Parameters:
existingGroupName - is the group name.
membershipId - is the person name.
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the raw JSON string results.
Throws:
OICClientException

deletePersonMember

public boolean deletePersonMember(java.lang.String existingGroupName,
                                  java.lang.String membershipId,
                                  Headers headers)
                           throws OICClientException
Delete a user's membership from a group. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/members/alice
Parameters:
existingGroupName - is the name of the group to be deleted.
membershipId - is the person name.
headers - are any http headers to be included in request.
Returns:
true if the deletion is successful.
Throws:
OICClientException

addGroupMember

public java.lang.String addGroupMember(java.lang.String existingGroupName,
                                       java.lang.String existingGroupMemberName,
                                       Headers headers)
                                throws OICClientException
Add a group to a group via group-members uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/groupMembers
Parameters:
existingGroupName - such as "doctors".
existingGroupMemberName - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchGroupMembers

public JSONCollection searchGroupMembers(java.lang.String existingGroupName,
                                         java.util.Map<java.lang.String,java.lang.String> queryParams,
                                         Headers headers)
                                  throws OICClientException
Get all the group members of a group. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/groupMembers
Parameters:
existingGroupName - is the name of the group from which the group members are searched for.
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the groups are contained in json "elements" array field. Values may be member-uri for each object item in array
Throws:
OICClientException

getGroupMember

public java.lang.String getGroupMember(java.lang.String existingGroupName,
                                       java.lang.String memberGroupName,
                                       java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                       Headers headers)
                                throws OICClientException
Get the info of a specific membership of a group via group-groupMembers uri.. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/groupMembers/obgyn
Parameters:
existingGroupName - is the group name.
memberGroupName - is the person name.
queryParams - contains query parameters for the request.
headers - are any http headers to be included in request.
Returns:
the raw JSON string results.
Throws:
OICClientException

deleteGroupMember

public boolean deleteGroupMember(java.lang.String existingGroupName,
                                 java.lang.String memberGroupName,
                                 Headers headers)
                          throws OICClientException
Delete a group's membership from a group. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/groupMembers/obgyn
Parameters:
existingGroupName - is the name of the group to be deleted.
memberGroupName - is the person name.
headers - are any http headers to be included in request.
Returns:
true if the deletion is successful.
Throws:
OICClientException

addMemberOf

public java.lang.String addMemberOf(java.lang.String existingGroupName,
                                    java.lang.String existingMemberGroupName,
                                    Headers headers)
                             throws OICClientException
Add a user to a group via group-groupMemberOf uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/obgyn/groupMemberOf/
Parameters:
existingGroupName - such as "doctors".
existingMemberGroupName - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

getMemberOf

public java.lang.String getMemberOf(java.lang.String existingGroupName,
                                    java.lang.String existingMemberGroupName,
                                    java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                    Headers headers)
                             throws OICClientException
Get the mermbership info of a specific group of which a group is a member via group-groupMemberOf uri. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ obgyn/groupMemberOf/doctors
Parameters:
existingGroupName - such as "doctors".
existingMemberGroupName - such as "obgyn".
queryParameters - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchMemberOf

public JSONCollection searchMemberOf(java.lang.String existingGroupName,
                                     java.util.Map<java.lang.String,java.lang.String> queryParams,
                                     Headers headers)
                              throws OICClientException
Get all the groups of which the group is a member of via group-groupMemberOf uri. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/obgyn/groupMemberOf
Parameters:
existingGroupName - such as "obgyn".
queryParams - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the groups are contained in json "elements" array field. Values may be group-uri for each object item in array
Throws:
OICClientException

deleteMemberOf

public boolean deleteMemberOf(java.lang.String existingGroupName,
                              java.lang.String existingMemberGroupName,
                              Headers headers)
                       throws OICClientException
Delete a group's membership from a group via group-groupMemberOf uri. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ obgyn/groupMemberOf/doctors
Parameters:
existingGroupName - such as "doctors".
existingMemberGroupName - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
true if the deletion succeeds.
Throws:
OICClientException

addPersonOwner

public java.lang.String addPersonOwner(java.lang.String existingGroupName,
                                       java.lang.String existingUserUid,
                                       Headers headers)
                                throws OICClientException
Add a person to a group as an owner via group-personOwner uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctor1/personOwner
Parameters:
existingGroupName - such as "doctors".
existingUserUid - such as "alice123".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

getPersonOwner

public java.lang.String getPersonOwner(java.lang.String existingGroupName,
                                       java.lang.String ownershipId,
                                       java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                       Headers headers)
                                throws OICClientException
Get the info of a specific ownership via group-personOwner uri. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/personOwner/alice123
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "alice123".
queryParameters - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchPersonOwners

public JSONCollection searchPersonOwners(java.lang.String existingGroupName,
                                         java.util.Map<java.lang.String,java.lang.String> queryParams,
                                         Headers headers)
                                  throws OICClientException
Get all the person owners of a group via group-personOwner uri. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/personOwner
Parameters:
existingGroupName - such as "doctors".
queryParams - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the users are contained in json "elements" array field. Values may be owner-uri for each object item in array.
Throws:
OICClientException

deletePersonOwner

public boolean deletePersonOwner(java.lang.String existingGroupName,
                                 java.lang.String ownershipId,
                                 Headers headers)
                          throws OICClientException
Delete a user's ownership from a group via via group-personOwner uri. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/personOwner/alice123
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "alice123".
headers - contains authorization headers for the request.
Returns:
true if the deletion succeeds.
Throws:
OICClientException

addGroupOwner

public java.lang.String addGroupOwner(java.lang.String existingGroupName,
                                      java.lang.String existingOwnerGroupName,
                                      Headers headers)
                               throws OICClientException
Add a group to a group as an owner via group-groupOwner uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctor1/groupOwner
Parameters:
existingGroupName - such as "doctors".
existingOwnerGroupName - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

getGroupOwner

public java.lang.String getGroupOwner(java.lang.String existingGroupName,
                                      java.lang.String ownershipId,
                                      java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                      Headers headers)
                               throws OICClientException
Get the info of a specific group ownership via group-groupOwner uri. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/groupOwner/obgyn
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "obgyn".
queryParameters - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchGroupOwners

public JSONCollection searchGroupOwners(java.lang.String existingGroupName,
                                        java.util.Map<java.lang.String,java.lang.String> queryParams,
                                        Headers headers)
                                 throws OICClientException
Get all the group owners of a group via group-groupOwner uri. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/doctors/groupOwner
Parameters:
existingGroupName - such as "doctors".
queryParams - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the groups are contained in json "elements" array field. Values may be owner-uri for each object item in array.
Throws:
OICClientException

deleteGroupOwner

public boolean deleteGroupOwner(java.lang.String existingGroupName,
                                java.lang.String ownershipId,
                                Headers headers)
                         throws OICClientException
Delete a group's ownership from a group via via group-groupOwner uri. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ doctors/groupOwner/obgyn
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
true if the deletion succeeds.
Throws:
OICClientException

addOwnerOf

public java.lang.String addOwnerOf(java.lang.String existingGroupName,
                                   java.lang.String existingOwnerGroupName,
                                   Headers headers)
                            throws OICClientException
Add a group as an owner to a group via group-groupOwnerOf uri. aka POST http://localhost:18001/oic_rest/rest/crudssvc1/groups/obgyn/groupOwnerOf/
Parameters:
existingGroupName - such as "doctors".
existingOwnerGroupName - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

getOwnerOf

public java.lang.String getOwnerOf(java.lang.String existingGroupName,
                                   java.lang.String ownershipId,
                                   java.util.Map<java.lang.String,java.lang.String> queryParameters,
                                   Headers headers)
                            throws OICClientException
Get the ownership info for the group of which a group is an owner via group-groupOwnerOf uri. aka GET http://localhost:18001/oic_rest/rest/peopleservice1/groups/ obgyn/groupOwnerOf/doctors
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "obgyn".
queryParameters - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the raw JSON string results.
Throws:
OICClientException

searchOwnerOf

public JSONCollection searchOwnerOf(java.lang.String existingGroupName,
                                    java.util.Map<java.lang.String,java.lang.String> queryParams,
                                    Headers headers)
                             throws OICClientException
Get all the groups of which the group is an owner of via group-groupOwnerOf uri. aka GET http://localhost:18001/oic_rest/rest/crudssvc1/groups/obgyn/groupOwnerOf
Parameters:
existingGroupName - such as "obgyn".
queryParams - contains additional url query parameters.
headers - contains authorization headers for the request.
Returns:
the groups are contained in json "elements" array field. Values may be group-uri for each object item in array
Throws:
OICClientException

deleteOwnerOf

public boolean deleteOwnerOf(java.lang.String existingGroupName,
                             java.lang.String ownershipId,
                             Headers headers)
                      throws OICClientException
Delete a group's ownership from a group via group-groupOwnerOf uri. aka DELETE http://localhost:18001/oic_rest/rest/peopleservice1/groups/ obgyn/groupOwnerOf/doctors
Parameters:
existingGroupName - such as "doctors".
ownershipId - such as "obgyn".
headers - contains authorization headers for the request.
Returns:
true if the deletion succeeds.
Throws:
OICClientException

Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Copyright (c) 2012,
Oracle All Rights Reserved.
Built 06/05/2012 17:18:07 PDT
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD