Class TilesRequestProcessor

java.lang.Object
org.apache.struts.action.RequestProcessor
org.apache.struts.tiles2.TilesRequestProcessor
All Implemented Interfaces:
Serializable

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:

Since:
Struts 1.1
See Also:
  • Field Details

    • servletContext

      protected ServletContext servletContext
      The used servlet context.
  • Constructor Details

    • TilesRequestProcessor

      public TilesRequestProcessor()
  • Method Details

    • init

      public void init(ActionServlet servlet, ModuleConfig moduleConfig) throws 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:
      ServletException - If an error occurs during initialization.
    • processTilesDefinition

      protected boolean processTilesDefinition(String definitionName, HttpServletRequest req, HttpServletResponse res) throws IOException, 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.
      Parameters:
      definitionName - Definition name to insert.
      req - Current page request.
      res - Current page response.
      Returns:
      true if the method has processed uri as a definition name, false otherwise.
      Throws:
      IOException - If something goes wrong during writing the definition.
      ServletException - If something goes wrong during the evaluation of the definition
    • doForward

      protected void doForward(String uri, HttpServletRequest request, HttpServletResponse response) throws IOException, 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.
      Throws:
      IOException - If something goes wrong during writing the definition.
      ServletException - If something goes wrong during the evaluation of the definition
    • processForwardConfig

      protected void processForwardConfig(HttpServletRequest request, HttpServletResponse response, ForwardConfig forward) throws IOException, 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:
      IOException - if an input/output error occurs.
      ServletException - if a servlet exception occurs.
    • internalModuleRelativeForward

      protected void internalModuleRelativeForward(String uri, HttpServletRequest request, HttpServletResponse response) throws IOException, 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.
      Throws:
      IOException - If something goes wrong during writing the definition.
      ServletException - If something goes wrong during the evaluation of the definition
      Since:
      Struts 1.1
    • internalModuleRelativeInclude

      protected void internalModuleRelativeInclude(String uri, HttpServletRequest request, HttpServletResponse response) throws IOException, 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.
      Throws:
      IOException - If something goes wrong during writing the definition.
      ServletException - If something goes wrong during the evaluation of the definition
      Since:
      Struts 1.1