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

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

actions, INCLUDE_PATH_INFO, INCLUDE_SERVLET_PATH, log, moduleConfig, servlet

Constructor Summary

Constructors

Constructor and Description
KualiRequestProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.kns.service.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
void	processFormActionAndForward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.ActionMapping mapping)
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)
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.
void	strutsProcess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) ProcessDefinition an HttpServletRequest and create the corresponding HttpServletResponse or dispatch to another resource.

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

destroy, doForward, doInclude, getInternal, getServletContext, init, internalModuleRelativeForward, internalModuleRelativeInclude, 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

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)

Overrides:

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

strutsProcess

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

ProcessDefinition an HttpServletRequest and create the corresponding HttpServletResponse or dispatch to another resource.

Parameters:

request - The servlet request we are processing

response - The servlet response we are creating

Throws:

IOException - if an input/output error occurs

javax.servlet.ServletException - if a processing exception occurs

processFormActionAndForward

public void processFormActionAndForward(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               org.apache.struts.action.ActionMapping mapping)
                                 throws javax.servlet.ServletException,
                                        IOException

Throws:

javax.servlet.ServletException

IOException

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 org.kuali.rice.kns.service.SessionDocumentService getSessionDocumentService()

Returns:

the sessionDocumentService

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

Returns:

the transactionManager