Class GcHasMember
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcHasMember
class to run a has member 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 anyassignClientVersion
(String theClientVersion) assign client versionassignFieldName
(String theFieldName) assign the field name to the requestassignGroupIdIndex
(Long theGroupIdIndex) set the group id indexassignGroupName
(String theGroupName) set the group nameassignGroupUuid
(String theGroupUuid) set the group uuidassignIncludeGroupDetail
(Boolean theIncludeGroupDetail) assign if the group detail should be includedassignIncludeSubjectDetail
(Boolean theIncludeSubjectDetail) if should include subject detailassignMemberFilter
(WsMemberFilter theMemberFilter) assign the member filterassignPointInTimeFrom
(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.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.
-
Constructor Details
-
GcHasMember
public GcHasMember()
-
-
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
-
assignGroupName
set the group name- Parameters:
theGroupName
-- Returns:
- this for chaining
-
assignGroupUuid
set the group uuid- Parameters:
theGroupUuid
-- Returns:
- this for chaining
-
assignGroupIdIndex
set the group id index- Parameters:
theGroupIdIndex
-- 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
-
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
-
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
-