org.kuali.rice.kns.web.struts.action
Class KualiAction

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.actions.BaseAction
          org.apache.struts.actions.DispatchAction
              org.kuali.rice.kns.web.struts.action.KualiAction

Direct Known Subclasses:

ActionListAction, ActionListFilterAction, BackdoorAction, DisplayInactivationBlockersAction, IdentityManagementBaseInquiryAction, IngesterAction, KewKualiAction, KualiDocumentActionBase, KualiHelpAction, KualiInquiryAction, KualiLookupAction, QuestionPromptAction

public abstract class KualiAction
extends org.apache.struts.actions.DispatchAction

The base Action class for all KNS-based Actions. Extends from the standard DispatchAction which allows for a methodToCall request parameter to be used to indicate which method to invoke.

This Action overrides #execute to set methodToCall for image submits. Also performs other setup required for KNS framework calls.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

static String	FORM_ACTION Constant defined to match with TextArea.jsp and updateTextArea function in core.js
static String	FORWARD_NEXT Constant defined to match with local forwarding in struts-config.xml for the parent of the Updated Text Area.
static String	FORWARD_TEXT_AREA_UPDATE Constant defined to match with global forwarding in struts-config.xml for Text Area Update.
static String	METHOD_TO_CALL Constant defined to match input parameter from URL and from TextArea.jsp.
static String	POST_TEXT_AREA_TO_PARENT Constant defined to match with method to call in TextArea.jsp.
static String	TEXT_AREA_FIELD_ANCHOR Constant defined to match with TextArea.jsp and updateTextArea function in core.js
static String	TEXT_AREA_FIELD_LABEL Constant defined to match with TextArea.jsp and updateTextArea function in core.js
static String	TEXT_AREA_FIELD_NAME Constant defined to match with TextArea.jsp and updateTextArea function in core.js
static String	TEXT_AREA_MAX_LENGTH Constant defined to match with TextArea.jsp and updateTextArea function in core.js
static String	TEXT_AREA_READ_ONLY Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

KualiAction()

Method Summary

protected void	addMethodToCallToUncheckedList(String methodToCall) Use to add a methodToCall to the a list which will not have authorization checks.
protected void	checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) Override this method to provide action-level access controls to the application.
protected org.apache.struts.action.ActionForward	defaultDispatch(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) When no methodToCall is specified, the defaultDispatch method is invoked.
protected org.apache.struts.action.ActionForward	dispatchMethod(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String methodToCall)
protected void	doProcessingAfterPost(KualiForm form, javax.servlet.http.HttpServletRequest request) This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc).
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Entry point to all actions.
protected String	findMethodToCall(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)
static String	getApplicationBaseUrl()
protected BusinessObjectAuthorizationService	getBusinessObjectAuthorizationService()
protected EncryptionService	getEncryptionService()
protected String	getHeaderTabDispatch(javax.servlet.http.HttpServletRequest request) Retrieves the header tab dispatch.
protected String	getHeaderTabNavigateTo(javax.servlet.http.HttpServletRequest request) Retrieves the header tab to navigate to.
protected String	getImageContext(javax.servlet.http.HttpServletRequest request, String contextKey) Retrieves the image context
protected static KualiModuleService	getKualiModuleService()
protected int	getLineToDelete(javax.servlet.http.HttpServletRequest request) Parses the method to call attribute to pick off the line number which should be deleted.
protected String	getReturnLocation(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping)
protected Map<String,String>	getRoleQualification(org.apache.struts.action.ActionForm form, String methodToCall) override this method to add data from the form for role qualification in the authorization check
protected int	getSelectedLine(javax.servlet.http.HttpServletRequest request) Parses the method to call attribute to pick off the line number which should have an action performed on it.
protected String	getTabToToggle(javax.servlet.http.HttpServletRequest request) Determines which tab was requested to be toggled
org.apache.struts.action.ActionForward	headerTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles requests that originate via Header Tabs.
org.apache.struts.action.ActionForward	hideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles all tabs to closed
org.apache.struts.action.ActionForward	performInquiry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	performLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Takes care of storing the action form in the User session and forwarding to the lookup action.
protected org.apache.struts.action.ActionForward	performQuestionWithInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) Handles rendering a question prompt - without a specified context.
protected org.apache.struts.action.ActionForward	performQuestionWithInputAgainBecauseOfErrors(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context, String reason, String errorKey, String errorPropertyName, String errorParameter) Handles re-rendering a question prompt because of an error on what was submitted.
protected org.apache.struts.action.ActionForward	performQuestionWithoutInput(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String questionText, String questionType, String caller, String context) This method handles rendering the question component, but without any of the extra error fields
org.apache.struts.action.ActionForward	performWorkgroupLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Takes care of storing the action form in the User session and forwarding to the workflow workgroup lookup action.
org.apache.struts.action.ActionForward	postTextAreaToParent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is invoked from the TextArea.jsp for posting its value to the parent page that called the extended text area page.
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Default refresh method.
protected String	retrieveLookupParameterValue(Class<? extends BusinessObject> boClass, String parameterName, String parameterValuePropertyName, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request) Retrieves the value of a parameter to be passed into the lookup or inquiry frameworks.
org.apache.struts.action.ActionForward	showAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles all tabs to open
org.apache.struts.action.ActionForward	toggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggles the tab state in the ui
org.apache.struts.action.ActionForward	updateTextArea(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is invoked when Java Script is turned off from the web browser.
protected void	validateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form, String fullParameter)

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEXT_AREA_FIELD_NAME

