org.sakaiproject.tool.admin
Class RealmsAction

java.lang.Object
  extended byjavax.servlet.GenericServlet
      extended byjavax.servlet.http.HttpServlet
          extended byorg.sakaiproject.vm.ComponentServlet
              extended byorg.sakaiproject.vm.VmServlet
                  extended byorg.sakaiproject.cheftool.VmServlet
                      extended byorg.sakaiproject.cheftool.ToolServlet
                          extended byorg.sakaiproject.cheftool.VelocityPortletPaneledAction
                              extended byorg.sakaiproject.cheftool.PagedResourceActionII
                                  extended byorg.sakaiproject.tool.admin.RealmsAction
All Implemented Interfaces:
Serializable, Servlet, ServletConfig

public class RealmsAction
extends PagedResourceActionII

RealmsAction is the CHEF realms editor.

Version:
$Revision: 6825 $
Author:
University of Michigan, CHEF Software Development Team
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
VelocityPortletPaneledAction.MyLogger
 
Field Summary
 
Fields inherited from class org.sakaiproject.cheftool.PagedResourceActionII
DEFAULT_PAGE_SIZE, FORM_PAGE_NUMBER, FORM_SEARCH, PAGESIZES, PARAM_PAGESIZE, rb_praII, STATE_CURRENT_PAGE, STATE_FIRST_PAGE_EXISTS, STATE_GO_FIRST_PAGE, STATE_GO_LAST_PAGE, STATE_GO_NEXT, STATE_GO_NEXT_PAGE, STATE_GO_PREV, STATE_GO_PREV_PAGE, STATE_GOTO_PAGE, STATE_LAST_PAGE_EXISTS, STATE_MANUAL_REFRESH, STATE_NEXT_EXISTS, STATE_NEXT_PAGE_EXISTS, STATE_NUM_MESSAGES, STATE_PAGESIZE, STATE_PREV_EXISTS, STATE_PREV_PAGE_EXISTS, STATE_SEARCH, STATE_TOP_PAGE_MESSAGE, STATE_TOTAL_PAGENUMBER, STATE_VIEW_ID
 
Fields inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
ATTR_CONFIG, ATTR_CONTEXT, ATTR_FRAME_FOCUS, ATTR_FRAME_REFRESH, ATTR_PORTLET, ATTR_RUNDATA, ATTR_TOP_REFRESH, BUTTON, CONTEXT_SITE_COLLECTION_ID, CONTEXT_SITE_COLLECTION_URL, LAYOUT_MAIN, Log, MODE_OPTIONS, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL
 
Fields inherited from class org.sakaiproject.cheftool.ToolServlet
ALERT_ATTR, ALERT_STATE_INITED, MENU_ATTR, PARAM_ACTION, PARAM_ACTION_COMBO, TITLE_PANEL, TOOL_MODE_ATTR, TOOL_MODE_DEFAULT
 
Fields inherited from class org.sakaiproject.cheftool.VmServlet
m_validator
 
Fields inherited from class org.sakaiproject.vm.ComponentServlet
ATTR_PARAMS
 
Constructor Summary
RealmsAction()
           
 
Method Summary
 String buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context
 void doCancel_remove(RunData data, Context context)
          doCancel_remove called when "eventSubmit_doCancel_remove" is in the request parameters to cancel realm removal
 void doCancel_role_saveas(RunData data, Context context)
          Handle a request to cancel role saveas.
 void doCancel_saveas(RunData data, Context context)
          cancel the saveas request, return to edit
 void doCancel(RunData data, Context context)
          doCancel called when "eventSubmit_doCancel" is in the request parameters to cancel realm edits
 void doDone_role(RunData data, Context context)
          Handle a request to be done role editing - return to the edit mode.
 void doDone_user(RunData data, Context context)
          Handle a request to be done user editing - return to the edit mode.
 void doEdit_role(RunData data, Context context)
          Edit an existing page.
 void doEdit_user(RunData data, Context context)
          Edit an existing user ability grant.
 void doEdit(RunData data, Context context)
          Handle a request to edit a realm.
 void doNew_role(RunData data, Context context)
          Handle a request to create a new role in the realm edit.
 void doNew_user(RunData data, Context context)
          create a new user ability grant in the realm edit.
 void doNew(RunData data, Context context)
          Handle a request for a new realm.
 void doRemove_confirmed(RunData data, Context context)
          doRemove_confirmed called when "eventSubmit_doRemove_confirmed" is in the request parameters to remove the realm
 void doRemove_role(RunData data, Context context)
          Handle a request to remove the role being edited.
 void doRemove_user(RunData data, Context context)
          Handle a request to remove all grants to the user.
 void doRemove(RunData data, Context context)
          doRemove called when "eventSubmit_doRemove" is in the request parameters to confirm removal of the realm
 void doSave_edit(RunData data, Context context)
          Handle a request to save the edit from either page or tools list mode - no form to read in.
 void doSave_role_as(RunData data, Context context)
          Handle a request to saveas with this name.
 void doSave_role(RunData data, Context context)
          Handle a request to save the realm edit (from the role edit form).
 void doSave_user(RunData data, Context context)
          Handle a request to save the realm edit (from the user edit form).
 void doSave(RunData data, Context context)
          Handle a request to save the realm edit (from the realm edit form).
 void doSaveas_request(RunData data, Context context)
          Go into saveas mode
 void doSaveas_role(RunData data, Context context)
          Handle a request to remove the role being edited.
 void doSaveas(RunData data, Context context)
          Handle a request to save-as the realm as a new realm.
