Class GcGetPermissionAssignments
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetPermissionAssignments
class to run a get permission assignments web service call
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAttributeDefIdIndex
(Long theAttributeDefIdIndex) set the attributedef id indexaddAttributeDefName
(String theAttributeDefName) set the attributedef nameaddAttributeDefNameIdIndex
(Long theAttributeDefNameIdIndex) set the attributeDefName id indexaddAttributeDefNameName
(String theAttributeDefNameName) set the attributeDefName nameaddAttributeDefNameUuid
(String theAttributeDefNameUuid) set the attributeDefName uuidaddAttributeDefUuid
(String theAttributeDefUuid) set the attributedef uuidadd a param to the listadd a param to the listaddPermissionEnvVar
(WsPermissionEnvVar wsPermissionEnvVar) limitEnvVars if processing limits, pass in a set of limits.addPermissionEnvVar
(String envVarName, String envVarValue, String envVarType) limitEnvVars if processing limits, pass in a set of limits.addRoleIdIndex
(Long theRoleIdIndex) set the role id indexaddRoleName
(String theRoleName) set the role nameaddRoleUuid
(String theRoleUuid) set the role uuidaddSubjectAttributeName
(String subjectAttributeName) addSubjectLookup
(WsSubjectLookup wsSubjectLookup) set the subject lookupassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignClientVersion
(String theClientVersion) assign client versionassignEnabled
(String theEnabled) assign A for all, T or null for enabled only, F for disabled onlyassignImmediateOnly
(boolean theImmediateOnly) T of F (defaults to F) if we should filter out non immediate permissionsassignIncludeAssignmentsOnAssignments
(Boolean theIncludeAssignmentsOnAssignments) assignIncludeAttributeAssignments
(Boolean theIncludeAttributeAssignments) T or F for it attribute assignments should be returnedassignIncludeAttributeDefNames
(Boolean theIncludeAttributeDefNames) T or F for if attributeDefName objects should be returnedassignIncludeGroupDetail
(Boolean theIncludeGroupDetail) assign if the group detail should be includedassignIncludePermissionAssignDetail
(Boolean theIncludePermissionAssignDetail) T or F for if the permission details should be returnedassignIncludeSubjectDetail
(Boolean theIncludeSubjectDetail) if should include subject detailassignPermissionProcessor
(String thePermissionProcessor) if we should find the best answer, or process limits, etc.assignPermissionType
(String thePermissionType) are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.assignPointInTimeFrom
(Timestamp pointInTimeFrom) To query permissions 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 permissions 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
-
GcGetPermissionAssignments
public GcGetPermissionAssignments()
-
-
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
-
assignImmediateOnly
T of F (defaults to F) if we should filter out non immediate permissions- Parameters:
theImmediateOnly
-- Returns:
- this for chaining
-
assignPermissionType
are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions- Parameters:
thePermissionType
-- Returns:
- this for chaining
-
assignPermissionProcessor
if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS- Parameters:
thePermissionProcessor
-- Returns:
- this for chaining
-
addPermissionEnvVar
limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50- Parameters:
wsPermissionEnvVar
-- Returns:
- this for chaining
-
addPermissionEnvVar
public GcGetPermissionAssignments addPermissionEnvVar(String envVarName, String envVarValue, String envVarType) limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50- Parameters:
envVarName
-envVarValue
-envVarType
-- Returns:
- this for chaining
-
assignPointInTimeFrom
To query permissions 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 permissions 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
-
assignIncludeAssignmentsOnAssignments
public GcGetPermissionAssignments assignIncludeAssignmentsOnAssignments(Boolean theIncludeAssignmentsOnAssignments) - Parameters:
theIncludeAssignmentsOnAssignments
-- Returns:
- this for chaining
-
addAction
- Parameters:
action
-- Returns:
- this for chaining
-
assignClientVersion
assign client version- Parameters:
theClientVersion
-- Returns:
- this for chaining
-
addRoleName
set the role name- Parameters:
theRoleName
-- Returns:
- this for chaining
-
addRoleIdIndex
set the role id index- Parameters:
theRoleIdIndex
-- Returns:
- this for chaining
-
addSubjectLookup
set the subject lookup- Parameters:
wsSubjectLookup
-- Returns:
- this for chaining
-
addRoleUuid
set the role uuid- Parameters:
theRoleUuid
-- 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
-
assignIncludeAttributeAssignments
public GcGetPermissionAssignments assignIncludeAttributeAssignments(Boolean theIncludeAttributeAssignments) T or F for it attribute assignments should be returned- Parameters:
theIncludeAttributeAssignments
-- Returns:
- this for chaining
-
assignIncludeAttributeDefNames
public GcGetPermissionAssignments assignIncludeAttributeDefNames(Boolean theIncludeAttributeDefNames) T or F for if attributeDefName objects should be returned- Parameters:
theIncludeAttributeDefNames
-- Returns:
- this for chaining
-
assignIncludePermissionAssignDetail
public GcGetPermissionAssignments assignIncludePermissionAssignDetail(Boolean theIncludePermissionAssignDetail) T or F for if the permission details should be returned- Parameters:
theIncludePermissionAssignDetail
-- 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
-
assignEnabled
assign A for all, T or null for enabled only, F for disabled only- Parameters:
theEnabled
-- Returns:
- this for chaining
-
addAttributeDefName
set the attributedef name- Parameters:
theAttributeDefName
-- Returns:
- this for chaining
-
addAttributeDefUuid
set the attributedef uuid- Parameters:
theAttributeDefUuid
-- Returns:
- this for chaining
-
addAttributeDefIdIndex
set the attributedef id index- Parameters:
theAttributeDefIdIndex
-- Returns:
- this for chaining
-
addAttributeDefNameName
set the attributeDefName name- Parameters:
theAttributeDefNameName
-- Returns:
- this for chaining
-
addAttributeDefNameUuid
set the attributeDefName uuid- Parameters:
theAttributeDefNameUuid
-- Returns:
- this for chaining
-
addAttributeDefNameIdIndex
set the attributeDefName id index- Parameters:
theAttributeDefNameIdIndex
-- Returns:
- this for chaining
-