SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.webapp.BaseServlet

Modifier and Type	Field and Description
private static final long	serialVersionUID

Access	Constructor and Description
pack-priv	BaseServlet()

Method Summary

Modifier and Type	Method and Description
protected WebPageOutputOptions	chooseBestBaseWebPageOutputOptions(final HttpServletRequest request) Convenience method to choose the most appropriate base `WebPageOutputOptions` for the current UserAgent, using `chooseBestWebPageType(HttpServletRequest)` to determine the underlying `WebPageType`.
protected WebPageOutputOptions.WebPageType	chooseBestWebPageType(final HttpServletRequest request) References Deprecated `WebPageOutputOptions.WebPageType` is deprecated or references (maybe indirectly) at least one deprecated element. Convenience method which picks the most appropriate MathML-based `WebPageType` for the current UserAgent, returning `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()
public String	ensureGetContextInitParam(String propertyName)
protected InputStream	Returns: resulting `InputStream`, which will not be null ensureReadResource(String path of Resource to load, relative to base of webapp. resourcePathInsideWebpp) Helper that reads in a resource from the webapp hierarchy, throwing a `ServletException` if the resource could not be found.
protected Element	extractMathMLElement(final NodeList resultNodeList, final 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	Returns: resulting `Templates` representing the compiled stylesheet. getStylesheet(HttpServletRequest Request being processed (so we can pass the context path to the XSLT) request, String location of XSLT to compile. 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()
protected boolean	isInternetExplorer(final HttpServletRequest request)
protected boolean	isMathMLCapable(final HttpServletRequest request)

Inherited from javax.servlet.http.HttpServlet:: doDelete doGet doHead doOptions doPost doPut doTrace getLastModified service service

serialVersionUID	back to summary
private static final long serialVersionUID

BaseServlet	back to summary
pack-priv BaseServlet()

Method Detail

chooseBestBaseWebPageOutputOptions	back to summary
protected WebPageOutputOptions chooseBestBaseWebPageOutputOptions(final HttpServletRequest request) Convenience method to choose the most appropriate base `WebPageOutputOptions` for the current UserAgent, using `chooseBestWebPageType(HttpServletRequest)` to determine the underlying `WebPageType`.

chooseBestWebPageType back to summary

chooseBestWebPageType	back to summary
protected WebPageOutputOptions.WebPageType chooseBestWebPageType(final HttpServletRequest request) References Deprecated `WebPageOutputOptions.WebPageType` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Convenience method which picks the most appropriate MathML-based `WebPageType` for the current UserAgent, returning `WebPageType#PROCESSED_HTML` if the UserAgent does not appear to support MathML as this is the only sensible option in that case.

protected WebPageOutputOptions.WebPageType chooseBestWebPageType(final HttpServletRequest request)

References Deprecated

WebPageOutputOptions.WebPageType is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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

createMathMLSourceSerializationOptions	back to summary
protected SerializationSpecifier createMathMLSourceSerializationOptions()

createSnuggleEngine	back to summary
protected SnuggleEngine createSnuggleEngine()

ensureGetContextInitParam	back to summary
public String ensureGetContextInitParam(String propertyName) throws ServletException

ensureReadResource back to summary

ensureReadResource	back to summary
protected InputStream ensureReadResource(String resourcePathInsideWebpp) throws ServletException Helper that reads in a resource from the webapp hierarchy, throwing a `ServletException` if the resource could not be found. Parameters resourcePathInsideWebpp:String path of Resource to load, relative to base of webapp. Returns:InputStream resulting `InputStream`, which will not be null

protected InputStream ensureReadResource(String resourcePathInsideWebpp) throws ServletException

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

Parameters

resourcePathInsideWebpp:String: path of Resource to load, relative to base of webapp.

Returns:InputStream

resulting InputStream, which will not be null

extractMathMLElement	back to summary
protected Element extractMathMLElement(final NodeList resultNodeList, final 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.

getStylesheet back to summary

getStylesheet	back to summary
protected Transformer getStylesheet(HttpServletRequest request, String classPathUri) throws 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:HttpServletRequest Request being processed (so we can pass the context path to the XSLT) classPathUri:String location of XSLT to compile. Returns:Transformer resulting `Templates` representing the compiled stylesheet. Exceptions ServletException: if XSLT could not be found or could not be compiled.

protected Transformer getStylesheet(HttpServletRequest request, String classPathUri) throws 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:HttpServletRequest: Request being processed (so we can pass the context path to the XSLT)
classPathUri:String: location of XSLT to compile.

Returns:Transformer

resulting Templates representing the compiled stylesheet.

Exceptions

ServletException:: if XSLT could not be found or could not be compiled.

getStylesheetCache	back to summary
protected StylesheetCache getStylesheetCache()

getStylesheetManager	back to summary
protected StylesheetManager getStylesheetManager()

isInternetExplorer	back to summary
protected boolean isInternetExplorer(final HttpServletRequest request)

isMathMLCapable	back to summary
protected boolean isMathMLCapable(final HttpServletRequest request)

pack-priv abstract Class BaseServlet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail