uk.ac.ed.ph.snuggletex.webapp

Class DocumentationServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

uk.ac.ed.ph.snuggletex.webapp.DocumentationServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public final class DocumentationServlet
extends javax.servlet.http.HttpServlet

Rather trivial (and badly factored) servlet that serves up the documentation pages for SnuggleTeX. Main points:

• Documentation is written in SnuggleTeX format as .tex files under TEX_SOURCE_BASE_RESOURCE
• Servlet responds to requests under a particular base URL as defined in web.xml. The extra path info is mapped to a "resource path".
• File extension determines which web output to serve.
• Servlet stores generated versions of documentation in a temp directory. If not found, it tries to recreate from scratch using the .tex file.
• Limited caching is available. If off, we recreate each documentation resource each time, otherwise we create once and keep forever.

Version:

$Revision$

Author:

David McKain

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentationServlet()

Method Summary

Modifier and Type	Method and Description
protected WebPageOutputOptions	chooseBestBaseWebPageOutputOptions(javax.servlet.http.HttpServletRequest request) Convenience method to choose the most appropriate base WebPageOutputOptions for the current UserAgent, using chooseBestWebPageType(HttpServletRequest) to determine the underlying WebPageOutputOptions.WebPageType.
protected WebPageOutputOptions.WebPageType	chooseBestWebPageType(javax.servlet.http.HttpServletRequest request) Convenience method which picks the most appropriate MathML-based WebPageOutputOptions.WebPageType for the current UserAgent, returning WebPageOutputOptions.WebPageType.PROCESSED_HTML if the UserAgent does not appear to support MathML as this is the only sensible option in that case.
protected SerializationSpecifier	createMathMLSourceSerializationOptions()
protected SnuggleEngine	createSnuggleEngine()
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	ensureGetContextInitParam(String propertyName)
protected InputStream	ensureReadResource(String resourcePathInsideWebpp) Helper that reads in a resource from the webapp hierarchy, throwing a ServletException if the resource could not be found.
protected Element	extractMathMLElement(NodeList resultNodeList, boolean allowUpConversionOptionsElements) Untangles the given NodeList to find an expected single MathML element, and possibly some whitespace and possibly any number of <c:upconversion-options/> elements.
protected Transformer	getStylesheet(javax.servlet.http.HttpServletRequest request, String classPathUri) Compiles the XSLT stylesheet at the given location within the webapp, using ClassPathURIResolver to locate the stylesheet and anything it wants to import.
protected StylesheetCache	getStylesheetCache()
protected StylesheetManager	getStylesheetManager()
void	init()
protected boolean	isInternetExplorer(javax.servlet.http.HttpServletRequest request)
protected boolean	isMathMLCapable(javax.servlet.http.HttpServletRequest request)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationServlet

public DocumentationServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

ensureGetContextInitParam

public String ensureGetContextInitParam(String propertyName)
                                 throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

ensureReadResource

protected InputStream ensureReadResource(String resourcePathInsideWebpp)
                                  throws javax.servlet.ServletException

Helper that reads in a resource from the webapp hierarchy, throwing a ServletException if the resource could not be found.

Parameters:

resourcePathInsideWebpp - path of Resource to load, relative to base of webapp.

Returns:

resulting InputStream, which will not be null

Throws:

javax.servlet.ServletException

getStylesheetManager

protected StylesheetManager getStylesheetManager()

getStylesheetCache

protected StylesheetCache getStylesheetCache()

createSnuggleEngine

protected SnuggleEngine createSnuggleEngine()

getStylesheet

protected Transformer getStylesheet(javax.servlet.http.HttpServletRequest request,
                                    String classPathUri)
                             throws javax.servlet.ServletException

Compiles the XSLT stylesheet at the given location within the webapp, using ClassPathURIResolver to locate the stylesheet and anything it wants to import.

It also sets some core parameters based on certain properties set for the webapp.

Parameters:

request - Request being processed (so we can pass the context path to the XSLT)

classPathUri - location of XSLT to compile.

Returns:

resulting Templates representing the compiled stylesheet.

Throws:

javax.servlet.ServletException - if XSLT could not be found or could not be compiled.

createMathMLSourceSerializationOptions

protected SerializationSpecifier createMathMLSourceSerializationOptions()

chooseBestWebPageType

protected WebPageOutputOptions.WebPageType chooseBestWebPageType(javax.servlet.http.HttpServletRequest request)

Convenience method which picks the most appropriate MathML-based WebPageOutputOptions.WebPageType for the current UserAgent, returning WebPageOutputOptions.WebPageType.PROCESSED_HTML if the UserAgent does not appear to support MathML as this is the only sensible option in that case.

Parameters:

request -

chooseBestBaseWebPageOutputOptions

protected WebPageOutputOptions chooseBestBaseWebPageOutputOptions(javax.servlet.http.HttpServletRequest request)

Convenience method to choose the most appropriate base WebPageOutputOptions for the current UserAgent, using chooseBestWebPageType(HttpServletRequest) to determine the underlying WebPageOutputOptions.WebPageType.

Parameters:

request -

isMathMLCapable

protected boolean isMathMLCapable(javax.servlet.http.HttpServletRequest request)

isInternetExplorer

protected boolean isInternetExplorer(javax.servlet.http.HttpServletRequest request)

extractMathMLElement

protected Element extractMathMLElement(NodeList resultNodeList,
                                       boolean allowUpConversionOptionsElements)

Untangles the given NodeList to find an expected single MathML element, and possibly some whitespace and possibly any number of <c:upconversion-options/> elements.