edu.internet2.middleware.grouper.ws.rest
Class GrouperServiceRest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.GrouperServiceRest

public class GrouperServiceRest
extends java.lang.Object

consolidated static list of of rest web services (only web service methods here to have clean javadoc). the method name corresponds to the url and request method. e.g. "GET /groups/a:b:c/members" will correspond to groupMembersGet()


Constructor Summary
GrouperServiceRest()
           
 
Method Summary
static WsMessageAcknowledgeResults acknowledgeMessages(GrouperVersion clientVersion, WsRestAcknowledgeMessageRequest wsRestMessageAcknowledgeRequest)
          acknowledge message(s)
static WsAddMemberResults addMember(GrouperVersion clientVersion, java.lang.String groupName, WsRestAddMemberRequest wsRestAddMembersRequest)
           based on a group name, put multiple members, or all members.
static WsAddMemberLiteResult addMemberLite(GrouperVersion clientVersion, java.lang.String groupName, java.lang.String subjectId, java.lang.String sourceId, WsRestAddMemberLiteRequest wsRestAddMemberLiteRequest)
           based on a group name, put the member
static WsAttributeDefAssignActionResults assignAttributeDefActions(GrouperVersion clientVersion, WsRestAssignAttributeDefActionsRequest wsRestAssignAttributeDefActionsRequest)
          assign actions to attribute def
static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceRequest wsRestAssignAttributeDefNameInheritanceRequest)
          assign or unassign attribute def name permission inheritance
static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion, WsRestAssignAttributeDefNameInheritanceLiteRequest wsRestAssignAttributeDefNameInheritanceLiteRequest)
          assign or unassign attribute def name permission inheritance
static WsAssignAttributesResults assignAttributes(GrouperVersion clientVersion, WsRestAssignAttributesRequest wsRestAssignAttributesRequest)
          assign attributes rest
static WsAssignAttributesBatchResults assignAttributesBatch(GrouperVersion clientVersion, WsRestAssignAttributesBatchRequest wsRestAssignAttributesBatchRequest)
          assign attributes batch rest
static WsAssignAttributesLiteResults assignAttributesLite(GrouperVersion clientVersion, WsRestAssignAttributesLiteRequest wsRestAssignAttributesLiteRequest)
          assign attributes rest for one owner (lite)
static WsAssignGrouperPrivilegesResults assignGrouperPrivileges(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesRequest wsRestAssignGrouperPrivilegeRequest)
           assign privileges.
static WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(GrouperVersion clientVersion, WsRestAssignGrouperPrivilegesLiteRequest wsRestAssignGrouperPrivilegesLiteRequest)
           assign/revoke privileges for a group or stem and subject
static WsAssignPermissionsResults assignPermissions(GrouperVersion clientVersion, WsRestAssignPermissionsRequest wsRestAssignPermissionsRequest)
          assign permissions rest
static WsAssignPermissionsLiteResults assignPermissionsLite(GrouperVersion clientVersion, WsRestAssignPermissionsLiteRequest wsRestAssignPermissionsLiteRequest)
          assign attributes rest for one owner (lite)
static WsAttributeDefDeleteResults attributeDefDelete(GrouperVersion clientVersion, WsRestAttributeDefDeleteRequest wsRestAttributeDefDeleteRequest)
           based on a submitted object of type WsRestAttributeDefDeleteRequest, delete the attributeDefs.
static WsAttributeDefDeleteLiteResult attributeDefDeleteLite(GrouperVersion clientVersion, WsRestAttributeDefDeleteLiteRequest wsRestAttributeDefDeleteLiteRequest)
           
static WsAttributeDefNameDeleteResults attributeDefNameDelete(GrouperVersion clientVersion, WsRestAttributeDefNameDeleteRequest wsRestAttributeDefNameDeleteRequest)
          delete an AttributeDefName or many.
static WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(GrouperVersion clientVersion, java.lang.String attributeDefName, WsRestAttributeDefNameDeleteLiteRequest wsRestAttributeDefNameDeleteLiteRequest)
          delete an AttributeDefName
static WsAttributeDefNameSaveResults attributeDefNameSave(GrouperVersion clientVersion, WsRestAttributeDefNameSaveRequest wsRestAttributeDefNameSaveRequest)
          save an AttributeDefName or many (insert or update).
static WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(GrouperVersion clientVersion, java.lang.String attributeDefNameLookupName, WsRestAttributeDefNameSaveLiteRequest wsRestAttributeDefNameSaveLiteRequest)
          save an AttributeDefName (insert or update).
static WsAttributeDefSaveResults attributeDefSave(GrouperVersion clientVersion, WsRestAttributeDefSaveRequest wsRestAttributeDefSaveRequest)
          save an AttributeDef or many (insert or update).
static WsAttributeDefSaveLiteResult attributeDefSaveLite(GrouperVersion clientVersion, java.lang.String attributeDefLookupName, WsRestAttributeDefSaveLiteRequest wsRestAttributeDefSaveLiteRequest)
          save an AttributeDef (insert or update).
static WsDeleteMemberResults deleteMember(GrouperVersion clientVersion, java.lang.String groupName, WsRestDeleteMemberRequest wsRestDeleteMembersRequest)
           based on a group name, put multiple members, or all members.
