com.ibm.portal.resolver.data
Interface XmlDataSource

All Superinterfaces:

Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped

public interface XmlDataSource
extends DataSource

Implemented by providers of XML data streams. The stream provider must be able to produce XML content as a JAXP source object.

Since:

6.1.0

Note:

This interface is designed to be implemented by clients.

Field Summary

static java.lang.String	CONTENT_TYPE_XML Mime type for plain XML messages http://www.rfc-editor.org/rfc/rfc3023.txt
static java.lang.String	CONTENT_TYPE_XML_DEPRECATED Deprecated mime type for plain XML messages

Fields inherited from interface com.ibm.portal.resolver.data.DataSource

CONTENT_TYPE_UNKNOWN, CREATION_UNKNOWN, EXPIRATION_UNKNOWN, LAST_MODIFICATION_UNKNOWN, MAX_AGE_INFINITE, MAX_AGE_NONE, ROOT_DATE

Fields inherited from interface com.ibm.portal.resolver.data.Addressable

EMPTY_PARAMETERS

Method Summary

java.lang.String	getContentType() Mime type of the data.
javax.xml.transform.Source	getSource() Returns a new JAXP source object that can be used to generate a stream of XML events.

Methods inherited from interface com.ibm.portal.resolver.data.DataSource

getCreated, getExpiration, getLastModified

Methods inherited from interface com.ibm.portal.resolver.data.Addressable

getParameters, getURI

Methods inherited from interface com.ibm.portal.Disposable

dispose

Field Detail

CONTENT_TYPE_XML

static final java.lang.String CONTENT_TYPE_XML

Mime type for plain XML messages http://www.rfc-editor.org/rfc/rfc3023.txt

Since:

6.1.0.3

See Also:

Constant Field Values

CONTENT_TYPE_XML_DEPRECATED

static final java.lang.String CONTENT_TYPE_XML_DEPRECATED

Deprecated mime type for plain XML messages

Since:

8.5

See Also:

Constant Field Values

Method Detail

getContentType

java.lang.String getContentType()

Mime type of the data. The return value must be a valid XML mime-type, e.g. "application/xml"

Specified by:

getContentType in interface DataSource

Returns:

mime type string, not null

getSource

javax.xml.transform.Source getSource()
                                     throws javax.xml.transform.TransformerException,
                                            org.xml.sax.SAXException,
                                            java.io.IOException

Returns a new JAXP source object that can be used to generate a stream of XML events.

Returns:

The source object of the XML events.

Throws:

javax.xml.transform.TransformerException - - if a potential transformation used to generate the source failed

org.xml.sax.SAXException - - if a SAX exception occurred

java.io.IOException - - if an IO exception occurred