Class GcGetMembers
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetMembers
class to run a get members 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 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) assignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyvoid
assignAscending
(Boolean ascending1) ascending T or null for ascending, F for descending.assignAutopage
(Boolean theAutopage) if should page through results so it doesnt timeout.assignAutopageOverlap
(Integer theAutopageOverlap) The overlap of the autopage.assignClientVersion
(String theClientVersion) assign client versionassignFieldName
(String theFieldName) assign the field name to the requestassignIncludeGroupDetail
(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 setassignPageIsCursor
(Boolean pageIsCursor) T for when pagination is of cursor type.assignPageLastCursorField
(String pageLastCursorField) value of last cursor fieldassignPageLastCursorFieldType
(String pageLastCursorFieldType) type of last cursor field (string, int, long, date, timestamp)void
assignPageNumber
(Integer pageNumber1) page number 1 indexed if pagingvoid
assignPageSize
(Integer pageSize1) page size if pagingassignPointInTimeFrom
(Timestamp pointInTimeFrom) To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.assignPointInTimeTo
(Timestamp pointInTimeTo) To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.void
assignSortString
(String sortString1) sortString must be an hql query field, e.g.assignWsEndpoint
(String theWsEndpoint) endpoint to grouper WS, e.g.assignWsPass
(String theWsPass) ws passassignWsPassEncrypted
(String theWsPassEncrypted) ws passassignWsPassFile
(File theFile) ws passassignWsPassFileEncrypted
(File theFile) ws passassignWsUser
(String theWsUser) ws userexecute()
execute the call and return the results.static void
-
Constructor Details
-
GcGetMembers
public GcGetMembers()
-
-
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
-
main
- Parameters:
args
-
-
assignAutopage
if should page through results so it doesnt timeout. Note, if pageSize is not set, will page 10k records- Parameters:
theAutopage
-- Returns:
- this for chaining
-
assignAutopageOverlap
The overlap of the autopage. Note, should at least be 1, defaults to 5% of the pageSize.- Parameters:
theAutopageOverlap
-- Returns:
- this for chaining
-
assignPageSize
page size if paging- Parameters:
pageSize1
-
-
assignPageNumber
page number 1 indexed if paging- Parameters:
pageNumber1
-
-
assignSortString
sortString must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4- Parameters:
sortString1
-
-
assignAscending
ascending T or null for ascending, F for descending.- Parameters:
ascending1
-
-
assignClientVersion
assign client version- Parameters:
theClientVersion
-- Returns:
- this for chaining
-
addGroupName
set the group name- Parameters:
theGroupName
-- Returns:
- this for chaining
-
addGroupIdIndex
set the group id index- Parameters:
theGroupIdIndex
-- 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
-
assignFieldName
assign the field name to the request- Parameters:
theFieldName
-- Returns:
- this for chaining
-
addSourceId
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
-
assignPointInTimeFrom
To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now.- Parameters:
pointInTimeFrom
-- Returns:
- this for chaining
-
assignPointInTimeTo
To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified.- Parameters:
pointInTimeTo
-- 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 GcGetMembers assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result set- Parameters:
pageCursorFieldIncludesLastRetrieved
-- Returns:
-
execute
execute the call and return the results. If there is a problem calling the service, an exception will be thrown- Returns:
- the results
-