Module org.apache.wicket.util

Package org.apache.wicket.util.resource

Class XSLTResourceStream

java.lang.Object

org.apache.wicket.util.resource.AbstractResourceStream

org.apache.wicket.util.resource.XSLTResourceStream

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, IClusterable, IResourceStream, IModifiable

public class XSLTResourceStream
extends AbstractResourceStream

IResourceStream that applies XSLT on an input IResourceStream. The XSL stylesheet itself is also an IResourceStream. Override getParameters() to pass parameters to the XSL stylesheet.

NOTE: this is an experimental feature which does not implement any kind of caching, use with care, running an XSL transformation for every request is very expensive! Please have a look at ZipResourceStream for an in-depth explanation of what needs to be done with respect to caching.

Author:

Jean-Baptiste Quenot

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
XSLTResourceStream(IResourceStream xsltResource, IResourceStream xmlResource)	Construct.
XSLTResourceStream(IResourceStream xsltResource, IResourceStream xmlResource, TransformerFactory transformerFactory)	Construct.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the resource.
String	getContentType()	Returns always null
InputStream	getInputStream()	Gets the resource stream.
protected Map<Object,Object>	getParameters()
Instant	lastModifiedTime()	Returns always null
Bytes	length()	Gets the size of this resource

Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream

getLocale, getStyle, getVariation, setLocale, setStyle, setVariation

Methods inherited from class java.lang.Object

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

Constructor Details

XSLTResourceStream

public XSLTResourceStream(IResourceStream xsltResource,
 IResourceStream xmlResource)

Construct.

Parameters:

xsltResource - the XSL stylesheet as an IResourceStream

xmlResource - the input XML document as an IResourceStream

XSLTResourceStream

public XSLTResourceStream(IResourceStream xsltResource,
 IResourceStream xmlResource,
 TransformerFactory transformerFactory)

Construct.

Parameters:

xsltResource - the XSL stylesheet as an IResourceStream

xmlResource - the input XML document as an IResourceStream

transformerFactory - the transformer factory used to transform the xmlResource

Method Details

getParameters

protected Map<Object,Object> getParameters()

Returns:

a Map of XSLT parameters, appropriate for passing information to the XSL stylesheet

close

public void close()
           throws IOException

Description copied from interface: IResourceStream

Closes the resource. Normally, this includes closing any underlying input stream returned by getInputStream().

Throws:

IOException

See Also:

• IResourceStream.close()

getContentType

public String getContentType()

Returns always null

Specified by:

getContentType in interface IResourceStream

Overrides:

getContentType in class AbstractResourceStream

Returns:

The mime type of this resource, such as "image/jpeg" or "text/html". Return null to let ResourceStreamRequestHandler handle the Content-Type automatically

See Also:

• IResourceStream.getContentType()

getInputStream

public InputStream getInputStream()
                           throws ResourceStreamNotFoundException

Description copied from interface: IResourceStream

Gets the resource stream. You should not directly close this stream. Instead call the close() method on IResourceStream.

Returns:

Returns the inputStream.

Throws:

ResourceStreamNotFoundException

See Also:

• IResourceStream.getInputStream()

length

public Bytes length()

Description copied from interface: IResourceStream

Gets the size of this resource

Specified by:

length in interface IResourceStream

Overrides:

length in class AbstractResourceStream

Returns:

The size of this resource in the number of bytes, or null if unknown

See Also:

• IResourceStream.length()

lastModifiedTime

public Instant lastModifiedTime()

Returns always null

Specified by:

lastModifiedTime in interface IModifiable

Overrides:

lastModifiedTime in class AbstractResourceStream

Returns:

the last modification Time or null if that information is not available

See Also:

• IModifiable.lastModifiedTime()