uk.ac.cam.caret.sakai.rwiki.component.service.impl

Class XSLTEntityHandler

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.component.service.impl.BaseEntityHandlerImpl

uk.ac.cam.caret.sakai.rwiki.component.service.impl.XSLTEntityHandler

All Implemented Interfaces:

uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

Direct Known Subclasses:

XLSTChangesHandler

public class XSLTEntityHandler
extends BaseEntityHandlerImpl

Provides a XSLT Based entity handler. It will serialise the an RWikiObject into XML and then apply a XSLT to generate the Whole output.

Author:

ieb

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_siteAlias Configuration: allow use of alias for site id in references.

Fields inherited from class uk.ac.cam.caret.sakai.rwiki.component.service.impl.BaseEntityHandlerImpl

m_aliasService, m_siteService

Constructor Summary

Constructors

Constructor and Description
XSLTEntityHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(ContentHandler ch, String ns, String lname, String qname, Attributes attr, Object content) Adds an element to the content handler.
void	addRequestAttributes(ContentHandler ch, HttpServletRequest request)
void	addRequestParameters(ContentHandler ch, HttpServletRequest request)
void	destroy() called by spring.
String	getAnchorLinkFormat()
Collection	getAuthzGroups(org.sakaiproject.entity.api.Reference ref, String userId)
String	getAuthZPrefix()
String	getBreadCrumbParameter()
String	getBreadCrumbParameterFormat()
static HttpServletRequest	getCurrentRequest()
String	getDefaultStackTrace()
String	getDescription(org.sakaiproject.entity.api.Entity entity)
org.sakaiproject.entity.api.EntityManager	getEntityManager()
String	getErrorFormat()
String	getHrefTagFormat()
ContentHandler	getOutputHandler(OutputStream out)
ContentHandler	getOutputHandler(Writer out)
Map	getOutputProperties()
org.sakaiproject.entity.api.ResourceProperties	getProperties(org.sakaiproject.entity.api.Entity entity)
Map	getResponseHeaders()
String	getStandardLinkFormat()
String	getUrl(org.sakaiproject.entity.api.Entity entity)
String	getXalan270ContentHandler()
String	getXslt()
void	init() called by spring.
boolean	isEscaped()
void	outputContent(org.sakaiproject.entity.api.Entity entity, org.sakaiproject.entity.api.Entity sideBar, HttpServletRequest request, HttpServletResponse res)
void	parseToSAX(String toRender, ContentHandler ch)
String	render(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, boolean withBreadCrumb)
void	renderToXML(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo, ContentHandler ch, boolean withBreadCrumb, boolean escapeXML) Serialises the rendered content of the RWiki Object to SAX
void	setAnchorLinkFormat(String anchorLinkFormat)
void	setAuthZPrefix(String authZPrefix)
void	setBreadCrumbParameter(String breadCrumbParameter)
void	setBreadCrumbParameterFormat(String breadCrumbParameterFormat)
static void	setCurrentRequest(HttpServletRequest request)
void	setDefaultStackTrace(String defaultStackTrace)
void	setEntityManager(org.sakaiproject.entity.api.EntityManager entityManager)
void	setErrorFormat(String errorFormat)
void	setEscaped(boolean escaped)
void	setHrefTagFormat(String hrefTagFormat)
void	setOutputProperties(Map outputProperties)
void	setResponseHeaders(Map responseHeaders)
void	setStandardLinkFormat(String standardLinkFormat)
void	setTransformParameters(Map<String,String> transformParameters)
void	setXalan270ContentHandler(String xalan270ContentHandler)
void	setXslt(String xslt)

Methods inherited from class uk.ac.cam.caret.sakai.rwiki.component.service.impl.BaseEntityHandlerImpl

decode, getAccessURLStart, getExperimental, getFeedFormat, getHTML, getMinorType, getRevision, isAvailable, matches, setAccessURLStart, setAliasService, setExperimental, setFeedFormat, setMinorType, setReference, setSiteService

Methods inherited from class java.lang.Object

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

Field Detail

m_siteAlias

protected boolean m_siteAlias

Configuration: allow use of alias for site id in references.

Constructor Detail

XSLTEntityHandler

public XSLTEntityHandler()

Method Detail

getDescription

public String getDescription(org.sakaiproject.entity.api.Entity entity)

getUrl

public String getUrl(org.sakaiproject.entity.api.Entity entity)

getCurrentRequest

public static HttpServletRequest getCurrentRequest()

Returns:

setCurrentRequest

public static void setCurrentRequest(HttpServletRequest request)

Parameters:

request -

outputContent

public void outputContent(org.sakaiproject.entity.api.Entity entity,
                 org.sakaiproject.entity.api.Entity sideBar,
                 HttpServletRequest request,
                 HttpServletResponse res)

addElement

public void addElement(ContentHandler ch,
              String ns,
              String lname,
              String qname,
              Attributes attr,
              Object content)
                throws SAXException

Adds an element to the content handler.

Parameters:

ch - the content handler

ns - the name space of the element

lname - the local name

qname - the qname

attr - the attribute list

content - content of the element

Throws:

SAXException - if the underlying sax chain has a problem

