oBIX server Files

oBIX Server 0.1

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

For licensing information, please see LICENSE.TXT

History:
10/28/07: V0.1.02 Added PUT, ?? POST, added more features.
Also:
 * ?? added design doc
 * added javadocs geberation
 * re-factored classes into two packages
 * somewhat refactored toi allow more easy merging
    of xml data and business objects (adapter/integration)
 * added support for URI resolver callback and object proxying
 * ?? 6) setup a reference server with public access for testing
 * ?? some?? 10) add unit tests
 * added error handling using oBIX Err (but need more test cases to test it)
 * made the core project jdk1.4 compliant (removed jdk 1.5 features,
   provided wrapper for logging)

10/22/07: V0.1.01 First release

Pre-requisites
--------------

This project uses:
* obix core library 1.0.0 - Obix Java Toolkit from http://sourceforge.net/projects/obix
* REST-art 0.3: light-weight REST implementation from http://rest-art.sourceforge.net/

The needed jars are in lib subdirectory.

How to build the application.
-----------------------------

This was developed under cygwin. Scripts may require minor
modifications to work on unix.

To build obix-server for simulator deployment:
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.

to see all targets:

ant -p

Note for eclipse:
You can use eclipse file .classpath and .project to load into eclipse.
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 .

How to run
----------

Note: REST service runs on port 1225 by default.
You can customized the listen port by modifying obix-server.properties
These instructions apply to both simulator and lejos target.


1) Using cygwin:

build/obixserver/run.sh

2) Using cmd:
cd build/obixserver
run.bat

Note: if you are using the binary distribution, you can run
run.sh or run.bat in the root directory.


To run obix-server for lejos:
-----------------------------

First build and upload lejos binary to NXT: see modules/lejos/nxt/README.TXT



Current functionality
---------------------

This release is a prototype that allows you to browse a hardcoded oBIX objects repository.

After starting the server, go to:

http://localhost:1225/obix/

You can customize the hardcoded object repository by modifying ObjectLoader.java

You can customize hrefs emitted by object repository in response to REST request by modifying
obix-server.properties