edu.internet2.middleware.grouperClient.ws.beans
Class WsRestGetPermissionAssignmentsLiteRequest

java.lang.Object
  extended by edu.internet2.middleware.grouperClient.ws.beans.WsRestGetPermissionAssignmentsLiteRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestGetPermissionAssignmentsLiteRequest
extends Object
implements WsRequestBean

Bean for rest request to get permissions lite


Constructor Summary
WsRestGetPermissionAssignmentsLiteRequest()
           
 
Method Summary
 String getActAsSubjectId()
          if acting as another user
 String getActAsSubjectIdentifier()
          if acting as another user
 String getActAsSubjectSourceId()
          if acting as another user
 String getAction()
          action to query, or none to query all actions
 String getClientVersion()
          is the version of the client.
 String getEnabled()
          is A for all, T or null for enabled only, F for disabled
 String getImmediateOnly()
          immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
 String getIncludeAssignmentsOnAssignments()
          if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
 String getIncludeAttributeAssignments()
          T or F for it attribute assignments should be returned
 String getIncludeAttributeDefNames()
          T or F for if attributeDefName objects should be returned
 String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 String getIncludeLimits()
          includeLimits T or F (default to F) for if limits should be returned with the results.
 String getIncludePermissionAssignDetail()
          T or F for if the permission details should be returned
 String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 String getLimitEnvVarName0()
          first env var name limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getLimitEnvVarName1()
          second env var name limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getLimitEnvVarType0()
          first env var type limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getLimitEnvVarType1()
          second env var type limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getLimitEnvVarValue0()
          first env var value limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getLimitEnvVarValue1()
          second env var value limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 String getParamName0()
          reserved for future use
 String getParamName1()
          reserved for future use
 String getParamValue0()
          reserved for future use
 String getParamValue1()
          reserved for future use
 String getPermissionProcessor()
          if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set).
 String getPermissionType()
          are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
 String getPointInTimeFrom()
          To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
 String getPointInTimeTo()
          To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
 String getRoleId()
          is role to look in
 String getRoleName()
          is role to look in
 String getSubjectAttributeNames()
          are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent
 String getWsAttributeDefId()
          find assignments in this attribute def (optional)
 String getWsAttributeDefName()
          find assignments in this attribute def (optional)
 String getWsAttributeDefNameId()
          find assignments in this attribute def name (optional)
 String getWsAttributeDefNameName()
          find assignments in this attribute def name (optional)
 String getWsSubjectId()
          is subject to look in
 String getWsSubjectIdentifier()
          is subject to look in
 String getWsSubjectSourceId()
          is subject to look in
 void setActAsSubjectId(String actAsSubjectId1)
          if acting as another user
 void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
          if acting as another user
 void setActAsSubjectSourceId(String actAsSubjectSourceId1)
          if acting as another user
 void setAction(String action1)
          action to query, or none to query all actions
 void setClientVersion(String clientVersion1)
          is the version of the client.
 void setEnabled(String enabled1)
          is A for all, T or null for enabled only, F for disabled
 void setImmediateOnly(String immediateOnly1)
          immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
 void setIncludeAssignmentsOnAssignments(String includeAssignmentsOnAssignments1)
          if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
 void setIncludeAttributeAssignments(String includeAttributeAssignments1)
          T or F for it attribute assignments should be returned
 void setIncludeAttributeDefNames(String includeAttributeDefNames1)
          T or F for if attributeDefName objects should be returned
 void setIncludeGroupDetail(String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void setIncludeLimits(String includeLimits1)
          includeLimits T or F (default to F) for if limits should be returned with the results.
 void setIncludePermissionAssignDetail(String includePermissionAssignDetail1)
          T or F for if the permission details should be returned
 void setIncludeSubjectDetail(String includeSubjectDetail1)
          T|F, for if the extended subject information should be returned (anything more than just the id)
 void setLimitEnvVarName0(String _limitEnvVarName0)
          first env var name limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 void setLimitEnvVarName1(String _limitEnvVarName1)
          second env var name limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 void setLimitEnvVarType0(String _limitEnvVarType0)
          first env var type limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 void setLimitEnvVarType1(String _limitEnvVarType1)
          second env var type limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 void setLimitEnvVarValue0(String _limitEnvVarValue0)
          first env var value limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
 void setLimitEnvVarValue1(String _limitEnvVarValue1)
           
 void setParamName0(String _paramName0)
          reserved for future use
 void setParamName1(String _paramName1)
          reserved for future use
 void setParamValue0(String _paramValue0)
          reserved for future use
 void setParamValue1(String _paramValue1)
          reserved for future use
 void setPermissionProcessor(String permissionProcessor1)
          if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set).
 void setPermissionType(String permissionType1)
          are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
 void setPointInTimeFrom(String pointInTimeFrom1)
          To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
 void setPointInTimeTo(String pointInTimeTo1)
          To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
 void setRoleId(String wsOwnerGroupId1)
          is role to look in
 void setRoleName(String wsOwnerGroupName1)
          is role to look in
 void setSubjectAttributeNames(String subjectAttributeNames1)
          are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent
 void setWsAttributeDefId(String wsAttributeDefId1)
          find assignments in this attribute def (optional)
 void setWsAttributeDefName(String wsAttributeDefName1)
          find assignments in this attribute def (optional)
 void setWsAttributeDefNameId(String wsAttributeDefNameId1)
          find assignments in this attribute def name (optional)
 void setWsAttributeDefNameName(String wsAttributeDefNameName1)
          find assignments in this attribute def name (optional)
 void setWsSubjectId(String wsOwnerSubjectId1)
          is subject to look in
 void setWsSubjectIdentifier(String wsOwnerSubjectIdentifier1)
          is subject to look in
 void setWsSubjectSourceId(String wsOwnerSubjectSourceId1)
          is subject to look in
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestGetPermissionAssignmentsLiteRequest

public WsRestGetPermissionAssignmentsLiteRequest()
Method Detail

getIncludeLimits

public String getIncludeLimits()
includeLimits T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists

Returns:
the includeLimits

setIncludeLimits

public void setIncludeLimits(String includeLimits1)
includeLimits T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists

Parameters:
includeLimits1 - the includeLimits to set

getImmediateOnly

public String getImmediateOnly()
immediateOnly T of F (defaults to F) if we should filter out non immediate permissions

Returns:
the immediateOnly

setImmediateOnly

public void setImmediateOnly(String immediateOnly1)
immediateOnly T of F (defaults to F) if we should filter out non immediate permissions

Parameters:
immediateOnly1 - the immediateOnly to set

getPermissionType

public String getPermissionType()
are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions

Returns:
the permissionType

setPermissionType

public void setPermissionType(String permissionType1)
are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions

Parameters:
permissionType1 - the permissionType to set

getLimitEnvVarName0

public String getLimitEnvVarName0()
first env var name limitEnvVars 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

Returns:
the limitEnvVarName0

setLimitEnvVarName0

public void setLimitEnvVarName0(String _limitEnvVarName0)
first env var name limitEnvVars 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:
_limitEnvVarName0 - the limitEnvVarName0 to set

getLimitEnvVarValue0

public String getLimitEnvVarValue0()
first env var value limitEnvVars 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

Returns:
the limitEnvVarValue0

setLimitEnvVarValue0

public void setLimitEnvVarValue0(String _limitEnvVarValue0)
first env var value limitEnvVars 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:
_limitEnvVarValue0 - the limitEnvVarValue0 to set

getLimitEnvVarName1

public String getLimitEnvVarName1()
second env var name limitEnvVars 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

Returns:
the limitEnvVarName1

setLimitEnvVarName1

public void setLimitEnvVarName1(String _limitEnvVarName1)
second env var name limitEnvVars 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:
_limitEnvVarName1 - the limitEnvVarName1 to set

getLimitEnvVarType0

public String getLimitEnvVarType0()
first env var type limitEnvVars 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

Returns:
the limitEnvVarType0

setLimitEnvVarType0

public void setLimitEnvVarType0(String _limitEnvVarType0)
first env var type limitEnvVars 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:
_limitEnvVarType0 - the limitEnvVarType0 to set

getLimitEnvVarValue1

public String getLimitEnvVarValue1()
second env var value limitEnvVars 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

Returns:
the limitEnvVarValue1

setLimitEnvVarValue1

public void setLimitEnvVarValue1(String _limitEnvVarValue1)
Parameters:
_limitEnvVarValue1 - the limitEnvVarValue1 to set