protected  void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
          Populate the state object, if needed.
protected  List readResourcesPage(SessionState state, int first, int last)
          Implement this to return a list of all the resources in this record range, with search and sorting applied.
protected  int sizeResources(SessionState state)
          Implement this to return the number of records that are currently selected.
 
Methods inherited from class org.sakaiproject.cheftool.PagedResourceActionII
addListPagingMenus, addRefreshMenus, addSearchMenus, addViewPagingMenus, cleanStatePaging, doAuto, doChange_pagesize, doList_first, doList_last, doList_next, doList_prev, doRefresh, doSearch_clear, doSearch, doView_next, doView_page, doView_prev, enableObserver, pagingInfoToContext, prepPage, resetPaging, totalPageNumber
 
Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
actionDispatch, addAlert, addOptionsMenu, cancelOptions, clientWindowId, disableObservers, doGet, doOptions, doReset, enableObservers, getContext, helperActionDispatch, initState, justDelivered, mainPanelUpdateId, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, titlePanelUpdateId, toolModeDispatch, updateState
 
Methods inherited from class org.sakaiproject.cheftool.ToolServlet
doPost, getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, setToolMode
 
Methods inherited from class org.sakaiproject.vm.VmServlet
getActionURL, getVmReference, includeVm, setVmReference
 
Methods inherited from class org.sakaiproject.vm.ComponentServlet
sendParentRedirect, service, setNoCacheHeaders
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RealmsAction

public RealmsAction()
Method Detail

readResourcesPage

protected List readResourcesPage(SessionState state,
                                 int first,
                                 int last)
Implement this to return a list of all the resources in this record range, with search and sorting applied.

Specified by:
readResourcesPage in class PagedResourceActionII
Parameters:
first - The first record to include (1 based).
last - The last record to include (inclusive, 1 based).

sizeResources

protected int sizeResources(SessionState state)
Implement this to return the number of records that are currently selected.

Specified by:
sizeResources in class PagedResourceActionII

initState

protected void initState(SessionState state,
                         VelocityPortlet portlet,
                         JetspeedRunData rundata)
Populate the state object, if needed.

Overrides:
initState in class PagedResourceActionII

buildMainPanelContext

public String buildMainPanelContext(VelocityPortlet portlet,
                                    Context context,
                                    RunData rundata,
                                    SessionState state)
build the context


doSaveas

public void doSaveas(RunData data,
                     Context context)
Handle a request to save-as the realm as a new realm.


doCancel_saveas

public void doCancel_saveas(RunData data,
                            Context context)
cancel the saveas request, return to edit


doSaveas_request

public void doSaveas_request(RunData data,
                             Context context)
Go into saveas mode


doNew

public void doNew(RunData data,
                  Context context)
Handle a request for a new realm.


doEdit

public void doEdit(RunData data,
                   Context context)
Handle a request to edit a realm.


doSave

public void doSave(RunData data,
                   Context context)
Handle a request to save the realm edit (from the realm edit form).


doSave_edit

public void doSave_edit(RunData data,
                        Context context)
Handle a request to save the edit from either page or tools list mode - no form to read in.


doCancel

public void doCancel(RunData data,
                     Context context)
doCancel called when "eventSubmit_doCancel" is in the request parameters to cancel realm edits


doRemove

public void doRemove(RunData data,
                     Context context)
doRemove called when "eventSubmit_doRemove" is in the request parameters to confirm removal of the realm


doRemove_confirmed

public void doRemove_confirmed(RunData data,
                               Context context)
doRemove_confirmed called when "eventSubmit_doRemove_confirmed" is in the request parameters to remove the realm


doCancel_remove

public void doCancel_remove(RunData data,
                            Context context)
doCancel_remove called when "eventSubmit_doCancel_remove" is in the request parameters to cancel realm removal


doNew_role

public void doNew_role(RunData data,
                       Context context)
Handle a request to create a new role in the realm edit.


doEdit_role

public void doEdit_role(RunData data,
                        Context context)
Edit an existing page.


doRemove_role

public void doRemove_role(RunData data,
                          Context context)
Handle a request to remove the role being edited.


doSaveas_role

public void doSaveas_role(RunData data,
                          Context context)
Handle a request to remove the role being edited.


doSave_role_as

public void doSave_role_as(RunData data,
                           Context context)
Handle a request to saveas with this name.


doCancel_role_saveas

public void doCancel_role_saveas(RunData data,
                                 Context context)
Handle a request to cancel role saveas.


doSave_role

public void doSave_role(RunData data,
                        Context context)
Handle a request to save the realm edit (from the role edit form).


doDone_role

public void doDone_role(RunData data,
                        Context context)
Handle a request to be done role editing - return to the edit mode.


doNew_user

public void doNew_user(RunData data,
                       Context context)
create a new user ability grant in the realm edit.


doEdit_user

public void doEdit_user(RunData data,
                        Context context)
Edit an existing user ability grant.


doRemove_user

public void doRemove_user(RunData data,
                          Context context)
Handle a request to remove all grants to the user.


doSave_user

public void doSave_user(RunData data,
                        Context context)
Handle a request to save the realm edit (from the user edit form).


doDone_user

public void doDone_user(RunData data,
                        Context context)
Handle a request to be done user editing - return to the edit mode.