static WsDeleteMemberLiteResult deleteMemberLite(GrouperVersion clientVersion, java.lang.String groupName, java.lang.String subjectId, java.lang.String sourceId, WsRestDeleteMemberLiteRequest wsRestDeleteMemberLiteRequest)
           based on a group name, delete the member
static WsExternalSubjectDeleteResults externalSubjectDelete(GrouperVersion clientVersion, WsRestExternalSubjectDeleteRequest wsRestExternalSubjectDeleteRequest)
           based on a submitted object of type WsRestExternalSubjectDeleteRequest, delete the external subjects.
static WsExternalSubjectSaveResults externalSubjectSave(GrouperVersion clientVersion, WsRestExternalSubjectSaveRequest wsRestExternalSubjectSaveRequest)
           based on a submitted object of type WsRestExternalSubjectSaveRequest, save external subjects.
static WsFindAttributeDefNamesResults findAttributeDefNames(GrouperVersion clientVersion, WsRestFindAttributeDefNamesRequest wsRestFindAttributeDefNamesRequest)
          find an attribute def name or attribute def names.
static WsFindAttributeDefNamesResults findAttributeDefNamesLite(GrouperVersion clientVersion, java.lang.String attributeDefNameName, WsRestFindAttributeDefNamesLiteRequest wsRestFindAttributeDefNamesLiteRequest)
          find an attribute def name or attribute def names.
static WsFindAttributeDefsResults findAttributeDefs(GrouperVersion clientVersion, WsRestFindAttributeDefsRequest wsRestFindAttributeDefsRequest)
          find an attribute def or attribute defs.
static WsFindAttributeDefsResults findAttributeDefsLite(GrouperVersion clientVersion, WsRestFindAttributeDefsLiteRequest wsRestFindAttributeDefsLiteRequest)
          find an attribute def or attribute defs.
static WsFindExternalSubjectsResults findExternalSubjects(GrouperVersion clientVersion, WsRestFindExternalSubjectsRequest wsRestFindExternalSubjectsRequest)
           based on an external subject query, get the external subjects
static WsFindGroupsResults findGroups(GrouperVersion clientVersion, WsRestFindGroupsRequest wsRestFindGroupsRequest)
           based on a group query, get the groups
static WsFindGroupsResults findGroupsLite(GrouperVersion clientVersion, WsRestFindGroupsLiteRequest wsRestFindGroupsLiteRequest)
           based on a group query, get the groups
static WsFindStemsResults findStems(GrouperVersion clientVersion, WsRestFindStemsRequest wsRestFindStemsRequest)
           based on a stem query, get the stems
static WsFindStemsResults findStemsLite(GrouperVersion clientVersion, WsRestFindStemsLiteRequest wsRestFindStemsLiteRequest)
           based on a stem query, get the stems
static WsGetAttributeAssignActionsResults getAttributeAssignActions(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsRequest wsRestGetAttributeAssignActionsRequest)
          get attribute assign actions rest
static WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(GrouperVersion clientVersion, WsRestGetAttributeAssignActionsLiteRequest wsRestGetAttributeAssignActionsLiteRequest)
          get attribute assign actions rest for one attribute definition
static WsGetAttributeAssignmentsResults getAttributeAssignments(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsRequest wsRestGetAttributesRequest)
          get attribute assignments rest
static WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(GrouperVersion clientVersion, WsRestGetAttributeAssignmentsLiteRequest wsRestGetAttributesLiteRequest)
          get attribute assignments rest for one owner (lite)
static WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(GrouperVersion clientVersion, WsRestGetGrouperPrivilegesLiteRequest wsRestGetGrouperPrivilegesLiteRequest)
           get privileges for a group or stem and subject
static WsGetGroupsResults getGroups(GrouperVersion clientVersion, java.lang.String subjectId, java.lang.String sourceId, WsRestGetGroupsRequest wsRestGetGroupsRequest)
           based a subject object of type WsRestGetGroupsRequest, get the groups /v1_3_000/subjects/123/groups
static WsGetGroupsLiteResult getGroupsLite(GrouperVersion clientVersion, java.lang.String subjectId, java.lang.String sourceId, WsRestGetGroupsLiteRequest wsRestGetGroupsLiteRequest)
           based on a subject, get the groups associated
static WsGetMembersResults getMembers(GrouperVersion clientVersion, WsRestGetMembersRequest wsRestGetMembersRequest)
           based on a group name, get members .
static WsGetMembershipsResults getMemberships(GrouperVersion clientVersion, java.lang.String groupName, java.lang.String subjectId, java.lang.String sourceId, WsRestGetMembershipsRequest wsRestGetMembershipsRequest)
           based on a group name, get memberships.
static WsGetMembershipsResults getMembershipsLite(GrouperVersion clientVersion, java.lang.String groupName, java.lang.String subjectId, java.lang.String sourceId, WsRestGetMembershipsLiteRequest wsRestGetMembershipsLiteRequest)
           based on a group name, get memberships.
static WsGetMembersLiteResult getMembersLite(GrouperVersion clientVersion, java.lang.String groupName, WsRestGetMembersLiteRequest wsRestGetMembersLiteRequest)
           based on a group name, get the members
static WsGetPermissionAssignmentsResults getPermissionAssignments(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsRequest wsRestGetPermissionAssignmentsRequest)
          get permission assignments rest
static WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(GrouperVersion clientVersion, WsRestGetPermissionAssignmentsLiteRequest wsRestGetPermissionAssignmentsLiteRequest)
          get permission assignments rest for one owner (lite)
static WsGetSubjectsResults getSubjects(GrouperVersion clientVersion, java.lang.String subjectId, java.lang.String sourceId, WsRestGetSubjectsRequest wsRestGetSubjectsRequest)
           find subjects by id or search string.
static WsGetSubjectsResults getSubjectsLite(GrouperVersion clientVersion, java.lang.String subjectId, java.lang.String sourceId, WsRestGetSubjectsLiteRequest wsRestGetSubjectsLiteRequest)
           find subjects by id or search string.
static WsGroupDeleteResults groupDelete(GrouperVersion clientVersion, WsRestGroupDeleteRequest wsRestGroupDeleteRequest)
           based on a submitted object of type WsRestGroupDeleteRequest, delete the groups.
static WsGroupDeleteLiteResult groupDeleteLite(GrouperVersion clientVersion, java.lang.String groupName, WsRestGroupDeleteLiteRequest wsRestGroupDeleteLiteRequest)
           based on a group name, delete a group
static WsGroupSaveResults groupSave(GrouperVersion clientVersion, WsRestGroupSaveRequest wsRestGroupSaveRequest)
           based on a submitted object of type WsRestGroupSaveRequest, save groups.
static WsGroupSaveLiteResult groupSaveLite(GrouperVersion clientVersion, java.lang.String groupLookupName, WsRestGroupSaveLiteRequest wsRestGroupSaveLiteRequest)
           based on a group name and submitted object type WsRestGroupSaveLiteRequest, save a group.
static WsHasMemberResults hasMember(GrouperVersion clientVersion, java.lang.String groupName, WsRestHasMemberRequest wsRestHasMembersRequest)
           based on a group name, and multiple subjects, see if they are members .
static WsHasMemberLiteResult hasMemberLite(GrouperVersion clientVersion, java.lang.String groupName, java.lang.String subjectId, java.lang.String sourceId, WsRestHasMemberLiteRequest wsRestHasMemberLiteRequest)
           based on a group name, and a subject, see if member
static WsMemberChangeSubjectResults memberChangeSubject(GrouperVersion clientVersion, WsRestMemberChangeSubjectRequest wsRestMemberChangeSubjectRequest)
           based on a member, change the subject e.g.
static WsMemberChangeSubjectLiteResult memberChangeSubjectLite(GrouperVersion clientVersion, java.lang.String oldSubjectId, java.lang.String oldSubjectSourceId, WsRestMemberChangeSubjectLiteRequest wsRestMemberChangeSubjectLiteRequest)
           based on a member, change the subject
static WsMessageResults receiveMessage(GrouperVersion clientVersion, WsRestReceiveMessageRequest wsRestReceiveMessageRequest)
          receive message(s)
static WsMessageResults sendMessage(GrouperVersion clientVersion, WsRestSendMessageRequest wsRestSendMessageRequest)
          send message(s)
static WsStemDeleteResults stemDelete(GrouperVersion clientVersion, WsRestStemDeleteRequest wsRestStemDeleteRequest)
           based on submitted object of type WsRestStemDeleteRequest, delete stems /v1_3_000/groups/aStem:aGroup/members
static WsStemDeleteLiteResult stemDeleteLite(GrouperVersion clientVersion, java.lang.String stemName, WsRestStemDeleteLiteRequest wsRestStemDeleteLiteRequest)
           based on a stem name, delete the stem url e.g.
static WsStemSaveResults stemSave(GrouperVersion clientVersion, WsRestStemSaveRequest wsRestStemSaveRequest)
           based on a submitted object of type WsRestStemSaveRequest, save stems.
static WsStemSaveLiteResult stemSaveLite(GrouperVersion clientVersion, java.lang.String stemLookupName, WsRestStemSaveLiteRequest wsRestStemSaveLiteRequest)
           based on a stem name and submitted object type WsRestStemSaveLiteRequest, save a stem.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GrouperServiceRest

public GrouperServiceRest()
Method Detail

findGroups

public static WsFindGroupsResults findGroups(GrouperVersion clientVersion,
                                             WsRestFindGroupsRequest wsRestFindGroupsRequest)
 based on a group query, get the groups
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestFindGroupsRequest - is the request body converted to an object
Returns:
the results

findGroupsLite

public static WsFindGroupsResults findGroupsLite(GrouperVersion clientVersion,
                                                 WsRestFindGroupsLiteRequest wsRestFindGroupsLiteRequest)
 based on a group query, get the groups
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestFindGroupsLiteRequest - is the request body converted to an object
Returns:
the results

getMembersLite

public static WsGetMembersLiteResult getMembersLite(GrouperVersion clientVersion,
                                                    java.lang.String groupName,
                                                    WsRestGetMembersLiteRequest wsRestGetMembersLiteRequest)
 based on a group name, get the members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestGetMembersLiteRequest - is the request body converted to an object
Returns:
the results

addMemberLite

