oX - oBIX Server 0.2 Peter Michalek Introduction ------------ Documents: Specification: doc/obix-server-project-specification.txt Note: This was originally published on http://groups.google.com/group/obix-developers as "oBIX Server Project Specification" Release notes: RELEASE-NOTES.TXT User documentation: oxUserGuide.xml and generated manuals in PDF and HTML format. A recent version is kept at http://obix-server.sourceforge.net/. For licensing information, please see LICENSE.TXT Pre-requisites -------------- This project uses: * obix core library 1.0.0 - Obix Java Toolkit from http://sourceforge.net/projects/obix Optional servlet container: * Winstone 0.9.9: light-weight servlet container http://sourceforge.net/projects/winstone * Tomcat 5.0 or higher: http://tomcat.apache.org It can optionally be used with any servlet container. The required jars are in lib subdirectory. How to build the application. ----------------------------- Note: This was developed under cygwin. Scripts may require minor modifications to work on unix. There are three basic build options to support lightweight, regular and secure deployment. ant webdeploy: builds and creates a deployment directory for regular non-secure deployment ant webdeploy-min: builds and creates a deployment directory for minimal footprint ant webdeploy-sec: builds and creates a deployment directory with jars and property files that offer authorization, authentication and encryption. You need to modify winstone.properties to adjust settings. To build obix-server for simulator deployment using regular deployment option: ant clean package-simulator To build obix-server for lejos deployment: ant clean package-lejos Note: unless you have Mindstorm Lego NXT, you want to build simulator rather than lejos. To see all build targets: ant -p Note for eclipse: You can use eclipse file .classpath and .project to load into eclipse. You'll need lejos and REST-art projects setup in your workspace, or to remove the references and let their respective jar libraries be used. To run under eclipse, please do the following to prepare the environment: cp ./conf/obix-server.properties ./conf/log4j.conf ./build/classes/version.txt bin cp ./resources/staticValues.xml ./build/obixserver/about.xml . Using the supplied .classpath and .project files in eclipse, you also need a dependent project setup called 'obix' which contains the obix client classes from the sourceforge project http://sourceforge.net/projects/obix/ Building Documentation ---------------------- Pre-requisite: Docbook framework needs to be installed and docbook.properties modified to reflect your installation directory, e.g.: dbf.basedir = C:/sw/DocBook-Framework-1.0 To generate documentation: ant all ant -f build-docbook.xml Demo server ----------- An experimental server is running here as of March 2008: http://obix.michalek.org:1225/obix/ It's not guaranteed to be up at all times, but it will be there for the next few weeks. Testbed ------- A simple test suite exists that can be used to troubleshoot, observe the behavior of the oX system and understand the semantics of requests and responses. It's based on command-line bash interface using curl: see test/resources/README.TXT