Usage of the XML Source

When using this kind of data source we can load the data from a resource resolvable through the built-in resource loading mechanism or by means of a backing bean which will offer the data to the data source component.

Configuring the source component

The attributes required to be used with this type of data soruce are reflected in the following table:

valuefalseXML Document which contains the data.
querytrueXPath query used to obtain the result set.

Valid values for attribute value are:

  • A file handle to a resource accessible by the server which is running the application.
  • An URL to a resource accessible through internet
  • java.lang.String: A path to any kind of resource. It will be loaded using the built-in resource loading mechanism.
  • A stream ready to be used to read the XML data. In this case, application is responsible of closing the stream
  • org.xml.sax.InputSource: A SAX input source is valid enough to provide the data to the report components.
  • org.w3c.dom.Document: A pre-loaded or dynamically created XML document.
  • javax.xml.transform.Source: Any of the 3 implementations of the Source interface provided by the JDK: DOMSource, SAXSource and StreamSource.


Simple Usage

The most simple usage is based on the built-in resource loading mechanism implemented inside the plugin using following way:

<jr:source type="xml" value="classpath:META-INF/datasource/test.xml" />

Using a backing bean

First of all, we need to design a JSF Managed Bean which will build the XML document that will be used by the data source component.

import javax.annotation.PreDestroy;
import org.w3c.dom.Document;
import ...;

public class XMLDataBean {

    private InputStream xmlStream = null;


    // Dynamically created XML document
    public Document getXmlDocument() {
        // Build an XML Document

    public InputStream getXmlStream() {
        if (xmlStream == null) {
            // Instantiate an input stream from a xml source
        return xmlStream;

    public void release() {
        if (xmlStream != null) {
            try {
            } catch(IOException e) {

        // Release other resources



Then, this managed bean can be used inside the JSP file that will render the report or report link.

<jr:source type="xml" value="#{XMLDataBean.xmlDocument}" />
<jr:source type="xml" value="#{XMLDataBean.xmlStream}" />

Using Queries

The same way you can use queries with JDBC or JNDI data sources, you can also use queries with XML data sources. In this case, the difference is the kind of query to be used, since we are dealing with XML, the query should be an XPath query.

<jr:source type="xml"
    <f:param value="Melbourne" />

As you can see, you can parameterize queries but following the java message formatting syntax.