Apache Struts API Documentation: Class TilesRequestProcessor

org.apache.struts.tiles Class TilesRequestProcessor

java.lang.Object
  |
  +--org.apache.struts.action.RequestProcessor
        |
        +--org.apache.struts.tiles.TilesRequestProcessor

public class TilesRequestProcessor

extends RequestProcessor

RequestProcessor contains the processing logic that the Struts controller servlet performs as it receives each servlet request from the container.

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.

Actually, catching is done by overloading the following methods:

• processForwardConfig(HttpServletRequest,HttpServletResponse,ForwardConfig)
• internalModuleRelativeForward(String, HttpServletRequest , HttpServletResponse)
• internalModuleRelativeInclude(String, HttpServletRequest , HttpServletResponse)

Since:

Struts 1.1

definitionsFactory

protected DefinitionsFactory definitionsFactory

Definitions factory.

log

protected static org.apache.commons.logging.Log log

Commons Logging instance.

TilesRequestProcessor

public TilesRequestProcessor()

init

public void init(ActionServlet servlet,
                 ModuleConfig moduleConfig)
          throws javax.servlet.ServletException

Initialize this request processor instance.

Overrides:

init in class RequestProcessor

Parameters:

servlet - The ActionServlet we are associated with.

moduleConfig - The ModuleConfig we are associated with.

Throws:

javax.servlet.ServletException - If an error occurs during initialization.

initDefinitionsMapping

protected void initDefinitionsMapping()
                               throws javax.servlet.ServletException

Read component instance mapping configuration file. This is where we read files properties.

processTilesDefinition

protected boolean processTilesDefinition(java.lang.String definitionName,
                                         boolean contextRelative,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws java.io.IOException,
                                         javax.servlet.ServletException

Process a Tile definition name. This method tries to process the parameter definitionName as a definition name. It returns true if a definition has been processed, or false otherwise. Parameter contextRelative is not used in this implementation.

Parameters:

definitionName - Definition name to insert.

contextRelative - Is the definition marked contextRelative ?

request - Current page request.

response - Current page response.

Returns:

true if the method has processed uri as a definition name, false otherwise.

doForward

protected void doForward(java.lang.String uri,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.io.IOException,
                         javax.servlet.ServletException

Do a forward using request dispatcher. Uri is a valid uri. If response has already been commited, do an include instead.

Overrides:

doForward in class RequestProcessor

Parameters:

uri - Uri or Definition name to forward.

request - Current page request.

response - Current page response.

processForwardConfig

protected void processForwardConfig(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    ForwardConfig forward)
                             throws java.io.IOException,
                                    javax.servlet.ServletException

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.

Overrides:

processForwardConfig in class RequestProcessor

Parameters:

request - The servlet request we are processing.

response - The servlet response we are creating.

forward - The ActionForward controlling where we go next.

Throws:

java.io.IOException - if an input/output error occurs.

javax.servlet.ServletException - if a servlet exception occurs.

internalModuleRelativeForward

protected void internalModuleRelativeForward(java.lang.String uri,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.io.IOException,
                                             javax.servlet.ServletException

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. This method is used internally and is not part of the public API. It is advised to not use it in subclasses.

Overrides:

internalModuleRelativeForward in class RequestProcessor

Parameters:

uri - Module-relative URI to forward to.

request - Current page request.

response - Current page response.

Since:

Struts 1.1

internalModuleRelativeInclude

protected void internalModuleRelativeInclude(java.lang.String uri,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.io.IOException,
                                             javax.servlet.ServletException

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. This method is used internally and is not part of the public API. It is advised to not use it in subclasses.

Overrides:

internalModuleRelativeInclude in class RequestProcessor

Parameters:

uri - Module-relative URI to forward to.

request - Current page request.

response - Current page response.

Since:

Struts 1.1

getDefinitionsFactory

public DefinitionsFactory getDefinitionsFactory()

Get associated definition factory.