edu.internet2.middleware.grouper.webservices
Class GrouperService

java.lang.Object
  edu.internet2.middleware.grouper.webservices.GrouperService

public class GrouperService
extends Object

 All public methods in this class are available in the web service
 as both SOAP and REST.
 
 booleans can either be T, F, true, false (case-insensitive)
 
 get wsdl from: http://localhost:8090/grouper/services/GrouperService?wsdl
 
 generate client (after wsdl copied): C:\mchyzer\isc\dev\grouper\axisJar2>wsdl2java -p edu.internet2.middleware.grouper.webservicesClient -t -uri GrouperService.wsdl




Author:
  
mchyzer
 

Constructor Summary

GrouperService()

Method Summary

WsAddMemberResults	addMember(WsGroupLookup wsGroupLookup, WsSubjectLookup[] subjectLookups, String replaceAllExisting, WsSubjectLookup actAsSubjectLookup, String[] paramNames, String[] paramValues) add member to a group (if already a direct member, ignore)
WsAddMemberResult	addMemberSimple(String groupName, String groupUuid, String subjectId, String subjectIdentifier, String actAsSubjectId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) add member to a group (if already a direct member, ignore)
WsFindGroupsResults	findGroups(String groupName, String stemName, String stemNameScope, String groupUuid, String queryTerm, String querySearchFromStemName, String queryScope, WsSubjectLookup actAsSubjectLookup, String[] paramNames, String[] paramValues) find a group or groups
WsFindGroupsResults	findGroupsSimple(String groupName, String stemName, String stemNameScope, String groupUuid, String queryTerm, String querySearchFromStemName, String queryScope, String actAsSubjectId, String actAsSubjectIdentifier, String paramName0, String paramValue0, String paramName1, String paramValue1) find a group or groups

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrouperService

public GrouperService()

Method Detail

findGroupsSimple

public WsFindGroupsResults findGroupsSimple(String groupName,
                                            String stemName,
                                            String stemNameScope,
                                            String groupUuid,
                                            String queryTerm,
                                            String querySearchFromStemName,
                                            String queryScope,
                                            String actAsSubjectId,
                                            String actAsSubjectIdentifier,
                                            String paramName0,
                                            String paramValue0,
                                            String paramName1,
                                            String paramValue1)

find a group or groups

Parameters:

groupName - search by group name (must match exactly), cannot use other params with this

stemName - will return groups in this stem

stemNameScope - if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stem

groupUuid - search by group uuid (must match exactly), cannot use other params with this

queryTerm - if searching by query, this is a term that will be matched to name, extension, etc

querySearchFromStemName - if a stem name is put here, that will narrow the search

queryScope - NAME is searching by name, EXTENSION is display extension, and DISPLAY_NAME is display name. This is required if a query search

actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer

actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer

paramName0 - reserved for future use

paramValue0 - reserved for future use

paramName1 - reserved for future use

paramValue1 - reserved for future use

Returns:

the groups, or no groups if none found

findGroups

public WsFindGroupsResults findGroups(String groupName,
                                      String stemName,
                                      String stemNameScope,
                                      String groupUuid,
                                      String queryTerm,
                                      String querySearchFromStemName,
                                      String queryScope,
                                      WsSubjectLookup actAsSubjectLookup,
                                      String[] paramNames,
                                      String[] paramValues)

find a group or groups

Parameters:

groupName - search by group name (must match exactly), cannot use other params with this

stemName - will return groups in this stem

stemNameScope - if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Required if searching by stem

groupUuid - search by group uuid (must match exactly), cannot use other params with this

queryTerm - if searching by query, this is a term that will be matched to name, extension, etc

querySearchFromStemName - if a stem name is put here, that will narrow the search

queryScope - NAME is searching by name, EXTENSION is display extension, DISPLAY_NAME is display name, and DISPLAY_EXTENSION is searching by display extension This is required if a query search

actAsSubjectLookup -

paramNames - optional: reserved for future use

paramValues - optional: reserved for future use

Returns:

the groups, or no groups if none found

addMember

public WsAddMemberResults addMember(WsGroupLookup wsGroupLookup,
                                    WsSubjectLookup[] subjectLookups,
                                    String replaceAllExisting,
                                    WsSubjectLookup actAsSubjectLookup,
                                    String[] paramNames,
                                    String[] paramValues)

add member to a group (if already a direct member, ignore)

Parameters:

wsGroupLookup -

subjectLookups - subjects to be added to the group

replaceAllExisting - optional: T or F (default), if the existing groups should be replaced

actAsSubjectLookup -

paramNames - optional: reserved for future use

paramValues - optional: reserved for future use

Returns:

the results

addMemberSimple

public WsAddMemberResult addMemberSimple(String groupName,
                                         String groupUuid,
                                         String subjectId,
                                         String subjectIdentifier,
                                         String actAsSubjectId,
                                         String actAsSubjectIdentifier,
                                         String paramName0,
                                         String paramValue0,
                                         String paramName1,
                                         String paramValue1)

add member to a group (if already a direct member, ignore)

Parameters:

groupName -

groupUuid -

subjectId -

subjectIdentifier -

actAsSubjectId - optional: is the subject id of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer

actAsSubjectIdentifier - optional: is the subject identifier of subject to act as (if proxying). Only pass one of actAsSubjectId or actAsSubjectIdentifer

paramName0 - reserved for future use

paramValue0 - reserved for future use

paramName1 - reserved for future use

paramValue1 - reserved for future use

Returns:

the result of one member add