getLimitEnvVarType1

public String getLimitEnvVarType1()
second env var type limitEnvVars 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

Returns:
the limitEnvVarType1

setLimitEnvVarType1

public void setLimitEnvVarType1(String _limitEnvVarType1)
second env var type limitEnvVars 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:
_limitEnvVarType1 - the limitEnvVarType1 to set

getPermissionProcessor

public String getPermissionProcessor()
if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set). This is the PermissionProcessor enum. e.g. FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS. If null, then just get all permissions and process on the client.

Returns:
processor

setPermissionProcessor

public void setPermissionProcessor(String permissionProcessor1)
if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set). This is the PermissionProcessor enum. e.g. FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS. If null, then just get all permissions and process on the client.

Parameters:
permissionProcessor1 -

getClientVersion

public String getClientVersion()
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Returns:
client version

setClientVersion

public void setClientVersion(String clientVersion1)
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Parameters:
clientVersion1 -

getWsAttributeDefName

public String getWsAttributeDefName()
find assignments in this attribute def (optional)

Returns:
attribute def name

setWsAttributeDefName

public void setWsAttributeDefName(String wsAttributeDefName1)
find assignments in this attribute def (optional)

Parameters:
wsAttributeDefName1 -

getWsAttributeDefId

public String getWsAttributeDefId()
find assignments in this attribute def (optional)

Returns:
attribute def

setWsAttributeDefId

public void setWsAttributeDefId(String wsAttributeDefId1)
find assignments in this attribute def (optional)

Parameters:
wsAttributeDefId1 -

getWsAttributeDefNameName

public String getWsAttributeDefNameName()
find assignments in this attribute def name (optional)

Returns:
attribute def name name

setWsAttributeDefNameName

public void setWsAttributeDefNameName(String wsAttributeDefNameName1)
find assignments in this attribute def name (optional)

Parameters:
wsAttributeDefNameName1 -

getWsAttributeDefNameId

public String getWsAttributeDefNameId()
find assignments in this attribute def name (optional)

Returns:
attribute def name id

setWsAttributeDefNameId

public void setWsAttributeDefNameId(String wsAttributeDefNameId1)
find assignments in this attribute def name (optional)

Parameters:
wsAttributeDefNameId1 -

getRoleName

public String getRoleName()
is role to look in

Returns:
group name

setRoleName

public void setRoleName(String wsOwnerGroupName1)
is role to look in

Parameters:
wsOwnerGroupName1 -

getRoleId

public String getRoleId()
is role to look in

Returns:
group id

setRoleId

public void setRoleId(String wsOwnerGroupId1)
is role to look in

Parameters:
wsOwnerGroupId1 -

getWsSubjectId

public String getWsSubjectId()
is subject to look in

Returns:
subject

setWsSubjectId

public void setWsSubjectId(String wsOwnerSubjectId1)
is subject to look in

Parameters:
wsOwnerSubjectId1 -

getWsSubjectSourceId

public String getWsSubjectSourceId()
is subject to look in

Returns:
subject

setWsSubjectSourceId

public void setWsSubjectSourceId(String wsOwnerSubjectSourceId1)
is subject to look in

Parameters:
wsOwnerSubjectSourceId1 -

getWsSubjectIdentifier

public String getWsSubjectIdentifier()
is subject to look in

Returns:
subject

setWsSubjectIdentifier

public void setWsSubjectIdentifier(String wsOwnerSubjectIdentifier1)
is subject to look in

Parameters:
wsOwnerSubjectIdentifier1 -

getAction

public String getAction()
action to query, or none to query all actions

Returns:
action

setAction

public void setAction(String action1)
action to query, or none to query all actions

Parameters:
action1 -

getIncludeAssignmentsOnAssignments

public String getIncludeAssignmentsOnAssignments()
if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.

Returns:
include assignment

setIncludeAssignmentsOnAssignments

public void setIncludeAssignmentsOnAssignments(String includeAssignmentsOnAssignments1)
if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.

Parameters:
includeAssignmentsOnAssignments1 -

getActAsSubjectId

public String getActAsSubjectId()
if acting as another user

Returns:
id

setActAsSubjectId

public void setActAsSubjectId(String actAsSubjectId1)
if acting as another user

Parameters:
actAsSubjectId1 -

