edu.internet2.middleware.grouper.ws.rest.permission
Class WsRestAssignPermissionsRequest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.permission.WsRestAssignPermissionsRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestAssignPermissionsRequest
extends java.lang.Object
implements WsRequestBean

request bean in body of rest request


Constructor Summary
WsRestAssignPermissionsRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
          if acting as someone else
 java.lang.String[] getActions()
          actions to query, or none to query all actions
 java.lang.String[] getActionsToReplace()
          if replacing attributeDefNames, then these are the related actions, if blank, then just do all
 java.lang.String getAssignmentDisabledTime()
          disabled time, or null for not disabled
 java.lang.String getAssignmentEnabledTime()
          enabled time, or null for enabled now
 java.lang.String getAssignmentNotes()
          notes on the assignment (optional)
 WsAttributeDefLookup[] getAttributeDefsToReplace()
          if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
 java.lang.String getClientVersion()
          is the version of the client.
 java.lang.String getDelegatable()
          really only for permissions, if the assignee can delegate to someone else.
 java.lang.String getDisallowed()
          T or F (defaults to F), if this permission assignment is disallowed
 java.lang.String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 java.lang.String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 WsParam[] getParams()
          optional: reserved for future use
 java.lang.String getPermissionAssignOperation()
          operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission
 WsAttributeDefNameLookup[] getPermissionDefNameLookups()
          find assignments in these attribute def names (optional)
 java.lang.String getPermissionType()
          is role or role_subject from the PermissionType enum
 WsGroupLookup[] getRoleLookups()
          roleLookups are roles to look in
 java.lang.String[] getSubjectAttributeNames()
          are the additional subject attributes (data) to return.
 WsMembershipAnyLookup[] getSubjectRoleLookups()
          to query attributes in "any" memberships which are on immediate or effective memberships
 WsAttributeAssignLookup[] getWsAttributeAssignLookups()
          if you know the assign ids you want, put them here
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
          if acting as someone else
 void setActions(java.lang.String[] actions1)
          actions to query, or none to query all actions
 void setActionsToReplace(java.lang.String[] actionsToReplace1)
          if replacing attributeDefNames, then these are the related actions, if blank, then just do all
 void setAssignmentDisabledTime(java.lang.String assignmentDisabledTime1)
          disabled time, or null for not disabled
 void setAssignmentEnabledTime(java.lang.String assignmentEnabledTime1)
          enabled time, or null for enabled now
 void setAssignmentNotes(java.lang.String assignmentNotes1)
          notes on the assignment (optional)
 void setAttributeDefsToReplace(WsAttributeDefLookup[] attributeDefsToReplace1)
          if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
 void setClientVersion(java.lang.String clientVersion1)
          is the version of the client.
 void setDelegatable(java.lang.String delegatable1)
          really only for permissions, if the assignee can delegate to someone else.
 void setDisallowed(java.lang.String disallowed1)
          T or F (defaults to F), if this permission assignment is disallowed
 void setIncludeGroupDetail(java.lang.String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
          T|F, for if the extended subject information should be returned (anything more than just the id)
 void setParams(WsParam[] params1)
          optional: reserved for future use
 void setPermissionAssignOperation(java.lang.String attributeAssignOperation1)
          operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission
 void setPermissionDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
          find assignments in these attribute def names (optional)
 void setPermissionType(java.lang.String attributeAssignType1)
          is role or role_subject from the PermissionType enum
 void setRoleLookups(WsGroupLookup[] roleLookups1)
          roleLookups are roles to look in
 void setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)
          are the additional subject attributes (data) to return.
 void setSubjectRoleLookups(WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups1)
          to query attributes in "any" memberships which are on immediate or effective memberships
 void setWsAttributeAssignLookups(WsAttributeAssignLookup[] wsAttributeAssignLookups1)
          if you know the assign ids you want, put them here
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestAssignPermissionsRequest

public WsRestAssignPermissionsRequest()
Method Detail

getDisallowed

public java.lang.String getDisallowed()
T or F (defaults to F), if this permission assignment is disallowed

Returns:
T or F (defaults to F), if this permission assignment is disallowed

setDisallowed

public void setDisallowed(java.lang.String disallowed1)
T or F (defaults to F), if this permission assignment is disallowed

Parameters:
disallowed1 -

getAssignmentNotes

public java.lang.String getAssignmentNotes()
notes on the assignment (optional)

Returns:
notes

setAssignmentNotes

public void setAssignmentNotes(java.lang.String assignmentNotes1)
notes on the assignment (optional)

Parameters:
assignmentNotes1 -

getAssignmentEnabledTime

public java.lang.String getAssignmentEnabledTime()
enabled time, or null for enabled now

Returns:
enabled time

setAssignmentEnabledTime

public void setAssignmentEnabledTime(java.lang.String assignmentEnabledTime1)
enabled time, or null for enabled now

Parameters:
assignmentEnabledTime1 -

