Class VelocityRequest

All Implemented Interfaces:
DispatchRequest, Request, RequestWrapper

public class VelocityRequest extends AbstractViewRequest
The implementation of the Tiles request context specific for Velocity.
  • Constructor Details

    • VelocityRequest

      public VelocityRequest(DispatchRequest enclosedRequest, org.apache.velocity.context.Context ctx, Writer writer)
      Constructor.
      Parameters:
      enclosedRequest - The request that exposes non-Velocity specific properties
      ctx - The Velocity current context.
      writer - The writer to use to render the response. It may be null, if not necessary.
  • Method Details

    • createVelocityRequest

      public static VelocityRequest createVelocityRequest(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context velocityContext, Writer writer)
      Factory method to create a Velocity request.
      Parameters:
      applicationContext - The application context.
      request - The request.
      response - The response.
      velocityContext - The Velocity context.
      writer - The writer to write into.
      Returns:
      The request.
    • getAvailableScopes

      public List<String> getAvailableScopes()
      Description copied from class: DispatchRequestWrapper
      Returns all available scopes. The scopes are ordered according to their lifetime, the innermost, shorter lived scope appears first, and the outermost, longer lived scope appears last. Besides, the scopes "request" and "application" always included in the list.
      Specified by:
      getAvailableScopes in interface Request
      Overrides:
      getAvailableScopes in class DispatchRequestWrapper
      Returns:
      All the available scopes.
    • doInclude

      protected void doInclude(String path) throws IOException
      Includes the result. By default, uses the wrapped request for the inclusion.
      Overrides:
      doInclude in class AbstractViewRequest
      Parameters:
      path - The path whose result will be included.
      Throws:
      IOException - If something goes wrong.
    • getPrintWriter

      public PrintWriter getPrintWriter()
      Returns a print writer to be used to write directly in the response.
      Specified by:
      getPrintWriter in interface Request
      Overrides:
      getPrintWriter in class DispatchRequestWrapper
      Returns:
      The print writer that writes in the response.
    • getWriter

      public Writer getWriter()
      Returns a writer to be used to write directly in the response.
      Specified by:
      getWriter in interface Request
      Overrides:
      getWriter in class DispatchRequestWrapper
      Returns:
      The writer that writes in the response.
    • getPageScope

      public Map<String,Object> getPageScope()
      Returns the page scope.
      Returns:
      The page scope.
    • getContext

      public Map<String,Object> getContext(String scope)
      Description copied from class: DispatchRequestWrapper
      Returns a context map, given the scope name. This method always return a map for all the scope names returned by getAvailableScopes(). That map may be writable, or immutable, depending on the implementation.
      Specified by:
      getContext in interface Request
      Overrides:
      getContext in class DispatchRequestWrapper
      Parameters:
      scope - The name of the scope.
      Returns:
      The context.