Class GcGetGroups
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetGroups
class to run a get groups web service call
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd a param to the listadd a param to the listaddSubjectAttributeName
(String subjectAttributeName) addSubjectId
(String subjectId) add a subject lookupaddSubjectIdentifier
(String subjectIdentifier) add a subject lookupaddSubjectLookup
(WsSubjectLookup wsSubjectLookup) add a subject lookupassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignAscending
(Boolean theAscending) ascending or null for ascending, F for descending.assignClientVersion
(String theClientVersion) assign client versionassignContentType
(String theContentType) content type for post requestassignEnabled
(Boolean theEnabled) enabled is null for all, true for only enabled, false for only disabledassignFieldName
(String theFieldName) assign field name, blank for default members listassignIncludeGroupDetail
(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)assignPageNumber
(Integer thePageNumber) pageNumber page number 1 indexed if pagingassignPageSize
(Integer thePageSize) pageSize 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.assignScope
(String theScope) scope is a DB pattern that will have % appended to it, or null for all.assignSortString
(String theSortString) sortString must be an hql query field, e.g.assignStemScope
(StemScope theStemScope) stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.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 passassignWsStemLookup
(WsStemLookup theWsStemLookup) is the stem to check in, or null if all.assignWsUser
(String theWsUser) ws userexecute()
execute the call and return the results.static void
-
Constructor Details
-
GcGetGroups
public GcGetGroups()
-
-
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
-
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
-
addSubjectLookup
add a subject lookup- Parameters:
wsSubjectLookup
-- Returns:
- this for chaining
-
addSubjectId
add a subject lookup- Parameters:
subjectId
-- Returns:
- this for chaining
-
addSubjectIdentifier
add a subject lookup- Parameters:
subjectIdentifier
-- Returns:
- this for chaining
-
assignFieldName
assign field name, blank for default members list- Parameters:
theFieldName
-- Returns:
- this for chaining
-
assignActAsSubject
assign the act as subject if any- Parameters:
theActAsSubject
-- Returns:
- this for chaining
-
assignScope
scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:- Parameters:
theScope
-- Returns:
- this for chaining
-
assignWsStemLookup
is the stem to check in, or null if all. If has stem, must have stemScope- Parameters:
theWsStemLookup
-- Returns:
- this for chaining
-
assignStemScope
stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem- Parameters:
theStemScope
-- Returns:
- this for chaining
-
assignEnabled
enabled is null for all, true for only enabled, false for only disabled- Parameters:
theEnabled
-- Returns:
- this for chaining
-
assignPageSize
pageSize page size if paging- Parameters:
thePageSize
-- Returns:
- this for chaining
-
assignPageNumber
pageNumber page number 1 indexed if paging- Parameters:
thePageNumber
-- Returns:
- this for chaining
-
assignSortString
sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
theSortString
-- Returns:
- this for chaining
-
assignAscending
ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string- Parameters:
theAscending
-- 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
-
execute
execute the call and return the results. If there is a problem calling the service, an exception will be thrown- Returns:
- the results
-
assignMemberFilter
assign the member filter- Parameters:
theMemberFilter
-- 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 GcGetGroups assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result set- Parameters:
pageCursorFieldIncludesLastRetrieved
-- Returns:
-
main
- Parameters:
args
-
-