public class

BufferingRequestDispatcher

extends Object
java.lang.Object
   ↳ com.atlassian.jira.web.servlet.BufferingRequestDispatcher

Class Overview

Dispatches requests, buffering the contents of the response and returning it as a String. This is needed because JIRA's velocity manager doesn't allow writing to a writer, it only returns the content as a String, so the JSP can't write directly to the responses writer. This class is intended for use in velocity templates to include JSPs.

Summary

Public Constructors
BufferingRequestDispatcher(HttpServletRequest request, HttpServletResponse response)
Public Methods
CharArrayWriter include(String path)
Return the contents of the given path.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BufferingRequestDispatcher (HttpServletRequest request, HttpServletResponse response)

Public Methods

public CharArrayWriter include (String path)

Return the contents of the given path. This is called include because its functionally the same as a jsp:include when used in a velocity template.

Parameters
path The path to dispatch the request to.
Returns
  • A CharArrayWriter with the output of the JSP. This is a little more efficient than returning a String, because you can use CharArrayWriter.writeTo() to write the output directly to another writer.
Throws
ServletException If an error occured dispatching the request.
IOException If an error occured dispatching the request.