|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.struts.action.RequestProcessor
org.apache.struts.faces.application.FacesRequestProcessor
public class FacesRequestProcessor
Concrete implementation of RequestProcessor that
implements the standard Struts request processing lifecycle on a
request that was received as an ActionEvent by our
associated ActionListener. It replaces the request processor
instance normally configured by Struts, so it must support non-Faces
requests as well.
| Field Summary | |
|---|---|
static java.lang.String |
LIFECYCLE_ID_ATTR
The lifecycle id. |
protected static org.apache.commons.logging.Log |
log
The log instance for this class. |
| Fields inherited from class org.apache.struts.action.RequestProcessor |
|---|
actions, INCLUDE_PATH_INFO, INCLUDE_SERVLET_PATH, moduleConfig, servlet |
| Constructor Summary | |
|---|---|
FacesRequestProcessor()
|
|
| Method Summary | |
|---|---|
protected void |
doForward(java.lang.String uri,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Set up a Faces Request if we are not already processing one. |
protected Action |
processActionCreate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
Return an Action instance that will be used to process
the current request, creating a new one if necessary. |
protected ActionForm |
processActionForm(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
Retrieve and return the ActionForm associated with this
mapping, creating and retaining one if necessary. |
protected ActionForward |
processActionPerform(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Action action,
ActionForm form,
ActionMapping mapping)
Ask the specified Action instance to handle this
request. |
protected boolean |
processForward(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
Process a forward requested by this mapping (if any). |
protected void |
processForwardConfig(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ForwardConfig forward)
Forward or redirect to the specified destination, by the specified mechanism. |
protected boolean |
processInclude(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
Process an include requested by this mapping (if any). |
protected java.lang.String |
processPath(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Identify and return the path component (from the request URI for a non-Faces request, or from the form event for a Faces request) that we will use to select an ActionMapping to dispatch with. |
protected void |
processPopulate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
Populate the properties of the specified ActionForm
instance from the request parameters included with this request,
IF this is a non-Faces request. |
protected boolean |
processValidate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
If this request was not cancelled, and the request's ActionMapping has not disabled validation, call the
validate method of the specified ActionForm, and
forward to the input path if there were any errors. |
| Methods inherited from class org.apache.struts.action.RequestProcessor |
|---|
destroy, doInclude, getInternal, getServletContext, init, internalModuleRelativeForward, internalModuleRelativeInclude, process, processCachedMessages, processContent, processException, processLocale, processMapping, processMultipart, processNoCache, processPreprocess, processRoles |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static org.apache.commons.logging.Log log
The log instance for this class.
public static final java.lang.String LIFECYCLE_ID_ATTR
The lifecycle id.
| Constructor Detail |
|---|
public FacesRequestProcessor()
| Method Detail |
|---|
protected void doForward(java.lang.String uri,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException
Set up a Faces Request if we are not already processing one. Next,
create a new view if the specified uri is different from
the current view identifier. Finally, cause the new view to be
rendered, and call FacesContext.responseComplete() to
indicate that this has already been done.
doForward in class RequestProcessoruri - Context-relative path to forward torequest - Current page requestresponse - Current page response
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet error occurs
protected Action processActionCreate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
throws java.io.IOException
RequestProcessorReturn an Action instance that will be used to process
the current request, creating a new one if necessary.
processActionCreate in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingmapping - The mapping we are using
Action instance that will be used to process
the current request.
java.io.IOException - if an input/output error occurs
protected ActionForm processActionForm(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
RequestProcessorRetrieve and return the ActionForm associated with this
mapping, creating and retaining one if necessary. If there is no
ActionForm associated with this mapping, return
null.
processActionForm in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingmapping - The mapping we are using
ActionForm associated with this mapping.
protected ActionForward processActionPerform(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Action action,
ActionForm form,
ActionMapping mapping)
throws java.io.IOException,
javax.servlet.ServletException
RequestProcessorAsk the specified Action instance to handle this
request. Return the ActionForward instance (if any)
returned by the called Action for further processing.
processActionPerform in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingaction - The Action instance to be usedform - The ActionForm instance to pass to this Actionmapping - The ActionMapping instance to pass to this Action
ActionForward instance (if any) returned by
the called Action.
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet exception occurs
protected boolean processForward(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
throws java.io.IOException,
javax.servlet.ServletException
RequestProcessorProcess a forward requested by this mapping (if any). Return
true if standard processing should continue, or
false if we have already handled this request.
processForward in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingmapping - The ActionMapping we are using
true to continue normal processing;
false if a response has been created.
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet exception occurs
protected void processForwardConfig(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ForwardConfig forward)
throws java.io.IOException,
javax.servlet.ServletException
RequestProcessorForward or redirect to the specified destination, by the specified
mechanism. This method uses a ForwardConfig object
instead an ActionForward.
processForwardConfig in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingforward - The ForwardConfig controlling where we go next
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet exception occurs
protected boolean processInclude(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionMapping mapping)
throws java.io.IOException,
javax.servlet.ServletException
RequestProcessorProcess an include requested by this mapping (if any). Return
true if standard processing should continue, or
false if we have already handled this request.
processInclude in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingmapping - The ActionMapping we are using
true to continue normal processing;
false if a response has been created.
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if thrown by invoked methods
protected java.lang.String processPath(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.io.IOException
Identify and return the path component (from the request URI for a
non-Faces request, or from the form event for a Faces request)
that we will use to select an ActionMapping to dispatch with.
If no such path can be identified, create an error response and return
null.
processPath in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creating
java.io.IOException - if an input/output error occurs
protected void processPopulate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
throws javax.servlet.ServletException
Populate the properties of the specified ActionForm
instance from the request parameters included with this request,
IF this is a non-Faces request. For a Faces request,
this will have already been done by the Update Model Values
phase of the request processing lifecycle, so all we have to do is
recognize whether the request was cancelled or not.
processPopulate in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingform - The ActionForm instance we are populatingmapping - The ActionMapping we are using
javax.servlet.ServletException - if thrown by RequestUtils.populate()
protected boolean processValidate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ActionForm form,
ActionMapping mapping)
throws java.io.IOException,
javax.servlet.ServletException,
InvalidCancelException
RequestProcessorIf this request was not cancelled, and the request's ActionMapping has not disabled validation, call the
validate method of the specified ActionForm, and
forward to the input path if there were any errors. Return
true if we should continue processing, or
false if we have already forwarded control back to the
input form.
processValidate in class RequestProcessorrequest - The servlet request we are processingresponse - The servlet response we are creatingform - The ActionForm instance we are populatingmapping - The ActionMapping we are using
true to continue normal processing;
false if a response has been created.
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet exception occurs
InvalidCancelException - if a cancellation is attempted
without the proper action configuration.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||