This section is intended for developers implementing the Lotus Quickr web services. A developer can implement the services to extend Lotus Quickr to another backend repository, file-system or other source of data. Developers can extend Lotus Quickr to additional repositories by implementing the web and REST services for Lotus Quickr, allowing the Lotus Quickr Connectors to browse and access additional sources of data.
Consumers or callers of the Lotus Quickr Content Services will be best served by reading the wiki information on the Lotus Quickr Content Services
The attached Enterprise Archive (EAR) provides a very basic implementation of the first few methods you will need to implement to create a Lotus Quickr web services implementation. These methods include a "get libraries" call (more precisely a "getBusinessComponents" call), and a getFolders method. Implementors should start by looking at the classes LibraryServiceSOAPImpl, DocumentServiceSOAPImpl and ContentServiceSOAPImpl classes. These are the only classes modified for this sample after the automatic code generatation from the WSDL file.
This EAR file can be imported into your IDE, and run in a WebSphere 6.1 test environment or you can import the contentapi.clb.services.sample.zip, which is a Rational Application Developer Project Interchange archive. Use Import > Other > Project Interchange. The Lotus Quickr Connectors can connect to your test environment to run the web services and see the sample libraries and folders in the Lotus Quickr Connectors.
The critical configuration files to consider when modifying the EAR are the web.xml, webservices.xml, and ContentService_mapping.xml. The web.xml files defines the servlets used for the web service implementation. The webservices.xml file defines the interface classes used for each service. The ContentService_mapping.xml file defines the mapping from the WSDL definition of the web services to the source code used to implement the interface classes. If you change package names, class names or method names or signatures, you may need to alter one or more of these files.
Rational Application Developer automatically checks the URL registered with XML namespaces and expects an XML schema at the URL defined for the namespace. Although the sample will function without the schema defined at the namespace, some IDEs will flag this as an error and prevent the application from being published to a test environment. In Rational products, go to Window > Preferences > Server > WebSphere and make sure "Allow application containing errors to be published on a server" is checked. Checking this option tells the IDE that it can publish and run the application in the test environment despite the schema validation error. The error may still be flagged on the problems view for the ContentService.wsdl file.
Open the attachments section below to download the contentapi.clb.services.sample.ear file.