public static WsAddMemberLiteResult addMemberLite(GrouperVersion clientVersion,
                                                  java.lang.String groupName,
                                                  java.lang.String subjectId,
                                                  java.lang.String sourceId,
                                                  WsRestAddMemberLiteRequest wsRestAddMemberLiteRequest)
 based on a group name, put the member
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
subjectId - from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345
sourceId - from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345
wsRestAddMemberLiteRequest - is the request body converted to an object
Returns:
the result

addMember

public static WsAddMemberResults addMember(GrouperVersion clientVersion,
                                           java.lang.String groupName,
                                           WsRestAddMemberRequest wsRestAddMembersRequest)
 based on a group name, put multiple members, or all members.  e.g. url:
 /v1_3_000/groups/aStem:aGroup/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestAddMembersRequest - is the request body converted to an object
Returns:
the result

assignGrouperPrivileges

public static WsAssignGrouperPrivilegesResults assignGrouperPrivileges(GrouperVersion clientVersion,
                                                                       WsRestAssignGrouperPrivilegesRequest wsRestAssignGrouperPrivilegeRequest)
 assign privileges.  e.g. url:
 /v1_3_000/grouperPrivileges
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestAssignGrouperPrivilegeRequest - is the request body converted to an object
Returns:
the result

deleteMemberLite

public static WsDeleteMemberLiteResult deleteMemberLite(GrouperVersion clientVersion,
                                                        java.lang.String groupName,
                                                        java.lang.String subjectId,
                                                        java.lang.String sourceId,
                                                        WsRestDeleteMemberLiteRequest wsRestDeleteMemberLiteRequest)
 based on a group name, delete the member
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
subjectId - from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345
sourceId - from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345
wsRestDeleteMemberLiteRequest - is the request body converted to an object
Returns:
the result

deleteMember

public static WsDeleteMemberResults deleteMember(GrouperVersion clientVersion,
                                                 java.lang.String groupName,
                                                 WsRestDeleteMemberRequest wsRestDeleteMembersRequest)
 based on a group name, put multiple members, or all members.  e.g. url:
 /v1_3_000/groups/aStem:aGroup/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestDeleteMembersRequest - is the request body converted to an object
Returns:
the result

hasMember

public static WsHasMemberResults hasMember(GrouperVersion clientVersion,
                                           java.lang.String groupName,
                                           WsRestHasMemberRequest wsRestHasMembersRequest)
 based on a group name, and multiple subjects, see if they are members .  e.g. url:
 /v1_3_000/groups/aStem:aGroup/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestHasMembersRequest - is the request body converted to an object
Returns:
the result

getMembers

public static WsGetMembersResults getMembers(GrouperVersion clientVersion,
                                             WsRestGetMembersRequest wsRestGetMembersRequest)
 based on a group name, get members .  e.g. url:
 /v1_3_000/groups/aStem:aGroup/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
wsRestGetMembersRequest - is the request body converted to an object
Returns:
the result

hasMemberLite

public static WsHasMemberLiteResult hasMemberLite(GrouperVersion clientVersion,
                                                  java.lang.String groupName,
                                                  java.lang.String subjectId,
                                                  java.lang.String sourceId,
                                                  WsRestHasMemberLiteRequest wsRestHasMemberLiteRequest)
 based on a group name, and a subject, see if member
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
subjectId - from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345
sourceId - from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345
wsRestHasMemberLiteRequest - is the request body converted to an object
Returns:
the result

memberChangeSubject

public static WsMemberChangeSubjectResults memberChangeSubject(GrouperVersion clientVersion,
                                                               WsRestMemberChangeSubjectRequest wsRestMemberChangeSubjectRequest)
 based on a member, change the subject  e.g. url:
 /v1_3_000/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
oldSubjectId - from url if applicable
oldSubjectSourceId - from url is applicable
wsRestMemberChangeSubjectRequest - is the request body converted to an object
Returns:
the result

memberChangeSubjectLite

public static WsMemberChangeSubjectLiteResult memberChangeSubjectLite(GrouperVersion clientVersion,
                                                                      java.lang.String oldSubjectId,
                                                                      java.lang.String oldSubjectSourceId,
                                                                      WsRestMemberChangeSubjectLiteRequest wsRestMemberChangeSubjectLiteRequest)
 based on a member, change the subject
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
oldSubjectId - from url, e.g. /v1_3_000/members/subjectId/123412345
oldSubjectSourceId - from url (optional) e.g. /v1_3_000/members/sourceId/someSource/subjectId/123412345/sourceId/12342
wsRestMemberChangeSubjectLiteRequest - is the request body converted to an object
Returns:
the result

getGrouperPrivilegesLite

public static WsGetGrouperPrivilegesLiteResult getGrouperPrivilegesLite(GrouperVersion clientVersion,
                                                                        WsRestGetGrouperPrivilegesLiteRequest wsRestGetGrouperPrivilegesLiteRequest)
 get privileges for a group or stem and subject
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestGetGrouperPrivilegesLiteRequest - is the request body converted to an object
Returns:
the result

assignGrouperPrivilegesLite

public static WsAssignGrouperPrivilegesLiteResult assignGrouperPrivilegesLite(GrouperVersion clientVersion,
                                                                              WsRestAssignGrouperPrivilegesLiteRequest wsRestAssignGrouperPrivilegesLiteRequest)
 assign/revoke privileges for a group or stem and subject
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestAssignGrouperPrivilegesLiteRequest - is the request body converted to an object
Returns:
the result

