Package edu.internet2.middleware.grouper.ui.actions

This package contains all the Struts action classes (referenced in struts-config.xml) which process user inputs and interact with the Grouper API.

See:
          Description

Class Summary
AddSavedStemAction Top level Strut's action which adds a Stem to the 'saved' list.
AddSavedSubjectAction Top level Strut's action which adds a Subject to the 'saved' list.
AssignSavedSubjectsAction Top level Strut's action which retrieves and makes available the list of saved subjects for assignment of privileges.
BrowseStemsAction Top level Strut's Action which maintains the current node (stem or group) for the different browseModes (My,Create,Manage,Join,All).
CallLoginAction Top level Strut's action which forwards to a URL which is a login screen, or which causes a login screen to be displayed due to invocation of the challenge mechanism of an external authentication scheme.
CancelFindNewMembersAction Top level Strut's action which cancels current search / browsing for new members / privilegees, and resumes browsing at the group or stem for which new members / privilegees were being sought.
CopyGroupAction  
CopyGroupToStemAction  
CopyOtherStemToStemAction  
CopyStemAction  
DeleteGroupAction Top level Strut's action which removes a group from the repository.
DeleteStemAction Top level Strut's action which removes a stem from repository.
DoAssignNewMembersAction Top level Strut's action which assigns membership / privileges for a group / stem.
DoSearchSubjectsAction Top level search for subjects - gives subject centred approach.
DoUserAuditReportAction Top level Strut's action which displays audit log entries.
EditJSPAction Top level Strut's action which launches JSP editor configured through populateDebugPrefs.
ExportMembersAction Exports Collection of members set as the request attribute 'exportMembers', in the format selected by the user.
GetDynamicTileAction Low level Strut's action which is used as a Controller for a Tile.
GrouperCapableAction Superclass for all Actions which need to do Grouper stuff.
HomeAction Top level Strut's action which forward to the home page defined in the Struts Config file.
ImportMembersAction Imports new members into a group.
JoinGroupAction Top level Strut's action which, assuming user has optin privilege, causes user to join a group.
LeaveGroupAction Top level Strut's action which, assuming user has optout privilege, removes user from members attribute of group.
LoginAction Top level Strut's action which implements default login for Basic HTTP Authentication.
LogoutAction Top level Strut's action which invalidates HttpSession and sets cookie to alllow challenge from whatever is managing authenticated access.
LowLevelGrouperCapableAction  
MenuMetaBean Information about menu
MoveGroupAction  
MoveGroupToStemAction  
MoveOtherStemToStemAction  
MoveStemAction  
Populate401Action Strut's action called on 401 error - configured through web.xml and struts-config.xml.
PopulateAddCompositeAction Top level Strut's action which does setup for adding a composite member to a group.
PopulateAllGroupsAction Top level Strut's action which does any necessary setup for initial display of AllGroups.
PopulateAssignNewMembersAction Top level Strut's action which may be called directly or indirectly (following a search).
PopulateChainAction Not currently used.
PopulateChainsAction Top level Struts Action which shows all the ways in which a member is a member of a group - used so users can follow effective memberships.
PopulateCopyGroupAction  
PopulateCopyGroupToStemAction  
PopulateCopyOtherStemToStemAction  
PopulateCopyStemAction  
PopulateCreateGroupAction Top level Strut's action which does any setup needed prior to creating a new group e.g.
PopulateCreateGroupsAction Does any setup needed for CreateGroups.
PopulateCreateStemAction Top level Strut's action which does any setup for stem creation.
PopulateDebugPrefsAction Top level Strut's action which does any setup needed prior to letting user change debug preferences.
PopulateEditGroupAction Responsible for retrieving group, identified by request parameter groupId, to make available for editing.
PopulateEditGroupAttributesAction Deal with attributes from custom types.
PopulateEditStemAction Top level Strut's action which retrieves a stem and presents it for editing.
PopulateErrorAction Top level Strut's action called on any Exception - can arise normally - or from within template.jsp.
PopulateFilterErrorAction Top level Strut's action called when ErrorFilter catches an exception

