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

java.lang.Object
  org.apache.struts.action.RequestProcessor
      org.kuali.rice.kns.web.struts.action.KualiRequestProcessor

public class KualiRequestProcessor
extends org.apache.struts.action.RequestProcessor

This class handles setup of user session and restoring of action form.

Field Summary

protected BusinessObjectService	businessObjectService
protected DataDictionaryService	dataDictionaryService
protected IdentityManagementService	identityManagementService
protected SessionDocumentService	sessionDocumentService
protected org.springframework.transaction.PlatformTransactionManager	transactionManager

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

actions, INCLUDE_PATH_INFO, INCLUDE_SERVLET_PATH, log, moduleConfig, servlet

Constructor Summary

KualiRequestProcessor()

Method Summary

BusinessObjectService	getBusinessObjectService()
DataDictionaryService	getDataDictionaryService()
IdentityManagementService	getIdentityManagementService()
SessionDocumentService	getSessionDocumentService()
org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
void	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.apache.struts.action.ActionForm	processActionForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.ActionMapping mapping) Checks for return from a lookup or question, and restores the action form stored under the request parameter docFormKey.
protected org.apache.struts.action.ActionForward	processActionPerform(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.Action action, org.apache.struts.action.ActionForm form, org.apache.struts.action.ActionMapping mapping) Hook into action perform to handle errors in the error map and catch exceptions.
protected org.apache.struts.action.ActionForward	processException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Exception exception, org.apache.struts.action.ActionForm form, org.apache.struts.action.ActionMapping mapping) Adds more detailed logging for unhandled exceptions
protected void	processPopulate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.ActionForm form, org.apache.struts.action.ActionMapping mapping) Hooks into populate process to call form populate method if form is an instanceof PojoForm.
protected boolean	processPreprocess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) override of the pre process for all struts requests which will ensure that we have the appropriate state for user sessions for all of our requests, also populating the GlobalVariables class with our UserSession for convenience to the non web layer based classes and implementations
protected boolean	processValidate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.ActionForm form, org.apache.struts.action.ActionMapping mapping) Hooks into validate to catch any errors from the populate, and translate the ErrorMap to ActionMessages.

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

destroy, doForward, doInclude, getInternal, getServletContext, init, internalModuleRelativeForward, internalModuleRelativeInclude, log, log, processActionCreate, processCachedMessages, processContent, processForward, processForwardConfig, processInclude, processLocale, processMapping, processMultipart, processNoCache, processPath, processRoles

Methods inherited from class java.lang.Object

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

Field Detail

sessionDocumentService

protected SessionDocumentService sessionDocumentService

dataDictionaryService

protected DataDictionaryService dataDictionaryService

businessObjectService

protected BusinessObjectService businessObjectService

transactionManager

protected org.springframework.transaction.PlatformTransactionManager transactionManager

identityManagementService

protected IdentityManagementService identityManagementService

Constructor Detail

KualiRequestProcessor

public KualiRequestProcessor()

Method Detail

process

public void process(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws IOException,
                    javax.servlet.ServletException

Overrides:

process in class org.apache.struts.action.RequestProcessor

Throws:

IOException

javax.servlet.ServletException

processPreprocess

protected boolean processPreprocess(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)

override of the pre process for all struts requests which will ensure that we have the appropriate state for user sessions for all of our requests, also populating the GlobalVariables class with our UserSession for convenience to the non web layer based classes and implementations

Overrides:

processPreprocess in class org.apache.struts.action.RequestProcessor

processPopulate

protected void processPopulate(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               org.apache.struts.action.ActionForm form,
                               org.apache.struts.action.ActionMapping mapping)
                        throws javax.servlet.ServletException

Hooks into populate process to call form populate method if form is an instanceof PojoForm.

Overrides:

processPopulate in class org.apache.struts.action.RequestProcessor

Throws:

javax.servlet.ServletException

processValidate

protected boolean processValidate(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  org.apache.struts.action.ActionForm form,
                                  org.apache.struts.action.ActionMapping mapping)
                           throws IOException,
                                  javax.servlet.ServletException,
                                  org.apache.struts.action.InvalidCancelException

Hooks into validate to catch any errors from the populate, and translate the ErrorMap to ActionMessages.

Overrides:

processValidate in class org.apache.struts.action.RequestProcessor

Throws:

IOException

javax.servlet.ServletException

org.apache.struts.action.InvalidCancelException

processActionForm

protected org.apache.struts.action.ActionForm processActionForm(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                org.apache.struts.action.ActionMapping mapping)

Checks for return from a lookup or question, and restores the action form stored under the request parameter docFormKey.

Overrides:

processActionForm in class org.apache.struts.action.RequestProcessor

processActionPerform

protected org.apache.struts.action.ActionForward processActionPerform(javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      org.apache.struts.action.Action action,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      org.apache.struts.action.ActionMapping mapping)
                                                               throws IOException,
                                                                      javax.servlet.ServletException

Hook into action perform to handle errors in the error map and catch exceptions.

A transaction is started prior to the execution of the action. This allows for the action code to execute efficiently without the need for using PROPAGATION_SUPPORTS in the transaction definitions. The PROPAGATION_SUPPORTS propagation type does not work well with JTA.

Overrides:

processActionPerform in class org.apache.struts.action.RequestProcessor

Throws:

IOException

javax.servlet.ServletException

processException

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

Adds more detailed logging for unhandled exceptions

Overrides:

processException in class org.apache.struts.action.RequestProcessor

Throws:

IOException

javax.servlet.ServletException

See Also:

RequestProcessor.processException(HttpServletRequest, HttpServletResponse, Exception, ActionForm, ActionMapping)

getSessionDocumentService

public SessionDocumentService getSessionDocumentService()

Returns:

the sessionDocumentService

getDataDictionaryService

public DataDictionaryService getDataDictionaryService()

Returns:

the dataDictionaryService

getBusinessObjectService

public BusinessObjectService getBusinessObjectService()

Returns:

the businessObjectService

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

Returns:

the transactionManager

getIdentityManagementService

public IdentityManagementService getIdentityManagementService()