getProperties

public org.sakaiproject.entity.api.ResourceProperties getProperties(org.sakaiproject.entity.api.Entity entity)

renderToXML

public void renderToXML(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
               ContentHandler ch,
               boolean withBreadCrumb,
               boolean escapeXML)
                 throws SAXException,
                        IOException

Serialises the rendered content of the RWiki Object to SAX

Parameters:

rwo -

ch -

withBreadCrumb -

Throws:

SAXException

IOException

parseToSAX

public void parseToSAX(String toRender,
              ContentHandler ch)
                throws IOException,
                       SAXException

Throws:

IOException

SAXException

render

public String render(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo,
            boolean withBreadCrumb)

getAuthzGroups

public Collection getAuthzGroups(org.sakaiproject.entity.api.Reference ref,
                        String userId)

init

public void init()

called by spring.

destroy

public void destroy()

called by spring.

getOutputHandler

public ContentHandler getOutputHandler(Writer out)
                                throws IOException

Throws:

IOException

See Also:

uk.co.tfd.sakai.xmlserver.api.OutputContentHandler#getOutputHandler(java.io.Writer)

getOutputHandler

public ContentHandler getOutputHandler(OutputStream out)
                                throws IOException

Throws:

IOException

getXslt

public String getXslt()

Returns:

Returns the xslt.

setXslt

public void setXslt(String xslt)

Parameters:

xslt - The xslt to set.

getDefaultStackTrace

public String getDefaultStackTrace()

Returns:

Returns the defaultStackTrace.

setDefaultStackTrace

public void setDefaultStackTrace(String defaultStackTrace)

Parameters:

defaultStackTrace - The defaultStackTrace to set.

getErrorFormat

public String getErrorFormat()

Returns:

Returns the errorFormat.

setErrorFormat

public void setErrorFormat(String errorFormat)

Parameters:

errorFormat - The errorFormat to set.

getAuthZPrefix

public String getAuthZPrefix()

Returns:

Returns the authZPrefix.

setAuthZPrefix

public void setAuthZPrefix(String authZPrefix)

Parameters:

authZPrefix - The authZPrefix to set.

getAnchorLinkFormat

public String getAnchorLinkFormat()

Returns:

Returns the anchorLinkFormat.

setAnchorLinkFormat

public void setAnchorLinkFormat(String anchorLinkFormat)

Parameters:

anchorLinkFormat - The anchorLinkFormat to set.

getHrefTagFormat

public String getHrefTagFormat()

Returns:

Returns the hrefTagFormat.

setHrefTagFormat

public void setHrefTagFormat(String hrefTagFormat)

Parameters:

hrefTagFormat - The hrefTagFormat to set.

getStandardLinkFormat

public String getStandardLinkFormat()

Returns:

Returns the standardLinkFormat.

setStandardLinkFormat

public void setStandardLinkFormat(String standardLinkFormat)

Parameters:

standardLinkFormat - The standardLinkFormat to set.

getOutputProperties

public Map getOutputProperties()

Returns:

Returns the outputProperties.

setOutputProperties

public void setOutputProperties(Map outputProperties)

Parameters:

outputProperties - The outputProperties to set.

setTransformParameters

public void setTransformParameters(Map<String,String> transformParameters)

Parameters:

transformParameters - The transform paramaters that should be passed when transforming it.

getResponseHeaders

public Map getResponseHeaders()

Returns:

Returns the responseHeaders.

setResponseHeaders

public void setResponseHeaders(Map responseHeaders)

Parameters:

responseHeaders - The responseHeaders to set.

addRequestAttributes

public void addRequestAttributes(ContentHandler ch,
                        HttpServletRequest request)
                          throws Exception

Throws:

Exception

addRequestParameters

public void addRequestParameters(ContentHandler ch,
                        HttpServletRequest request)
                          throws Exception

Throws:

Exception

getEntityManager

public org.sakaiproject.entity.api.EntityManager getEntityManager()

Returns:

Returns the entityManager.

setEntityManager

public void setEntityManager(org.sakaiproject.entity.api.EntityManager entityManager)

Parameters:

entityManager - The entityManager to set.

getBreadCrumbParameterFormat

public String getBreadCrumbParameterFormat()

Returns:

the breadCrumbParameterFormat

setBreadCrumbParameterFormat

public void setBreadCrumbParameterFormat(String breadCrumbParameterFormat)

Parameters:

breadCrumbParameterFormat - the breadCrumbParameterFormat to set

getBreadCrumbParameter

public String getBreadCrumbParameter()

Returns:

the breadCrumbParameter

setBreadCrumbParameter

public void setBreadCrumbParameter(String breadCrumbParameter)

Parameters:

breadCrumbParameter - the breadCrumbParameter to set

getXalan270ContentHandler

public String getXalan270ContentHandler()

Returns:

the xalan270ContentHandler

setXalan270ContentHandler

public void setXalan270ContentHandler(String xalan270ContentHandler)

Parameters:

xalan270ContentHandler - the xalan270ContentHandler to set

isEscaped

public boolean isEscaped()

setEscaped

public void setEscaped(boolean escaped)