public static final String TEXT_AREA_FIELD_NAME

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is textAreaFieldName

See Also:

Constant Field Values

TEXT_AREA_FIELD_LABEL

public static final String TEXT_AREA_FIELD_LABEL

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is textAreaFieldLabel

See Also:

Constant Field Values

TEXT_AREA_READ_ONLY

public static final String TEXT_AREA_READ_ONLY

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is textAreaReadOnly

See Also:

Constant Field Values

TEXT_AREA_FIELD_ANCHOR

public static final String TEXT_AREA_FIELD_ANCHOR

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is textAreaFieldAnchor

See Also:

Constant Field Values

TEXT_AREA_MAX_LENGTH

public static final String TEXT_AREA_MAX_LENGTH

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is textAreaFieldAnchor

See Also:

Constant Field Values

FORM_ACTION

public static final String FORM_ACTION

Constant defined to match with TextArea.jsp and updateTextArea function in core.js

Value is htmlFormAction

See Also:

Constant Field Values

METHOD_TO_CALL

public static final String METHOD_TO_CALL

Constant defined to match input parameter from URL and from TextArea.jsp.

Value is methodToCall

See Also:

Constant Field Values

FORWARD_TEXT_AREA_UPDATE

public static final String FORWARD_TEXT_AREA_UPDATE

Constant defined to match with global forwarding in struts-config.xml for Text Area Update.

Value is updateTextArea

See Also:

Constant Field Values

POST_TEXT_AREA_TO_PARENT

public static final String POST_TEXT_AREA_TO_PARENT

Constant defined to match with method to call in TextArea.jsp.

Value is postTextAreaToParent

See Also:

Constant Field Values

FORWARD_NEXT

public static final String FORWARD_NEXT

Constant defined to match with local forwarding in struts-config.xml for the parent of the Updated Text Area.

Value is forwardNext

See Also:

Constant Field Values

Constructor Detail

KualiAction

public KualiAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Entry point to all actions. NOTE: No need to hook into execute for handling framwork setup anymore. Just implement the methodToCall for the framework setup, Constants.METHOD_REQUEST_PARAMETER will contain the full parameter, which can be sub stringed for getting framework parameters.

Overrides:

execute in class org.apache.struts.actions.DispatchAction

Throws:

Exception

See Also:

Action.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

defaultDispatch

