| org.jamwiki.servlets.JAMWikiServlet
All known Subclasses: org.jamwiki.servlets.SetupServlet, org.jamwiki.servlets.RecentChangesServlet, org.jamwiki.servlets.LoginServlet, org.jamwiki.servlets.ContributionsServlet, org.jamwiki.servlets.PrintableServlet, org.jamwiki.servlets.ImportServlet, org.jamwiki.servlets.AdminServlet, org.jamwiki.servlets.UploadServlet, org.jamwiki.servlets.SearchServlet, org.jamwiki.servlets.WatchlistServlet, org.jamwiki.servlets.CategoryServlet, org.jamwiki.servlets.ManageServlet, org.jamwiki.servlets.RegisterServlet, org.jamwiki.servlets.DiffServlet, org.jamwiki.servlets.ImportTiddlyWikiServlet, org.jamwiki.servlets.EditServlet, org.jamwiki.servlets.ItemsServlet, org.jamwiki.servlets.TranslationServlet, org.jamwiki.servlets.TopicServlet, org.jamwiki.servlets.UpgradeServlet, org.jamwiki.servlets.HistoryServlet, org.jamwiki.servlets.StylesheetServlet, org.jamwiki.servlets.SpecialPagesServlet, org.jamwiki.servlets.LinkToServlet, org.jamwiki.servlets.ExportServlet, org.jamwiki.servlets.MoveServlet, org.jamwiki.servlets.RolesServlet,
JAMWikiServlet | abstract public class JAMWikiServlet extends AbstractController (Code) | | Provides the infrastructure that is common to all JAMWiki servlets. Unless
special handling is required all JAMWiki servlets should extend this
servlet.
|
Field Summary | |
final protected static int | SLOW_PAGE_LIMIT Any page that take longer than this value (specified in milliseconds) will print a warning to the log. | protected String | displayJSP The prefix of the JSP file used to display the servlet output. | protected boolean | layout Flag to indicate whether or not the servlet should load the nav bar and other layout elements. |
Method Summary | |
abstract protected ModelAndView | handleJAMWikiRequest(HttpServletRequest request, HttpServletResponse response, ModelAndView next, WikiPageInfo pageInfo) Abstract method that must be implemented by all sub-classes to handle
servlet requests.
Parameters: request - The servlet request object. Parameters: response - The servlet response object. Parameters: next - A ModelAndView object that has been initialized to the viewspecified by the displayJSP member variable. Parameters: pageInfo - A WikiPageInfo object that will hold output parametersto be passed to the output JSP. | public ModelAndView | handleRequestInternal(HttpServletRequest request, HttpServletResponse response) Implement the handleRequestInternal method specified by the
Spring AbstractController class.
Parameters: request - The servlet request object. Parameters: response - The servlet response object. | protected void | initParams() If any special servlet initialization needs to be performed it can be done
by overriding this method. |
SLOW_PAGE_LIMIT | final protected static int SLOW_PAGE_LIMIT(Code) | | Any page that take longer than this value (specified in milliseconds) will print a warning to the log.
|
displayJSP | protected String displayJSP(Code) | | The prefix of the JSP file used to display the servlet output.
|
layout | protected boolean layout(Code) | | Flag to indicate whether or not the servlet should load the nav bar and other layout elements.
|
handleJAMWikiRequest | abstract protected ModelAndView handleJAMWikiRequest(HttpServletRequest request, HttpServletResponse response, ModelAndView next, WikiPageInfo pageInfo) throws Exception(Code) | | Abstract method that must be implemented by all sub-classes to handle
servlet requests.
Parameters: request - The servlet request object. Parameters: response - The servlet response object. Parameters: next - A ModelAndView object that has been initialized to the viewspecified by the displayJSP member variable. Parameters: pageInfo - A WikiPageInfo object that will hold output parametersto be passed to the output JSP. A ModelAndView object corresponding to the information to berendered, or null if the method directly handles its ownoutput, for example by writing directly to the output response. |
handleRequestInternal | public ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)(Code) | | Implement the handleRequestInternal method specified by the
Spring AbstractController class.
Parameters: request - The servlet request object. Parameters: response - The servlet response object. A ModelAndView object corresponding to the information to berendered, or null if the method directly handles its ownoutput, for example by writing directly to the output response. throws: Exception - Thrown if any error occurs during method execution. |
initParams | protected void initParams()(Code) | | If any special servlet initialization needs to be performed it can be done
by overriding this method. In particular, this method can be used to
override the defaults for the layout member variable, which
determines whether or not the output JSP should include the left navigation
and other layout values, and the displayJSP member variable,
which determine the JSP file used to render output.
|
|
|