getGroups

public static WsGetGroupsResults getGroups(GrouperVersion clientVersion,
                                           java.lang.String subjectId,
                                           java.lang.String sourceId,
                                           WsRestGetGroupsRequest wsRestGetGroupsRequest)
 based a subject object of type WsRestGetGroupsRequest, get the groups
 /v1_3_000/subjects/123/groups
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
sourceId - is the source of the service
subjectId - is the subject to search for groups
wsRestGetGroupsRequest - is the request body converted to an object
Returns:
the result

getGroupsLite

public static WsGetGroupsLiteResult getGroupsLite(GrouperVersion clientVersion,
                                                  java.lang.String subjectId,
                                                  java.lang.String sourceId,
                                                  WsRestGetGroupsLiteRequest wsRestGetGroupsLiteRequest)
 based on a subject, get the groups associated
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group including stems, e.g. a:b:c
subjectId - from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345
sourceId - from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345
wsRestGetGroupsLiteRequest - is the request body converted to an object
Returns:
the result

findStems

public static WsFindStemsResults findStems(GrouperVersion clientVersion,
                                           WsRestFindStemsRequest wsRestFindStemsRequest)
 based on a stem query, get the stems
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestFindStemsRequest - is the request body converted to an object
Returns:
the results

findStemsLite

public static WsFindStemsResults findStemsLite(GrouperVersion clientVersion,
                                               WsRestFindStemsLiteRequest wsRestFindStemsLiteRequest)
 based on a stem query, get the stems
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestFindStemsLiteRequest - is the request body converted to an object
Returns:
the results

stemSave

public static WsStemSaveResults stemSave(GrouperVersion clientVersion,
                                         WsRestStemSaveRequest wsRestStemSaveRequest)
 based on a submitted object of type WsRestStemSaveRequest, save stems.  e.g. url:
 /v1_3_000/stems
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestStemSaveRequest - is the request body converted to an object
Returns:
the result

stemSaveLite

public static WsStemSaveLiteResult stemSaveLite(GrouperVersion clientVersion,
                                                java.lang.String stemLookupName,
                                                WsRestStemSaveLiteRequest wsRestStemSaveLiteRequest)
 based on a stem name and submitted object type WsRestStemSaveLiteRequest,
 save a stem.  url e.g. /v1_3_000/stems/aStem:aStem2
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
stemLookupName - is the name of the stem to lookup and save (old name if changing) including parent stems, e.g. a:b:c
wsRestStemSaveLiteRequest - is the request body converted to an object
Returns:
the result

stemDelete

public static WsStemDeleteResults stemDelete(GrouperVersion clientVersion,
                                             WsRestStemDeleteRequest wsRestStemDeleteRequest)
 based on submitted object of type WsRestStemDeleteRequest, delete stems
 /v1_3_000/groups/aStem:aGroup/members
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestStemDeleteRequest - is the request body converted to an object
Returns:
the result

stemDeleteLite

public static WsStemDeleteLiteResult stemDeleteLite(GrouperVersion clientVersion,
                                                    java.lang.String stemName,
                                                    WsRestStemDeleteLiteRequest wsRestStemDeleteLiteRequest)
 based on a stem name, delete the stem url e.g. /v1_3_000/stems/aStem:aStem2
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
stemName - is the name of the stem to delete including parent stems, e.g. a:b:c
wsRestStemDeleteLiteRequest - is the request body converted to an object
Returns:
the result

groupDelete

public static WsGroupDeleteResults groupDelete(GrouperVersion clientVersion,
                                               WsRestGroupDeleteRequest wsRestGroupDeleteRequest)
 based on a submitted object of type WsRestGroupDeleteRequest, delete the groups.  e.g. url:
 /v1_3_000/groups
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestGroupDeleteRequest - is the request body converted to an object
Returns:
the result

groupDeleteLite

public static WsGroupDeleteLiteResult groupDeleteLite(GrouperVersion clientVersion,
                                                      java.lang.String groupName,
                                                      WsRestGroupDeleteLiteRequest wsRestGroupDeleteLiteRequest)
 based on a group name, delete a group
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group to delete including parent stems, e.g. a:b:c
subjectId - from url, e.g. /v1_3_000/groups/aStem:aGroup/members/123412345
sourceId - from url (optional) e.g. /v1_3_000/groups/aStem:aGroup/members/sourceId/someSource/subjectId/123412345
wsRestGroupDeleteLiteRequest - is the request body converted to an object
Returns:
the result

groupSave

public static WsGroupSaveResults groupSave(GrouperVersion clientVersion,
                                           WsRestGroupSaveRequest wsRestGroupSaveRequest)
 based on a submitted object of type WsRestGroupSaveRequest, save groups.  e.g. url:
 /v1_3_000/groups
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestGroupSaveRequest - is the request body converted to an object
Returns:
the result

groupSaveLite

public static WsGroupSaveLiteResult groupSaveLite(GrouperVersion clientVersion,
                                                  java.lang.String groupLookupName,
                                                  WsRestGroupSaveLiteRequest wsRestGroupSaveLiteRequest)
 based on a group name and submitted object type WsRestGroupSaveLiteRequest,
 save a group.  url e.g. /v1_3_000/groups/aStem:aGroup2
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupLookupName - is the name of the group to lookup and save (old name if changing) including parent groups, e.g. a:b:c
wsRestGroupSaveLiteRequest - is the request body converted to an object
Returns:
the result