protected org.apache.struts.action.ActionForward defaultDispatch(org.apache.struts.action.ActionMapping mapping,
                                                                 org.apache.struts.action.ActionForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

When no methodToCall is specified, the defaultDispatch method is invoked. Default implementation returns the "basic" ActionForward.

Throws:

Exception

dispatchMethod

protected org.apache.struts.action.ActionForward dispatchMethod(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                String methodToCall)
                                                         throws Exception

Overrides:

dispatchMethod in class org.apache.struts.actions.DispatchAction

Throws:

Exception

findMethodToCall

protected String findMethodToCall(org.apache.struts.action.ActionForm form,
                                  javax.servlet.http.HttpServletRequest request)
                           throws Exception

Throws:

Exception

toggleTab

public org.apache.struts.action.ActionForward toggleTab(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                 throws Exception

Toggles the tab state in the ui

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

showAllTabs

public org.apache.struts.action.ActionForward showAllTabs(org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm form,
                                                          javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)
                                                   throws Exception

Toggles all tabs to open

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

hideAllTabs

public org.apache.struts.action.ActionForward hideAllTabs(org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm form,
                                                          javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)
                                                   throws Exception

Toggles all tabs to closed

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

refresh

public org.apache.struts.action.ActionForward refresh(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Default refresh method. Called from returning frameworks.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getLineToDelete

protected int getLineToDelete(javax.servlet.http.HttpServletRequest request)

Parses the method to call attribute to pick off the line number which should be deleted.

Parameters:

request -

Returns:

getSelectedLine

protected int getSelectedLine(javax.servlet.http.HttpServletRequest request)

Parses the method to call attribute to pick off the line number which should have an action performed on it.

Parameters:

request -

Returns:

getTabToToggle

protected String getTabToToggle(javax.servlet.http.HttpServletRequest request)

Determines which tab was requested to be toggled

Parameters:

request -

Returns:

getHeaderTabNavigateTo

protected String getHeaderTabNavigateTo(javax.servlet.http.HttpServletRequest request)

Retrieves the header tab to navigate to.

Parameters:

request -

Returns:

getHeaderTabDispatch

protected String getHeaderTabDispatch(javax.servlet.http.HttpServletRequest request)

Retrieves the header tab dispatch.

Parameters:

request -

Returns:

getImageContext

protected String getImageContext(javax.servlet.http.HttpServletRequest request,
                                 String contextKey)

Retrieves the image context

Parameters:

request -

contextKey -

Returns:

getReturnLocation

protected String getReturnLocation(javax.servlet.http.HttpServletRequest request,
                                   org.apache.struts.action.ActionMapping mapping)

retrieveLookupParameterValue

protected String retrieveLookupParameterValue(Class<? extends BusinessObject> boClass,
                                              String parameterName,
                                              String parameterValuePropertyName,
                                              org.apache.struts.action.ActionForm form,
                                              javax.servlet.http.HttpServletRequest request)
                                       throws Exception

Retrieves the value of a parameter to be passed into the lookup or inquiry frameworks. The default implementation of this method will attempt to look in the request to determine wheter the appropriate value exists as a request parameter. If not, it will attempt to look through the form object to find the property.

Parameters:

boClass - a class implementing boClass, representing the BO that will be looked up

parameterName - the name of the parameter

parameterValuePropertyName - the property (relative to the form object) where the value to be passed into the lookup/inquiry may be found

form -

request -

Returns:

Throws:

Exception

performLookup

public org.apache.struts.action.ActionForward performLookup(org.apache.struts.action.ActionMapping mapping,
                                                            org.apache.struts.action.ActionForm form,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)
                                                     throws Exception

Takes care of storing the action form in the User session and forwarding to the lookup action.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

validateLookupInquiryFullParameter

protected void validateLookupInquiryFullParameter(javax.servlet.http.HttpServletRequest request,
                                                  org.apache.struts.action.ActionForm form,
                                                  String fullParameter)

performInquiry

public org.apache.struts.action.ActionForward performInquiry(org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.ActionForm form,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)
                                                      throws Exception

Throws:

Exception

performQuestionWithoutInput

protected org.apache.struts.action.ActionForward performQuestionWithoutInput(org.apache.struts.action.ActionMapping mapping,
                                                                             org.apache.struts.action.ActionForm form,
                                                                             javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response,
                                                                             String questionId,
                                                                             String questionText,
                                                                             String questionType,
                                                                             String caller,
                                                                             String context)
                                                                      throws Exception

This method handles rendering the question component, but without any of the extra error fields

Parameters:

mapping -

form -

request -

response -

questionId -

questionText -

questionType -

caller -

context -

Returns:

ActionForward

Throws:

Exception

performQuestionWithInput

protected org.apache.struts.action.ActionForward performQuestionWithInput(org.apache.struts.action.ActionMapping mapping,
                                                                          org.apache.struts.action.ActionForm form,
                                                                          javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response,
                                                                          String questionId,
                                                                          String questionText,
                                                                          String questionType,
                                                                          String caller,
                                                                          String context)
                                                                   throws Exception

Handles rendering a question prompt - without a specified context.

Parameters:

mapping -

form -

request -

response -

questionId -

questionText -

questionType -

caller -

context -

Returns:

ActionForward

Throws:

Exception

performQuestionWithInputAgainBecauseOfErrors

protected org.apache.struts.action.ActionForward performQuestionWithInputAgainBecauseOfErrors(org.apache.struts.action.ActionMapping mapping,
                                                                                              org.apache.struts.action.ActionForm form,
                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                              javax.servlet.http.HttpServletResponse response,
                                                                                              String questionId,
                                                                                              String questionText,
                                                                                              String questionType,
                                                                                              String caller,
                                                                                              String context,
                                                                                              String reason,
                                                                                              String errorKey,
                                                                                              String errorPropertyName,
                                                                                              String errorParameter)
                                                                                       throws Exception

Handles re-rendering a question prompt because of an error on what was submitted.

Parameters:

mapping -

form -

request -

response -

questionId -

questionText -

questionType -

caller -

context -

reason -

errorKey -

errorPropertyName -

errorParameter -

Returns:

ActionForward

Throws:

Exception

performWorkgroupLookup

public org.apache.struts.action.ActionForward performWorkgroupLookup(org.apache.struts.action.ActionMapping mapping,
                                                                     org.apache.struts.action.ActionForm form,
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                              throws Exception

Takes care of storing the action form in the User session and forwarding to the workflow workgroup lookup action.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

headerTab

public org.apache.struts.action.ActionForward headerTab(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                 throws Exception

Handles requests that originate via Header Tabs.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

checkAuthorization

protected void checkAuthorization(org.apache.struts.action.ActionForm form,
                                  String methodToCall)
                           throws AuthorizationException

Override this method to provide action-level access controls to the application.

Parameters:

form -

Throws:

AuthorizationException

getRoleQualification

protected Map<String,String> getRoleQualification(org.apache.struts.action.ActionForm form,
                                                  String methodToCall)

override this method to add data from the form for role qualification in the authorization check

getKualiModuleService

protected static KualiModuleService getKualiModuleService()

updateTextArea

public org.apache.struts.action.ActionForward updateTextArea(org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.ActionForm form,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)

This method is invoked when Java Script is turned off from the web browser. It setup the information that the update text area requires for copying current text in the calling page text area and returning to the calling page. The information is passed to the JSP through Http Request attributes. All other parameters are forwarded

Parameters:

mapping -

form -

request -

response -

Returns:

postTextAreaToParent

public org.apache.struts.action.ActionForward postTextAreaToParent(org.apache.struts.action.ActionMapping mapping,
                                                                   org.apache.struts.action.ActionForm form,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)

This method is invoked from the TextArea.jsp for posting its value to the parent page that called the extended text area page. The invocation is done through Struts action. The default forwarding id is RiceContants.MAPPING_BASIC. This can be overridden using the parameter key FORWARD_NEXT.

Parameters:

mapping -

form -

request -

response -

Returns:

addMethodToCallToUncheckedList

protected final void addMethodToCallToUncheckedList(String methodToCall)

Use to add a methodToCall to the a list which will not have authorization checks. This assumes that the call will be redirected (as in the case of a lookup) that will perform the authorization.

doProcessingAfterPost

protected void doProcessingAfterPost(KualiForm form,
                                     javax.servlet.http.HttpServletRequest request)

This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc).

getBusinessObjectAuthorizationService

protected BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()

getEncryptionService

protected EncryptionService getEncryptionService()

getApplicationBaseUrl

public static String getApplicationBaseUrl()