getActAsSubjectSourceId

public String getActAsSubjectSourceId()
if acting as another user

Returns:
source id

setActAsSubjectSourceId

public void setActAsSubjectSourceId(String actAsSubjectSourceId1)
if acting as another user

Parameters:
actAsSubjectSourceId1 -

getActAsSubjectIdentifier

public String getActAsSubjectIdentifier()
if acting as another user

Returns:
subject identifier

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
if acting as another user

Parameters:
actAsSubjectIdentifier1 -

getIncludeSubjectDetail

public String getIncludeSubjectDetail()
T|F, for if the extended subject information should be returned (anything more than just the id)

Returns:
T|F

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)
T|F, for if the extended subject information should be returned (anything more than just the id)

Parameters:
includeSubjectDetail1 -

getSubjectAttributeNames

public String getSubjectAttributeNames()
are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent

Returns:
subject attribute names

setSubjectAttributeNames

public void setSubjectAttributeNames(String subjectAttributeNames1)
are the additional subject attributes (data) to return (comma separated) If blank, whatever is configured in the grouper-ws.properties will be sent

Parameters:
subjectAttributeNames1 -

getIncludeGroupDetail

public String getIncludeGroupDetail()
T or F as to if the group detail should be returned

Returns:
T|F

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)
T or F as to if the group detail should be returned

Parameters:
includeGroupDetail1 -

getParamName0

public String getParamName0()
reserved for future use

Returns:
param name 0

setParamName0

public void setParamName0(String _paramName0)
reserved for future use

Parameters:
_paramName0 -

getParamValue0

public String getParamValue0()
reserved for future use

Returns:
param value 0

setParamValue0

public void setParamValue0(String _paramValue0)
reserved for future use

Parameters:
_paramValue0 -

getParamName1

public String getParamName1()
reserved for future use

Returns:
paramname1

setParamName1

public void setParamName1(String _paramName1)
reserved for future use

Parameters:
_paramName1 -

getParamValue1

public String getParamValue1()
reserved for future use

Returns:
param value 1

setParamValue1

public void setParamValue1(String _paramValue1)
reserved for future use

Parameters:
_paramValue1 -

getEnabled

public String getEnabled()
is A for all, T or null for enabled only, F for disabled

Returns:
enabled

setEnabled

public void setEnabled(String enabled1)
is A for all, T or null for enabled only, F for disabled

Parameters:
enabled1 -

getIncludeAttributeAssignments

public String getIncludeAttributeAssignments()
T or F for it attribute assignments should be returned

Returns:
include attribute assignments

getIncludeAttributeDefNames

public String getIncludeAttributeDefNames()
T or F for if attributeDefName objects should be returned

Returns:
the attributeDefName

getIncludePermissionAssignDetail

public String getIncludePermissionAssignDetail()
T or F for if the permission details should be returned

Returns:
T or F

setIncludeAttributeAssignments

public void setIncludeAttributeAssignments(String includeAttributeAssignments1)
T or F for it attribute assignments should be returned

Parameters:
includeAttributeAssignments1 -

setIncludeAttributeDefNames

public void setIncludeAttributeDefNames(String includeAttributeDefNames1)
T or F for if attributeDefName objects should be returned

Parameters:
includeAttributeDefNames1 -

setIncludePermissionAssignDetail

public void setIncludePermissionAssignDetail(String includePermissionAssignDetail1)
T or F for if the permission details should be returned

Parameters:
includePermissionAssignDetail1 -

getPointInTimeFrom

public String getPointInTimeFrom()
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. Format: yyyy/MM/dd HH:mm:ss.SSS

Returns:
the pointInTimeFrom

setPointInTimeFrom

public void setPointInTimeFrom(String pointInTimeFrom1)
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. Format: yyyy/MM/dd HH:mm:ss.SSS

Parameters:
pointInTimeFrom1 - the pointInTimeFrom to set

getPointInTimeTo

public String getPointInTimeTo()
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. Format: yyyy/MM/dd HH:mm:ss.SSS

Returns:
the pointInTimeTo

setPointInTimeTo

public void setPointInTimeTo(String pointInTimeTo1)
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. Format: yyyy/MM/dd HH:mm:ss.SSS

Parameters:
pointInTimeTo1 - the pointInTimeTo to set