getMemberships

public static WsGetMembershipsResults getMemberships(GrouperVersion clientVersion,
                                                     java.lang.String groupName,
                                                     java.lang.String subjectId,
                                                     java.lang.String sourceId,
                                                     WsRestGetMembershipsRequest wsRestGetMembershipsRequest)
 based on a group name, get memberships.  e.g. url:
 /v1_3_000/groups/aStem:aGroup/memberships
 /v1_3_000/subjects/12345678/memberships
 /v1_3_000/memberships
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group (optional)
subjectId - is the subjectId (optional)
sourceId - is the source id of the subject to search for (optional)
wsRestGetMembershipsRequest - is the request body converted to an object
Returns:
the result

getMembershipsLite

public static WsGetMembershipsResults getMembershipsLite(GrouperVersion clientVersion,
                                                         java.lang.String groupName,
                                                         java.lang.String subjectId,
                                                         java.lang.String sourceId,
                                                         WsRestGetMembershipsLiteRequest wsRestGetMembershipsLiteRequest)
 based on a group name, get memberships.  e.g. url:
 /v1_3_000/groups/aStem:aGroup/memberships
 /v1_3_000/subjects/12345678/memberships
 /v1_3_000/memberships
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
groupName - is the name of the group (optional)
subjectId - is the subjectId (optional)
sourceId - is the source id of the subject to search for (optional)
wsRestGetMembershipsLiteRequest - is the request body converted to an object
Returns:
the result

getSubjects

public static WsGetSubjectsResults getSubjects(GrouperVersion clientVersion,
                                               java.lang.String subjectId,
                                               java.lang.String sourceId,
                                               WsRestGetSubjectsRequest wsRestGetSubjectsRequest)
 find subjects by id or search string.  e.g. url:
 /v1_6_000/subjects/12345678
 /v1_6_000/subjects
 

Parameters:
clientVersion - version of client, e.g. v1_6_000
subjectId - is the subjectId (optional)
sourceId - is the source id of the subject to search for (optional)
wsRestGetSubjectsRequest - is the request body converted to an object
Returns:
the result

getSubjectsLite

public static WsGetSubjectsResults getSubjectsLite(GrouperVersion clientVersion,
                                                   java.lang.String subjectId,
                                                   java.lang.String sourceId,
                                                   WsRestGetSubjectsLiteRequest wsRestGetSubjectsLiteRequest)
 find subjects by id or search string.  e.g. url:
 /v1_6_000/subjects/12345678
 /v1_6_000/subjects
 

Parameters:
clientVersion - version of client, e.g. v1_6_000
subjectId - is the subjectId (optional)
sourceId - is the source id of the subject to search for (optional)
wsRestGetSubjectsLiteRequest - is the request body converted to an object
Returns:
the result

getAttributeAssignments

public static WsGetAttributeAssignmentsResults getAttributeAssignments(GrouperVersion clientVersion,
                                                                       WsRestGetAttributeAssignmentsRequest wsRestGetAttributesRequest)
get attribute assignments rest

Parameters:
clientVersion -
wsRestGetAttributesRequest -
Returns:
the result

getAttributeAssignmentsLite

public static WsGetAttributeAssignmentsResults getAttributeAssignmentsLite(GrouperVersion clientVersion,
                                                                           WsRestGetAttributeAssignmentsLiteRequest wsRestGetAttributesLiteRequest)
get attribute assignments rest for one owner (lite)

Parameters:
clientVersion -
wsRestGetAttributesLiteRequest -
Returns:
the results object

assignAttributeDefActions

public static WsAttributeDefAssignActionResults assignAttributeDefActions(GrouperVersion clientVersion,
                                                                          WsRestAssignAttributeDefActionsRequest wsRestAssignAttributeDefActionsRequest)
assign actions to attribute def

Parameters:
clientVersion -
wsRestAssignAttributeDefActionsRequest -
Returns:
the result

getAttributeAssignActions

public static WsGetAttributeAssignActionsResults getAttributeAssignActions(GrouperVersion clientVersion,
                                                                           WsRestGetAttributeAssignActionsRequest wsRestGetAttributeAssignActionsRequest)
get attribute assign actions rest

Parameters:
clientVersion -
wsRestGetAttributeAssignActionsRequest -
Returns:
the result

getAttributeAssignActionsLite

public static WsGetAttributeAssignActionsResults getAttributeAssignActionsLite(GrouperVersion clientVersion,
                                                                               WsRestGetAttributeAssignActionsLiteRequest wsRestGetAttributeAssignActionsLiteRequest)
get attribute assign actions rest for one attribute definition

Parameters:
clientVersion -
wsRestGetAttributeAssignActionsLiteRequest -
Returns:
the results object

assignAttributes

public static WsAssignAttributesResults assignAttributes(GrouperVersion clientVersion,
                                                         WsRestAssignAttributesRequest wsRestAssignAttributesRequest)
assign attributes rest

Parameters:
clientVersion -
wsRestAssignAttributesRequest -
Returns:
the result

