| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:44:00 EDT 2003 --> |
| <TITLE> |
| TilesRequestProcessor (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.tiles.TilesRequestProcessor,TilesRequestProcessor class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="TilesRequestProcessor (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TilesRequestProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesServlet.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="TilesRequestProcessor.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.tiles</FONT> |
| <BR> |
| Class TilesRequestProcessor</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<A HREF="../../../../org/apache/struts/action/RequestProcessor.html">org.apache.struts.action.RequestProcessor</A> |
| | |
| +--<B>org.apache.struts.tiles.TilesRequestProcessor</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>TilesRequestProcessor</B><DT>extends <A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></DL> |
| |
| <P> |
| <p><strong>RequestProcessor</strong> contains the processing logic that |
| the Struts controller servlet performs as it receives each servlet request |
| from the container.</p> |
| <p>This processor subclasses the Struts RequestProcessor in order to intercept calls to forward |
| or include. When such calls are done, the Tiles processor checks if the specified URI |
| is a definition name. If true, the definition is retrieved and included. If |
| false, the original URI is included or a forward is performed. |
| <p> |
| Actually, catching is done by overloading the following methods: |
| <ul> |
| <li><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#processForwardConfig(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.config.ForwardConfig)"><CODE>processForwardConfig(HttpServletRequest,HttpServletResponse,ForwardConfig)</CODE></A></li> |
| <li><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#internalModuleRelativeForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><CODE>internalModuleRelativeForward(String, HttpServletRequest , HttpServletResponse)</CODE></A></li> |
| <li><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#internalModuleRelativeInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><CODE>internalModuleRelativeInclude(String, HttpServletRequest , HttpServletResponse)</CODE></A></li> |
| </ul> |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>Struts 1.1</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Cedric Dumoulin</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#definitionsFactory">definitionsFactory</A></B></CODE> |
| |
| <BR> |
| Definitions factory</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#log">log</A></B></CODE> |
| |
| <BR> |
| Commons Logging instance.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.struts.action.RequestProcessor"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class org.apache.struts.action.<A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#actions">actions</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#appConfig">appConfig</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#INCLUDE_PATH_INFO">INCLUDE_PATH_INFO</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#INCLUDE_SERVLET_PATH">INCLUDE_SERVLET_PATH</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#moduleConfig">moduleConfig</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#servlet">servlet</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#TilesRequestProcessor()">TilesRequestProcessor</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doForward</A></B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</CODE> |
| |
| <BR> |
| Do a forward using request dispatcher.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#getDefinitionsFactory()">getDefinitionsFactory</A></B>()</CODE> |
| |
| <BR> |
| Get associated definition factory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">init</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig)</CODE> |
| |
| <BR> |
| Initialize this request processor instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#initDefinitionsMapping()">initDefinitionsMapping</A></B>()</CODE> |
| |
| <BR> |
| Read component instance mapping configuration file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#internalModuleRelativeForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">internalModuleRelativeForward</A></B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</CODE> |
| |
| <BR> |
| Catch the call to a module relative forward.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#internalModuleRelativeInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">internalModuleRelativeInclude</A></B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</CODE> |
| |
| <BR> |
| Do a module relative include to specified uri using request dispatcher.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#processForwardConfig(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.config.ForwardConfig)">processForwardConfig</A></B>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <A HREF="../../../../org/apache/struts/config/ForwardConfig.html">ForwardConfig</A> forward)</CODE> |
| |
| <BR> |
| Overloaded method from Struts' RequestProcessor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html#processTilesDefinition(java.lang.String, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processTilesDefinition</A></B>(java.lang.String definitionName, |
| boolean contextRelative, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</CODE> |
| |
| <BR> |
| Process a Tile definition name.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.struts.action.RequestProcessor"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class org.apache.struts.action.<A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#destroy()">destroy</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#doInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doInclude</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#getDebug()">getDebug</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#getInternal()">getInternal</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#getServletContext()">getServletContext</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#log(java.lang.String)">log</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#log(java.lang.String, java.lang.Throwable)">log</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">process</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processActionCreate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionMapping)">processActionCreate</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processActionForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionMapping)">processActionForm</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processActionForward(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionForward)">processActionForward</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processActionPerform(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.Action, org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping)">processActionPerform</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processContent</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Exception, org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping)">processException</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processForward(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionMapping)">processForward</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processInclude(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionMapping)">processInclude</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processLocale(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processLocale</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processMapping(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)">processMapping</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processMultipart(javax.servlet.http.HttpServletRequest)">processMultipart</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processNoCache(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processNoCache</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processPath(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processPath</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processPopulate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping)">processPopulate</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processPreprocess(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">processPreprocess</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processRoles(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionMapping)">processRoles</A>, <A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processValidate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.action.ActionForm, org.apache.struts.action.ActionMapping)">processValidate</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="definitionsFactory"><!-- --></A><H3> |
| definitionsFactory</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>definitionsFactory</B></PRE> |
| <DL> |
| <DD>Definitions factory |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="log"><!-- --></A><H3> |
| log</H3> |
| <PRE> |
| protected static org.apache.commons.logging.Log <B>log</B></PRE> |
| <DL> |
| <DD>Commons Logging instance. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="TilesRequestProcessor()"><!-- --></A><H3> |
| TilesRequestProcessor</H3> |
| <PRE> |
| public <B>TilesRequestProcessor</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| public void <B>init</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Initialize this request processor instance. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The ActionServlet we are associated with.<DD><CODE>moduleConfig</CODE> - The ModuleConfig we are associated with. |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - If an error occurs during initialization.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initDefinitionsMapping()"><!-- --></A><H3> |
| initDefinitionsMapping</H3> |
| <PRE> |
| protected void <B>initDefinitionsMapping</B>() |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Read component instance mapping configuration file. |
| This is where we read files properties. |
| <P> |
| <DD><DL> |
| |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processTilesDefinition(java.lang.String, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
| processTilesDefinition</H3> |
| <PRE> |
| protected boolean <B>processTilesDefinition</B>(java.lang.String definitionName, |
| boolean contextRelative, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Process a Tile definition name. |
| This method tries to process the parameter <code>definitionName</code> as a definition name. |
| It returns <code>true</code> if a definition has been processed, or <code>false</code> otherwise. |
| Parameter <code>contextRelative</code> is not used in this implementation. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>definitionName</CODE> - Definition name to insert.<DD><CODE>contextRelative</CODE> - Is the definition marked contextRelative ?<DD><CODE>request</CODE> - Current page request.<DD><CODE>response</CODE> - Current page response. |
| <DT><B>Returns:</B><DD><code>true</code> if the method has processed uri as a definition name, <code>false</code> otherwise. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
| doForward</H3> |
| <PRE> |
| protected void <B>doForward</B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Do a forward using request dispatcher. |
| Uri is a valid uri. If response has already been commited, do an include |
| instead. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doForward</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - Uri or Definition name to forward.<DD><CODE>request</CODE> - Current page request.<DD><CODE>response</CODE> - Current page response. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processForwardConfig(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.config.ForwardConfig)"><!-- --></A><H3> |
| processForwardConfig</H3> |
| <PRE> |
| protected void <B>processForwardConfig</B>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <A HREF="../../../../org/apache/struts/config/ForwardConfig.html">ForwardConfig</A> forward) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Overloaded method from Struts' RequestProcessor. |
| Forward or redirect to the specified destination by the specified |
| mechanism. |
| This method catches the Struts' actionForward call. It checks if the |
| actionForward is done on a Tiles definition name. If true, process the |
| definition and insert it. If false, call the original parent's method. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#processForwardConfig(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.struts.config.ForwardConfig)">processForwardConfig</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - The servlet request we are processing.<DD><CODE>response</CODE> - The servlet response we are creating.<DD><CODE>forward</CODE> - The ActionForward controlling where we go next. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE> - if an input/output error occurs. |
| <DD><CODE>javax.servlet.ServletException</CODE> - if a servlet exception occurs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalModuleRelativeForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
| internalModuleRelativeForward</H3> |
| <PRE> |
| protected void <B>internalModuleRelativeForward</B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Catch the call to a module relative forward. |
| If the specified uri is a tiles definition name, insert it. |
| Otherwise, parent processing is called. |
| Do a module relative forward to specified uri using request dispatcher. |
| Uri is relative to the current module. The real uri is computed by prefixing |
| the module name. |
| <strong>This method is used internally and is not part of the public API. It is |
| advised to not use it in subclasses.</strong> |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#internalModuleRelativeForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">internalModuleRelativeForward</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - Module-relative URI to forward to.<DD><CODE>request</CODE> - Current page request.<DD><CODE>response</CODE> - Current page response. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE><DT><B>Since:</B></DT> |
| <DD>Struts 1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="internalModuleRelativeInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
| internalModuleRelativeInclude</H3> |
| <PRE> |
| protected void <B>internalModuleRelativeInclude</B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Do a module relative include to specified uri using request dispatcher. |
| Uri is relative to the current module. The real uri is computed by prefixing |
| the module name. |
| <strong>This method is used internally and is not part of the public API. It is |
| advice to not use it in subclasses.</strong> |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html#internalModuleRelativeInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">internalModuleRelativeInclude</A></CODE> in class <CODE><A HREF="../../../../org/apache/struts/action/RequestProcessor.html">RequestProcessor</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - Module-relative URI to forward to.<DD><CODE>request</CODE> - Current page request.<DD><CODE>response</CODE> - Current page response. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE><DT><B>Since:</B></DT> |
| <DD>Struts 1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefinitionsFactory()"><!-- --></A><H3> |
| getDefinitionsFactory</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>getDefinitionsFactory</B>()</PRE> |
| <DL> |
| <DD>Get associated definition factory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TilesRequestProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesServlet.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="TilesRequestProcessor.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
