Other Java platform SDKs may be applicable but are currently untested.
Building without these is possible, but some features will be missing.
Note
The Java implementation of RSB depends on RSB‘s language independent network protocol specification. This specification is maintained in the RSB protocol sub-project. This project and its transitive dependencies (except Spread) should already be installed on your system if you followed the C++ installation guidelines . If the C++ implementation of RSB is already installed, you can skip the section Installation of Dependencies on Debian-based Systems and proceed to the Installation of RSBJava section.
$ sudo apt-get install libprotobuf-dev protobuf-compiler build-essential cmake
For installing RSB and its dependencies from source on Darwin, we recommend to use Homebrew, an easy-to-use package manager for MacOS.
$ brew install cmake protobuf
Spread, a group communication framework for reliable multicast communication, is a powerful transport layer which is natively supported in RSB. To install Spread, source archives are available after registration for download here. Installation of the Spread Toolkit is straightforward on MacOS and Linux as it has no external dependencies and comes with a standard configuration script.
Note
In the following sections, prefix specifies the target directory of the installation.
$ tar xzf spread-src-4.1.0.tar.gz
$ cd spread-src-4.1.0
$ ./configure --prefix=$prefix
$ make
$ make install
- RSC
- “0.7” branch of https://code.cor-lab.org/git/rsc.git
- RSB Protocol
- “0.7” branch of https://code.cor-lab.org/git/rsb.git. protocol
Build and install the RSC C++ library and the RSB Protocol library in the order given below:
Build and install RSC Library
$ cd rsc/build
$ cmake -DCMAKE_INSTALL_PREFIX=$prefix \
..
$ make
$ make install
Install RSB Protocol Definitions
$ cd protocol/build
$ cmake -DCMAKE_INSTALL_PREFIX=$prefix \
..
$ make
$ make install
Note
These protocol definitions are shared across programming languages.
Checkout RSB and its immediate dependencies from the Subversion repository
“0.7” branch of https://code.cor-lab.org/git/rsb.git. java
Invoke ant supplying build properties on the commandline or via build.properties (see below)
The following properties are used to configure the build:
Ant Property |
Meaning |
Example |
|---|---|---|
env.prefix |
Location into which RSB should be installed |
/vol/cit/share |
pbuf.protoc |
Location of protocol buffer compiler (protoc or protoc.exe) |
/usr/bin/protoc |
pbuf.protopath |
Location of RSB protocol IDL files (see TODO) |
/vol/cit/share/rsbprotocol |
pbuf.lib |
Location of Java protocol buffer runtime library |
/usr/share/java/protobuf.jar |
spread.daemon |
Location of Spread daemon executable |
/vol/cit/sbin/spread |
All properties can be supplied on the ant commandline using the -DNAME=VALUE syntax or by creating a build.properties file containing lines of the form NAME = VALUE.
An exemplary ant dist command, which builds the RSB jar library, may look as follows:
$ ant -Dpbuf.protoc=/usr/bin/protoc -Dpbuf.protopath=/vol/cit/share/rsbprotocol -Dpbuf.lib=/usr/share/java/protobuf.jar -Dspread.daemon=/vol/cit/sbin/spread dist
The equivalent build.properties file looks like this:
pbuf.protoc = /usr/bin/protoc
pbuf.protopath = /vol/cit/share/rsbprotocol
pbuf.lib = /usr/share/java/protobuf.jar
spread.daemon = /vol/cit/sbin/spread
In the presence of this file, the ant command reduces to ant dist.
Installation of Java archive
To install RSB jars into the configured prefix (e.g., into ${prefix}/share/java), the following ant command can be used:
$ ant install
RSBJava comes with a set of unit tests, which you may use to check your freshly compiled RSBJava version. Executing the test suite is straightforward. To do so, the following ant target needs to be invoked (please note that a Spread daemon is automatically started by the ant script):
$ ant test
You should see a console output similar to the following (shortened excerpt):
$ ant -Dpbuf.protoc=/opt/local/bin/protoc -Dpbuf.protopath=/vol/cit/share/RSBProtocol -Dpbuf.lib=/opt/local/share/java/protobuf.jar -Dspread.daemon=/vol/cit/sbin/spread test
Buildfile: /Users/swrede/Workspace/RSBJava/build.xml
init:
[echo] Using pbuf: /opt/local/share/java/protobuf.jar
[echo] Test report dir: /Users/swrede/Workspace/RSBJava/testreports
protocol:
compile:
[javac] /Users/swrede/Workspace/RSBJava/build.xml:105: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
[javac] Compiling 1 source file to /Users/swrede/Workspace/RSBJava/build/classes
[javac] /Users/swrede/Workspace/RSBJava/build.xml:110: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
[javac] Compiling 1 source file to /Users/swrede/Workspace/RSBJava/build/examples
test-compile:
[javac] Compiling 25 source files to /Users/swrede/Workspace/RSBJava/build/test
test:
[junit] Running rsb.DefaultErrorHandlerTest
[junit] Testsuite: rsb.DefaultErrorHandlerTest
[junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0,083 sec
[junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0,083 sec
[junit] ------------- Standard Error -----------------
[junit] 05.09.2011 11:12:38 rsb.DefaultErrorHandler warning
[junit] SCHWERWIEGEND: A warning was reported to the ErrorHandler: java.lang.RuntimeException: test
[junit] 05.09.2011 11:12:38 rsb.DefaultErrorHandler error
[junit] SCHWERWIEGEND: An error was reported to the ErrorHandler: java.lang.RuntimeException: test
[junit] ------------- ---------------- ---------------
<output of more tests omitted>
[junit] Running rsb.util.UUIDToolsTest
[junit] Testsuite: rsb.util.UUIDToolsTest
[junit] Tests run: 2, Failures: 0, Errors: 0, Time elapsed: 0,164 sec
[junit] Tests run: 2, Failures: 0, Errors: 0, Time elapsed: 0,164 sec
[junit]
[junit] Testcase: testGetNameBasedUUID took 0,069 sec
[junit] Testcase: testByteArrayConversion took 0,001 sec
BUILD SUCCESSFUL
Total time: 48 seconds
If no failed test cases are reported, RSBJava works correctly on your machine.