Class GcGetMemberships
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetMemberships
class to run a get memberships web service call
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddGroupIdIndex
(Long theGroupIdIndex) set the group id indexaddGroupName
(String theGroupName) set the group nameaddGroupUuid
(String theGroupUuid) set the group uuidaddMembershipId
(String sourceId) add a source id to filter by (or none for all sources)addOwnerNameOfAttributeDef
(String theOwnerNameOfAttributeDef) set the owner attributeDef nameaddOwnerStemName
(String theOwnerStemName) set the owner stem nameaddOwnerStemUuid
(String theOwnerStemUuid) set the owner stem uuidaddOwnerUuidOfAttributeDef
(String theOwnerUuidOfAttributeDef) set the owner attributeDef uuidadd a param to the listadd a param to the listaddSourceId
(String sourceId) add a source id to filter by (or none for all sources)addSubjectAttributeName
(String subjectAttributeName) addWsSubjectLookup
(WsSubjectLookup wsSubjectLookup) set the subject lookupassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignAscending
(Boolean theAscending) T or null for ascending, F for descending.assignAscendingForMember
(Boolean theAscendingForMember) T or null for ascending, F for descending in the members partassignClientVersion
(String theClientVersion) assign client versionassignContentType
(String theContentType) content type for post requestassignEnabled
(String theEnabled) assign A for all, T or null for enabled only, F for disabled onlyassignFieldName
(String theFieldName) assign the field name to the requestassignFieldType
(String fieldType1) fieldType is the type of field to look at, e.g.assignIncludeGroupDetail
(Boolean theIncludeGroupDetail) assign if the group detail should be includedassignIncludeSubjectDetail
(Boolean theIncludeSubjectDetail) if should include subject detailassignMemberFilter
(WsMemberFilter theMemberFilter) assign the member filterassignPageCursorFieldIncludesLastRetrieved
(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result setassignPageCursorFieldIncludesLastRetrievedForMember
(Boolean pageCursorFieldIncludesLastRetrievedForMember) should the last retrieved item be included again in the current result set for member resultsassignPageIsCursor
(Boolean pageIsCursor) T for when pagination is of cursor type.assignPageIsCursorForMember
(Boolean pageIsCursorForMember) T for when pagination is of cursor type.assignPageLastCursorField
(String pageLastCursorField) value of last cursor fieldassignPageLastCursorFieldForMember
(String pageLastCursorFieldForMember) value of last cursor field for member resultsassignPageLastCursorFieldType
(String pageLastCursorFieldType) type of last cursor field (string, int, long, date, timestamp)assignPageLastCursorFieldTypeForMember
(String pageLastCursorFieldTypeForMember) type of last cursor field (string, int, long, date, timestamp) for member resultsassignPageNumber
(Integer thePageNumber) assignPageNumberForMember
(Integer thePageNumberForMember) page number 1 indexed if paging in the members partassignPageSize
(Integer thePageSize) pageSize page size if pagingassignPageSizeForMember
(Integer thePageSizeForMember) page size if paging in the members partassignPointInTimeFrom
(Timestamp pointInTimeFrom) assignPointInTimeRetrieve
(Boolean pointInTimeRetrieve) is the query point in time retrieveassignPointInTimeTo
(Timestamp pointInTimeTo) if the query is point in time, end dateassignScope
(String theScope) assign the sql like string which filters the membershipsassignServiceLookup
(WsAttributeDefNameLookup serviceLookup1) serviceLookup if filtering by users in a service, then this is the service to look inassignServiceRole
(String serviceRole1) serviceRole to filter attributes that a user has a certain roleassignSortString
(String theSortString) must be an hql query field, e.g.assignSortStringForMember
(String theSortStringForMember) must be an hql query field, e.g.assignStemScope
(String theStemScope) assign ONE_LEVEL|ALL_IN_SUBTREE to stem scopeassignWsEndpoint
(String theWsEndpoint) endpoint to grouper WS, e.g.assignWsPass
(String theWsPass) ws passassignWsPassEncrypted
(String theWsPassEncrypted) ws passassignWsPassFile
(File theFile) ws passassignWsPassFileEncrypted
(File theFile) ws passassignWsStem
(WsStemLookup theWsStemLookup) assign stem to limit membershipsassignWsUser
(String theWsUser) ws userassigStemScope
(String theStemScope) Deprecated.use assignStemScopeexecute()
execute the call and return the results.
-
Constructor Details
-
GcGetMemberships
public GcGetMemberships()
-
-
Method Details
-
assignWsEndpoint
endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest- Parameters:
theWsEndpoint
-- Returns:
- this for chaining
-
assignWsUser
ws user- Parameters:
theWsUser
-- Returns:
- this for chaining
-
assignWsPass
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassEncrypted
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassFile
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassFileEncrypted
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignClientVersion
assign client version- Parameters:
theClientVersion
-- Returns:
- this for chaining
-
assignContentType
content type for post request- Parameters:
theContentType
-- Returns:
- this for chaining
-
assignWsStem
assign stem to limit memberships- Parameters:
theWsStemLookup
-- Returns:
- this for chaining
-
assignPageSize
pageSize page size if paging- Parameters:
thePageSize
-- Returns:
- this for chaining
-
assignPageNumber
- Parameters:
thePageNumber
-- Returns:
- this for chaining
-
assignSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
theSortString
-- Returns:
- this for chaining
-
assignAscending
T or null for ascending, F for descending.- Parameters:
theAscending
-- Returns:
- this for chaining
-
assignPageSizeForMember
page size if paging in the members part- Parameters:
thePageSizeForMember
-- Returns:
- this for chaining
-
assignPageNumberForMember
page number 1 indexed if paging in the members part- Parameters:
thePageNumberForMember
-- Returns:
- this for chaining
-
assignSortStringForMember
must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members part- Parameters:
theSortStringForMember
-- Returns:
- this for chaining
-
assignAscendingForMember
T or null for ascending, F for descending in the members part- Parameters:
theAscendingForMember
-- Returns:
- this for chaining
-
assignPageIsCursor
T for when pagination is of cursor type. F or null otherwise- Parameters:
pageIsCursor
-- Returns:
-
assignPageLastCursorField
value of last cursor field- Parameters:
pageLastCursorField
-- Returns:
-
assignPageLastCursorFieldType
type of last cursor field (string, int, long, date, timestamp)- Parameters:
pageLastCursorFieldType
-- Returns:
-
assignPageCursorFieldIncludesLastRetrieved
public GcGetMemberships assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result set- Parameters:
pageCursorFieldIncludesLastRetrieved
-- Returns:
-
assignPageIsCursorForMember
T for when pagination is of cursor type. F or null otherwise- Parameters:
pageIsCursorForMember
-- Returns:
-
assignPageLastCursorFieldForMember
value of last cursor field for member results- Parameters:
pageLastCursorFieldForMember
-- Returns:
-
assignPageLastCursorFieldTypeForMember
public GcGetMemberships assignPageLastCursorFieldTypeForMember(String pageLastCursorFieldTypeForMember) type of last cursor field (string, int, long, date, timestamp) for member results- Parameters:
pageLastCursorFieldTypeForMember
-- Returns:
-
assignPageCursorFieldIncludesLastRetrievedForMember
public GcGetMemberships assignPageCursorFieldIncludesLastRetrievedForMember(Boolean pageCursorFieldIncludesLastRetrievedForMember) should the last retrieved item be included again in the current result set for member results- Parameters:
pageCursorFieldIncludesLastRetrievedForMember
-- Returns:
-
assignPointInTimeRetrieve
is the query point in time retrieve- Parameters:
pointInTimeRetrieve
-- Returns:
-
assignPointInTimeFrom
-
assignPointInTimeTo
if the query is point in time, end date- Parameters:
pointInTimeTo
-- Returns:
-
addGroupName
set the group name- Parameters:
theGroupName
-- Returns:
- this for chaining
-
addGroupIdIndex
set the group id index- Parameters:
theGroupIdIndex
-- Returns:
- this for chaining
-
addOwnerStemName
set the owner stem name- Parameters:
theOwnerStemName
-- Returns:
- this for chaining
-
addOwnerStemUuid
set the owner stem uuid- Parameters:
theOwnerStemUuid
-- Returns:
- this for chaining
-
addOwnerNameOfAttributeDef
set the owner attributeDef name- Parameters:
theOwnerNameOfAttributeDef
-- Returns:
- this for chaining
-
addOwnerUuidOfAttributeDef
set the owner attributeDef uuid- Parameters:
theOwnerUuidOfAttributeDef
-- Returns:
- this for chaining
-
addWsSubjectLookup
set the subject lookup- Parameters:
wsSubjectLookup
-- Returns:
- this for chaining
-
addGroupUuid
set the group uuid- Parameters:
theGroupUuid
-- Returns:
- this for chaining
-
addParam
add a param to the list- Parameters:
paramName
-paramValue
-- Returns:
- this for chaining
-
addParam
add a param to the list- Parameters:
wsParam
-- Returns:
- this for chaining
-
assignMemberFilter
assign the member filter- Parameters:
theMemberFilter
-- Returns:
- this for chaining
-
assignActAsSubject
assign the act as subject if any- Parameters:
theActAsSubject
-- Returns:
- this for chaining
-
assignFieldType
fieldType is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)- Parameters:
fieldType1
-- Returns:
- this for chaining
-
assignServiceLookup
serviceLookup if filtering by users in a service, then this is the service to look in- Parameters:
serviceLookup1
-- Returns:
- this for chaining
-
assignServiceRole
serviceRole to filter attributes that a user has a certain role- Parameters:
serviceRole1
-- Returns:
- this for chaining
-
assignFieldName
assign the field name to the request- Parameters:
theFieldName
-- Returns:
- this for chaining
-
assignScope
assign the sql like string which filters the memberships- Parameters:
theScope
-- Returns:
- this for chaining
-
addSourceId
add a source id to filter by (or none for all sources)- Parameters:
sourceId
-- Returns:
- this for chaining
-
addMembershipId
add a source id to filter by (or none for all sources)- Parameters:
sourceId
-- Returns:
- this for chaining
-
addSubjectAttributeName
- Parameters:
subjectAttributeName
-- Returns:
- this for chaining
-
assignIncludeGroupDetail
assign if the group detail should be included- Parameters:
theIncludeGroupDetail
-- Returns:
- this for chaining
-
assignIncludeSubjectDetail
if should include subject detail- Parameters:
theIncludeSubjectDetail
-- Returns:
- this for chaining
-
execute
execute the call and return the results. If there is a problem calling the service, an exception will be thrown- Returns:
- the results
-
assigStemScope
Deprecated.use assignStemScopeassign ONE_LEVEL|ALL_IN_SUBTREE to stem scope- Parameters:
theStemScope
-- Returns:
- this for chaining
-
assignStemScope
assign ONE_LEVEL|ALL_IN_SUBTREE to stem scope- Parameters:
theStemScope
-- Returns:
- this for chaining
-
assignEnabled
assign A for all, T or null for enabled only, F for disabled only- Parameters:
theEnabled
-- Returns:
- this for chaining
-