org.globus.mds.webmds
Interface WebmdsXmlSource

public interface WebmdsXmlSource

Interface called by WebmdsServlet to acquire an xml document.

See Also:

WebmdsServlet

Method Summary

java.lang.String	getRequestInfo() Return information an end-user might find interesting about the request.
javax.xml.transform.Source	getXmlSource(java.lang.String name, ParameterMap initParams, ParameterMap requestParams) Function called by WebmdsServlet at invocation time to get an xml document.
void	init(WebmdsUtil webmdsUtil) Initialize the XML source.

Method Detail

getXmlSource

public javax.xml.transform.Source getXmlSource(java.lang.String name,
                                               ParameterMap initParams,
                                               ParameterMap requestParams)
                                        throws WebmdsXmlSourceException,
                                               WebmdsConfigException,
                                               java.io.IOException

Function called by WebmdsServlet at invocation time to get an xml document.

Parameters:

name - name of the XML source object to get.

initParams - a ParameterMap of options corresponding to the initialization parameters for this XML source.

requestParams - a ParameterMap of options corresponding to the parameters from this http request.

Returns:

a javax.xml.transform.Source object representing a source of XML.

Throws:

WebmdsXmlSourceException

WebmdsConfigException

java.io.IOException

See Also:

ParameterMap

getRequestInfo

public java.lang.String getRequestInfo()

Return information an end-user might find interesting about the request. This will be set as an xsl parameter when the results are returned to the user.

init

public void init(WebmdsUtil webmdsUtil)

Initialize the XML source.

Parameters:

webmdsUtil - a WebmdsUtil object with utility methods that the xml source can use.