Future Develo9pment
IRIS RemoteXML Plugin
This document descibes the RemoteXML plugin for IRIS which exposes XML
APIs for TCP or HTTP communication with IRIS.
Overview
The RemoteXML plugin is a server that accepts tcp connections. On each
connection it processes an XML request and send an XML response.
Configuration
The main Spring configuration file is located at
"plugins-src/remotexml/bin/remotexml.xml". This file is copied to
plugins/remotexml during the build. The bean which repesents the TCP
XML server is named "com.sri.iris.plugins.remotexml.IIrisXMLServer". In
the XML configuration file it is possible to specify the listen port
for the server. See the configuration file for details.
Protocol
TCP
IRIS listens for TCP connections to send/receive XML. Clients should
not hardwire the server address and port for the IRIS TCP server.
Instead clients should use the CALO
Keychain Service to retrieves the server address and port. For
example, assuming the keychain distribution jars are in the classpath,
the following Java code retrieves the application information for the
IRIS TCP XML server:
AJAX
TBD: More documentaiton coming..
Sample Application
TBD: More documentaiton coming..
XML Schema Definitions
The following XML Schema definition files documented the XML APIs:
- remotexml.xsd
contains the core XML element definitions.
- table.xsd
contains schema definitions for table transformations needed for Laszlo
UI development
API Index
The following is a list of API pages and links to API documentation for
all XML APIs:
Testing
Unit tests exist for the RemoteXML plugin located in the "test"
directory. To run the unit tests, make sure IRIS is shut down and then
from a command prompt navigate to iris/plugins-src/remotexml/test and
execute "ant test". Note that ant must be installed with JUnit support
for the unit tests to run. The unit tests source can be found in
test/src/java. Note that after running the unit tests, 2 files are
written to the test/dest directory which contain exported RDF/XML.
These files need to be examined manually to make sure there is RDF/XML
content in them.
Within IRIS there is a test application located under the "Debug"
folder named "XML Server". In this test application it is possible to
create a connection to the remote XML server, and from the "Queries"
menu insert some sample queries. The sample queries for this
application are defined in the "remotexml.xml" configuration file.