assignAttributesLite

public static WsAssignAttributesLiteResults assignAttributesLite(GrouperVersion clientVersion,
                                                                 WsRestAssignAttributesLiteRequest wsRestAssignAttributesLiteRequest)
assign attributes rest for one owner (lite)

Parameters:
clientVersion -
wsRestAssignAttributesLiteRequest -
Returns:
the results object

getPermissionAssignments

public static WsGetPermissionAssignmentsResults getPermissionAssignments(GrouperVersion clientVersion,
                                                                         WsRestGetPermissionAssignmentsRequest wsRestGetPermissionAssignmentsRequest)
get permission assignments rest

Parameters:
clientVersion -
wsRestGetPermissionAssignmentsRequest -
Returns:
the result

getPermissionAssignmentsLite

public static WsGetPermissionAssignmentsResults getPermissionAssignmentsLite(GrouperVersion clientVersion,
                                                                             WsRestGetPermissionAssignmentsLiteRequest wsRestGetPermissionAssignmentsLiteRequest)
get permission assignments rest for one owner (lite)

Parameters:
clientVersion -
wsRestGetPermissionAssignmentsLiteRequest -
Returns:
the results object

assignPermissions

public static WsAssignPermissionsResults assignPermissions(GrouperVersion clientVersion,
                                                           WsRestAssignPermissionsRequest wsRestAssignPermissionsRequest)
assign permissions rest

Parameters:
clientVersion -
wsRestAssignPermissionsRequest -
Returns:
the result

assignPermissionsLite

public static WsAssignPermissionsLiteResults assignPermissionsLite(GrouperVersion clientVersion,
                                                                   WsRestAssignPermissionsLiteRequest wsRestAssignPermissionsLiteRequest)
assign attributes rest for one owner (lite)

Parameters:
clientVersion -
wsRestAssignPermissionsLiteRequest -
Returns:
the results object

attributeDefSave

public static WsAttributeDefSaveResults attributeDefSave(GrouperVersion clientVersion,
                                                         WsRestAttributeDefSaveRequest wsRestAttributeDefSaveRequest)
save an AttributeDef or many (insert or update). Note, you cannot rename an existing AttributeDef.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAttributeDefSaveRequest -
Returns:
the results

attributeDefSaveLite

public static WsAttributeDefSaveLiteResult attributeDefSaveLite(GrouperVersion clientVersion,
                                                                java.lang.String attributeDefLookupName,
                                                                WsRestAttributeDefSaveLiteRequest wsRestAttributeDefSaveLiteRequest)
save an AttributeDef (insert or update). Note you cannot currently move an existing AttributeDef.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAttributeDefSaveLiteRequest -
attributeDefLookupName -
Returns:
the result of one attribute def save
See Also:
AttributeDefSave#save()}

attributeDefDelete

public static WsAttributeDefDeleteResults attributeDefDelete(GrouperVersion clientVersion,
                                                             WsRestAttributeDefDeleteRequest wsRestAttributeDefDeleteRequest)
 based on a submitted object of type WsRestAttributeDefDeleteRequest, delete the attributeDefs.  e.g. url:
 /v1_3_000/attributeDefs
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestAttributeDefDeleteRequest - is the request body converted to an object
Returns:
the result

attributeDefDeleteLite

public static WsAttributeDefDeleteLiteResult attributeDefDeleteLite(GrouperVersion clientVersion,
                                                                    WsRestAttributeDefDeleteLiteRequest wsRestAttributeDefDeleteLiteRequest)
Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestAttributeDefDeleteLiteRequest - is the request body converted to an object
Returns:
the result

findAttributeDefs

public static WsFindAttributeDefsResults findAttributeDefs(GrouperVersion clientVersion,
                                                           WsRestFindAttributeDefsRequest wsRestFindAttributeDefsRequest)
find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestFindAttributeDefsRequest -
Returns:
the attribute defs, or no attribute def if none found

findAttributeDefsLite

public static WsFindAttributeDefsResults findAttributeDefsLite(GrouperVersion clientVersion,
                                                               WsRestFindAttributeDefsLiteRequest wsRestFindAttributeDefsLiteRequest)
find an attribute def or attribute defs. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.

Parameters:
clientVersion -
wsRestFindAttributeDefsLiteRequest -
Returns:
the attribute defs, or no attribute def if none found

assignAttributeDefNameInheritance

public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritance(GrouperVersion clientVersion,
                                                                                           WsRestAssignAttributeDefNameInheritanceRequest wsRestAssignAttributeDefNameInheritanceRequest)
assign or unassign attribute def name permission inheritance

Parameters:
clientVersion -
wsRestAssignAttributeDefNameInheritanceRequest -
Returns:
the result

assignAttributeDefNameInheritanceLite

public static WsAssignAttributeDefNameInheritanceResults assignAttributeDefNameInheritanceLite(GrouperVersion clientVersion,
                                                                                               WsRestAssignAttributeDefNameInheritanceLiteRequest wsRestAssignAttributeDefNameInheritanceLiteRequest)
assign or unassign attribute def name permission inheritance

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAssignAttributeDefNameInheritanceLiteRequest -
Returns:
the result

attributeDefNameDelete