PopulateFindNewMembersAction Top level Strut's action which does any setup required for browsing / searching for new members / privilegees.
PopulateGroupAsFactorAction Top level Strut's action which retrieves and makes available Composites where this Group is a Factor.
PopulateGroupMemberAction Top level Strut's action which retrieves privileges for subject, with respect to a group or stem.
PopulateGroupMembersAction Top level Strut's action which retrieves and makes available group members.
PopulateGroupPriviligeesAction Top level Strut's action which retrieves and makes available subjects with the requested privilege.
PopulateGroupSummaryAction Top level Strut's action which retrieves and makes available a GrouperGroup object.
PopulateGroupTypesAction Top level Strut's action which makes all GroupTypes available.
PopulateHelpAction Top level Strut's action which does any setup needed to display help.
PopulateIndexAction Top level Strut's action which, if user is logged in, forwards th user to 'home' otherwise the initial screen which should have a login link.
PopulateJoinGroupsAction Top level Strut's action which does any setup required before joining groups.
PopulateListSavedStemsAction Top level Strut's action which retrieves and makes available the current list of saved subjects - which can be removed or linked to.
PopulateListSavedSubjectsAction Top level Strut's action which retrieves and makes available the current list of saved subjects - which can be removed or linked to.
PopulateManageGroupsAction Top level Strut's action which does any setup required to Manage Groups.
PopulateMoveGroupAction  
PopulateMoveGroupToStemAction  
PopulateMoveOtherStemToStemAction  
PopulateMovesCopiesLinksAction  
PopulateMoveStemAction  
PopulateMyGroupsAction Top level Strut's action which does any necessary setup for display of MyGroups (My memberships).
PopulateSearchSubjectsAction Top level Strut's action which does any necessary setup for initial display of Search Subjects -a new menu item in 0.9 which allows a Subject centric view of the repository.
PopulateStemPriviligeesAction Top level Strut's action which retrieves and makes available subjects with user-selected privilege.
PopulateSubjectSummaryAction Top level Strut's action which retrieves and makes available a Subject.
PopulateUploadTestAction Do nothing action for displaying file upload form which submits to processUploadTest
PrepareBrowsePathAction Low level Strut's action which makes list of parent stems (browsePath) for the 'browseParent' available.
PrepareFlattenAction Low level Strut's action which acts as a controller to do any necessary setup for the template which allows a browse tree to be flattened and unflattened.
PrepareGroupSearchFormAction Low level Strut's action which acts as a controller to do any necessary setup group or stem search forms.
PrepareMenuAction Controller for menu that reads files configured through the media.resources key menu.resource.files.
PrepareRepositoryBrowserStemsAction Low level Strut's action which controls browsing.
PrepareSavedStemsAction Low level Strut's action which acts as a controller to do any necessary setup for listing saved stems.
PrepareSavedSubjectsAction Low level Strut's action which acts as a controller to do any necessary setup for listing saved subjects.
PrepareStemsAction Low level Strut's action which controls browsing.
PrepareSubjectSearchFormAction Low level Strut's action which acts as a controller to do any necessary setup for the subject search.
PropogateTilesAttributesAction Low level Strut's actiopn which acts as a controller for dynamic tiles.
RemoveCompositeAction Top level Strut's action which removes a group`s Composite Member.
RemoveGroupMembersAction Top level Strut's action which removes selected, or all members, depending on user choice.
RemoveSavedStemsAction Top level Strut's action which removes specified Stems from list of saved Stems.
RemoveSavedSubjectsAction Top level Strut's action which removes specified Subjects from list of saved subjects.
SaveCompositeAction Top level Strut's action which Saves a CompositeMember for a Group.
SaveDebugPrefsAction Top level Strut's action which saves form input to the HttpSession + a file for post session retrieval.
SaveGroupAction Top level Strut's action which saves a group - creating it first if it does not exist.
SaveGroupAttributesAction Saves custom attributes.
SaveGroupMemberAction Top level Strut's action which saves privileges for a subject for a group and / or makes the subject a member of the group.
SaveStemAction Top level Strut's action which saves new / updated stem - automatically gives creator STEM / CREATE privilege.
SaveStemMemberAction Top level Strut's action which saves any changes to the Naming privileges held by a subject.
SearchGroupsAction Top level Strut's action which searches groups for current browseMode.
SearchNewMembersAction Top level search for people or groups which can be made members or privilegees of the context group.
SearchStemsAction Top level Strut's action which retrieves stems matching search criteria - restricted to those where user has CREATE privilege.
 

Package edu.internet2.middleware.grouper.ui.actions Description

This package contains all the Struts action classes (referenced in struts-config.xml) which process user inputs and interact with the Grouper API. The Javadoc for individual action classes indicates which parameters (from HttpServletRequest), attributes (from HttpServletRequest or HttpSession) and cookies, are read or written* by an action class.

Action classes which interact with the Grouper API should extend GrouperCapableAction, which gives access to an appropriate GrouperSession and various utility methods.

When customising the Grouper UI it may be necessary to change the behaviour of an existing action. This may be achieved in one of 3 ways:

  1. If there is no alternative, write a new class and override the action configuration in struts-config.xml to use the new action class. This should only be necessary if an action carries out an irreversible operation, however, consider the remaining options first.
  2. Write a new action class which is called before or after the existing action. This may be achieved by:
  3. extend the existing action class and call super.grouperExecute. This allows you to execute code before and after the original action. You must override the existing Struts configuration to associate the action with your new class.

*Request parameters are usually read-only, however, where ActionForm fields are set these are considered to have been written.