com.fatdog.xmlEngine
Interface IProtocolHandler

All Known Implementing Classes:
XYZ_ProtocolHandler

public interface IProtocolHandler

Provides a callback for implementers of custom protocols.

Clients wanting to address XML resources using a custom-protocol addressing scheme need to implement this interface's content(String) method.

Version:
0.66
Author:
Howard Katz, howardk@fatdog.com

Method Summary
 java.lang.String content(java.lang.String url)
          Return the XML contents of the resource addressed by this custom protocol.
 

Method Detail

content

public java.lang.String content(java.lang.String url)
Return the XML contents of the resource addressed by this custom protocol.

This callback method will be called when XQEngine determines that an address you've passed to XQEngine.setDocument(String) (or indirectly through the function fn:doc(String) is the address of a custom-protocol that you've previously registered with the query engine.

Parameters:
url - The address of the resource
Returns:
The serialized XML content of the resource at the address
See Also:
XQEngine.registerProtocolHandler(String, IProtocolHandler)