public static WsAttributeDefNameDeleteResults attributeDefNameDelete(GrouperVersion clientVersion,
                                                                     WsRestAttributeDefNameDeleteRequest wsRestAttributeDefNameDeleteRequest)
delete an AttributeDefName or many. Note, you cannot rename an existing AttributeDefName.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAttributeDefNameDeleteRequest -
Returns:
the results

attributeDefNameDeleteLite

public static WsAttributeDefNameDeleteLiteResult attributeDefNameDeleteLite(GrouperVersion clientVersion,
                                                                            java.lang.String attributeDefName,
                                                                            WsRestAttributeDefNameDeleteLiteRequest wsRestAttributeDefNameDeleteLiteRequest)
delete an AttributeDefName

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
attributeDefName -
wsRestAttributeDefNameDeleteLiteRequest -
Returns:
the result of one member add

attributeDefNameSave

public static WsAttributeDefNameSaveResults attributeDefNameSave(GrouperVersion clientVersion,
                                                                 WsRestAttributeDefNameSaveRequest wsRestAttributeDefNameSaveRequest)
save an AttributeDefName or many (insert or update). Note, you cannot rename an existing AttributeDefName.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAttributeDefNameSaveRequest -
Returns:
the results

attributeDefNameSaveLite

public static WsAttributeDefNameSaveLiteResult attributeDefNameSaveLite(GrouperVersion clientVersion,
                                                                        java.lang.String attributeDefNameLookupName,
                                                                        WsRestAttributeDefNameSaveLiteRequest wsRestAttributeDefNameSaveLiteRequest)
save an AttributeDefName (insert or update). Note you cannot currently move an existing AttributeDefName.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestAttributeDefNameSaveLiteRequest -
attributeDefNameLookupName -
Returns:
the result of one member add
See Also:
AttributeDefNameSave#save()}

findAttributeDefNames

public static WsFindAttributeDefNamesResults findAttributeDefNames(GrouperVersion clientVersion,
                                                                   WsRestFindAttributeDefNamesRequest wsRestFindAttributeDefNamesRequest)
find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestFindAttributeDefNamesRequest -
Returns:
the attribute def names, or no attribute def names if none found

findAttributeDefNamesLite

public static WsFindAttributeDefNamesResults findAttributeDefNamesLite(GrouperVersion clientVersion,
                                                                       java.lang.String attributeDefNameName,
                                                                       WsRestFindAttributeDefNamesLiteRequest wsRestFindAttributeDefNamesLiteRequest)
find an attribute def name or attribute def names. Each additional parameter sent will narow the search, except the lookups will just lookup whatever is sent.

Parameters:
clientVersion -
attributeDefNameName - if in url
wsRestFindAttributeDefNamesLiteRequest -
Returns:
the attribute def names, or no attribute def names if none found

assignAttributesBatch

public static WsAssignAttributesBatchResults assignAttributesBatch(GrouperVersion clientVersion,
                                                                   WsRestAssignAttributesBatchRequest wsRestAssignAttributesBatchRequest)
assign attributes batch rest

Parameters:
clientVersion -
wsRestAssignAttributesBatchRequest -
Returns:
the result

sendMessage

public static WsMessageResults sendMessage(GrouperVersion clientVersion,
                                           WsRestSendMessageRequest wsRestSendMessageRequest)
send message(s)

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestSendMessageRequest -
Returns:
the messages sent

receiveMessage

public static WsMessageResults receiveMessage(GrouperVersion clientVersion,
                                              WsRestReceiveMessageRequest wsRestReceiveMessageRequest)
receive message(s)

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestReceiveMessageRequest -
Returns:
the messages received

acknowledgeMessages

public static WsMessageAcknowledgeResults acknowledgeMessages(GrouperVersion clientVersion,
                                                              WsRestAcknowledgeMessageRequest wsRestMessageAcknowledgeRequest)
acknowledge message(s)

Parameters:
clientVersion - is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
wsRestMessageAcknowledgeRequest -
Returns:
the processed messages

findExternalSubjects

public static WsFindExternalSubjectsResults findExternalSubjects(GrouperVersion clientVersion,
                                                                 WsRestFindExternalSubjectsRequest wsRestFindExternalSubjectsRequest)
 based on an external subject query, get the external subjects
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestFindExternalSubjectsRequest - is the request body converted to an object
Returns:
the results

externalSubjectDelete

public static WsExternalSubjectDeleteResults externalSubjectDelete(GrouperVersion clientVersion,
                                                                   WsRestExternalSubjectDeleteRequest wsRestExternalSubjectDeleteRequest)
 based on a submitted object of type WsRestExternalSubjectDeleteRequest, delete the external subjects.  e.g. url:
 /v1_3_000/externalSubjects
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestExternalSubjectDeleteRequest - is the request body converted to an object
Returns:
the result

externalSubjectSave

public static WsExternalSubjectSaveResults externalSubjectSave(GrouperVersion clientVersion,
                                                               WsRestExternalSubjectSaveRequest wsRestExternalSubjectSaveRequest)
 based on a submitted object of type WsRestExternalSubjectSaveRequest, save external subjects.  e.g. url:
 /v1_3_000/externalSubjects
 

Parameters:
clientVersion - version of client, e.g. v1_3_000
wsRestExternalSubjectSaveRequest - is the request body converted to an object
Returns:
the result