getAssignmentDisabledTime

public java.lang.String getAssignmentDisabledTime()
disabled time, or null for not disabled

Returns:
disabled time

setAssignmentDisabledTime

public void setAssignmentDisabledTime(java.lang.String assignmentDisabledTime1)
disabled time, or null for not disabled

Parameters:
assignmentDisabledTime1 -

getDelegatable

public java.lang.String getDelegatable()
really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT

Returns:
delegatable

setDelegatable

public void setDelegatable(java.lang.String delegatable1)
really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT

Parameters:
delegatable1 -

getPermissionAssignOperation

public java.lang.String getPermissionAssignOperation()
operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission

Returns:
operation

setPermissionAssignOperation

public void setPermissionAssignOperation(java.lang.String attributeAssignOperation1)
operation to perform for permission on role or subject, from enum PermissionAssignOperation assign_permission, remove_permission

Parameters:
attributeAssignOperation1 -

retrieveRestHttpMethod

public GrouperRestHttpMethod retrieveRestHttpMethod()
Description copied from interface: WsRequestBean
see which http method this is supposed to be associated with, and override whatever was passed in

Specified by:
retrieveRestHttpMethod in interface WsRequestBean
Returns:
the method
See Also:
WsRequestBean.retrieveRestHttpMethod()

getClientVersion

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

Returns:
version

setClientVersion

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

Parameters:
clientVersion1 -

getPermissionType

public java.lang.String getPermissionType()
is role or role_subject from the PermissionType enum

Returns:
attribute assign type

setPermissionType

public void setPermissionType(java.lang.String attributeAssignType1)
is role or role_subject from the PermissionType enum

Parameters:
attributeAssignType1 -

getWsAttributeAssignLookups

public WsAttributeAssignLookup[] getWsAttributeAssignLookups()
if you know the assign ids you want, put them here

Returns:
attribute assign lookups

setWsAttributeAssignLookups

public void setWsAttributeAssignLookups(WsAttributeAssignLookup[] wsAttributeAssignLookups1)
if you know the assign ids you want, put them here

Parameters:
wsAttributeAssignLookups1 -

getPermissionDefNameLookups

public WsAttributeDefNameLookup[] getPermissionDefNameLookups()
find assignments in these attribute def names (optional)

Returns:
def name lookups

setPermissionDefNameLookups

public void setPermissionDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
find assignments in these attribute def names (optional)

Parameters:
wsAttributeDefNameLookups1 -

getRoleLookups

public WsGroupLookup[] getRoleLookups()
roleLookups are roles to look in

Returns:
role lookups

setRoleLookups

public void setRoleLookups(WsGroupLookup[] roleLookups1)
roleLookups are roles to look in

Parameters:
roleLookups1 -

getSubjectRoleLookups

public WsMembershipAnyLookup[] getSubjectRoleLookups()
to query attributes in "any" memberships which are on immediate or effective memberships

Returns:
any memberships

setSubjectRoleLookups

public void setSubjectRoleLookups(WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups1)
to query attributes in "any" memberships which are on immediate or effective memberships

Parameters:
wsOwnerMembershipAnyLookups1 -

getActions

public java.lang.String[] getActions()
actions to query, or none to query all actions

Returns:
actions

setActions

public void setActions(java.lang.String[] actions1)
actions to query, or none to query all actions

Parameters:
actions1 -

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()
if acting as someone else

Returns:
act as subject

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
if acting as someone else

Parameters:
actAsSubjectLookup1 -

getIncludeSubjectDetail

public java.lang.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(java.lang.String includeSubjectDetail1)
T|F, for if the extended subject information should be returned (anything more than just the id)

Parameters:
includeSubjectDetail1 -

getSubjectAttributeNames

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

Returns:
subject attribute names

setSubjectAttributeNames

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

Parameters:
subjectAttributeNames1 -

getIncludeGroupDetail

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

Returns:
T|F

setIncludeGroupDetail

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

Parameters:
includeGroupDetail1 -

getParams

public WsParam[] getParams()
optional: reserved for future use

Returns:
params

setParams

public void setParams(WsParam[] params1)
optional: reserved for future use

Parameters:
params1 -

getActionsToReplace

public java.lang.String[] getActionsToReplace()
if replacing attributeDefNames, then these are the related actions, if blank, then just do all

Returns:
the actionsToReplace

getAttributeDefsToReplace

public WsAttributeDefLookup[] getAttributeDefsToReplace()
if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all

Returns:
the attributeDefsToReplace

setActionsToReplace

public void setActionsToReplace(java.lang.String[] actionsToReplace1)
if replacing attributeDefNames, then these are the related actions, if blank, then just do all

Parameters:
actionsToReplace1 - the actionsToReplace to set

setAttributeDefsToReplace

public void setAttributeDefsToReplace(WsAttributeDefLookup[] attributeDefsToReplace1)
if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all

Parameters:
attributeDefsToReplace1 - the attributeDefsToReplace to set