Class GcGetAuditEntries
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetAuditEntries
class to run a get audit entries web service call
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd a param to the listadd a param to the listassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignAscending
(Boolean theAscending) ascending or null for ascending, F for descending.assignAuditActionId
(String auditActionId) audit action id eg: addGroupassignAuditType
(String auditType) audit type eg: groupassignClientVersion
(String theClientVersion) assign client versionassignFromDate
(Timestamp fromDate) from dateassignPageCursorFieldIncludesLastRetrieved
(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)assignPageSize
(Integer thePageSize) pageSize page size if pagingassignSortString
(String theSortString) sortString must be an hql query field, e.g.assignToDate
(Timestamp toDate) to dateassignWsAttributeDefLookup
(WsAttributeDefLookup theWsAttributeDefLookup) look up audit entries for this attribute defassignWsAttributeDefNameLookup
(WsAttributeDefNameLookup theWsAttributeDefNameLookup) look up audit entries for this attribute def nameassignWsEndpoint
(String theWsEndpoint) endpoint to grouper WS, e.g.assignWsGroupLookup
(WsGroupLookup theWsGroupLookup) look up audit entries for this groupassignWsPass
(String theWsPass) ws passassignWsPassEncrypted
(String theWsPassEncrypted) ws passassignWsPassFile
(File theFile) ws passassignWsPassFileEncrypted
(File theFile) ws passassignWsStemLookup
(WsStemLookup theWsStemLookup) look up audit entries for this stemassignWsSubjectLookup
(WsSubjectLookup theWsSubjectLookup) look up audit entries for this subjectassignWsUser
(String theWsUser) ws userexecute()
execute the call and return the results.static void
-
Constructor Details
-
GcGetAuditEntries
public GcGetAuditEntries()
-
-
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
-
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
-
assignActAsSubject
assign the act as subject if any- Parameters:
theActAsSubject
-- Returns:
- this for chaining
-
assignAuditType
audit type eg: group- Parameters:
theScope
-- Returns:
- this for chaining
-
assignAuditActionId
audit action id eg: addGroup- Parameters:
theScope
-- Returns:
- this for chaining
-
assignWsStemLookup
look up audit entries for this stem- Parameters:
theWsStemLookup
-- Returns:
- this for chaining
-
assignWsSubjectLookup
look up audit entries for this subject- Parameters:
theWsAttributeDefLookup
-- Returns:
- this for chaining
-
assignWsGroupLookup
look up audit entries for this group- Parameters:
theWsGroupLookup
-- Returns:
- this for chaining
-
assignWsAttributeDefLookup
look up audit entries for this attribute def- Parameters:
theWsAttributeDefLookup
-- Returns:
- this for chaining
-
assignWsAttributeDefNameLookup
public GcGetAuditEntries assignWsAttributeDefNameLookup(WsAttributeDefNameLookup theWsAttributeDefNameLookup) look up audit entries for this attribute def name- Parameters:
theWsAttributeDefNameLookup
-- Returns:
- this for chaining
-
assignPageSize
pageSize page size if paging- Parameters:
thePageSize
-- 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
-
assignFromDate
from date- Parameters:
pointInTimeFrom
-- Returns:
- this for chaining
-
assignToDate
to date- 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
-
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 GcGetAuditEntries assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result set- Parameters:
pageCursorFieldIncludesLastRetrieved
-- Returns:
-
main
- Parameters:
args
-
-