1 | Introduction | |
2 | Installation and Use | |
3 | Request Classes | |
4 | Response Classes | |
5 | Communication Classes | |
6 | Utility Classes |
This document provides an overview of the OpenSPML Toolkit, a collection of Java classes that assist in submitting SPML requests, and receiving SPML responses. The toolkit is not vendor specific, it may be used by any Java application to communicate with any SPML compliant server. It may also be used by an SPML server to parse requests and build responses.
A Java object model is provided for all of the request and response elements defined in the SPML protocol. In addition a set of classes to perform SOAP communication is also provided. This provides Java developers with a convenient mechanism to make SPML requests without having to worry about the details of the XML language or the HTTP transport protocol.
This document provides only an overview of the available classes. Please consult the Javadocs for more detailed information.
The distribution includes the following jar files:
The openspml.jar file is normally installed in the WEB-INF/lib directory of your web application. If you wish to use only the client portion of the library, you may put openspml.jar anywhere and include it in the client application's classpath.
The library requires version 2.2 or higher of the Apache SOAP library, and version 2.4.0 or higher of the Xerces XML parser with JAXP support.
The following classes are used to construct SPML requests sent from a client to the server.
The following classes are used to construct SPML responses send from the server back to the client.
The following classes use the SPML object model classes described above to perform actual SPML requests using a SOAP binding with an HTTP transport protocol.
The classes described in this section provide general purpose utilities used by other classes in the library.