README

The whole release shebang is summarized in our Change Log.

As always, the most current information about the Remote Tea Java Library, as well as updates, can be found on the web at the Remote Tea ONC/RPC Home Page.

The Remote Tea Java Library is licensed under the terms of the GNU Library General Public License (LGPL).

Rationale: while the LGPL does not restrict the use of my packages even in commercial applications, I am ensuring this way that modifications to the source code must be given back to the comunity. If you use my packages in commercial applications, you must either include the source code of the Remote Tea ONC/RPC Java Library or provide the source code to your customers on request. The details can be found in the LGPL terms.

The directory structure is as follows:

  • doc/: Remote Tea ONC/RPC online documentation  

  • src/: source code of the Remote Tea ONC/RPC Java Library.
    • src/org/acplt/oncrpc contains the source code of the various packages.
    • src/org/acplt/oncrpc/apps contains applications, in this case only the jrpcgen rpc protocol compiler in the jrpcgen/ subdirectory.
    • src/tests contains test code.
    • src/tests/org/acplt/oncrpc/jrpcgen contains an example of how to use the jrpcgen rpc protocol compiler. To generate source code from the x-file, run:
      java -jar jrpcgen.jar -p tests.org.acplt.oncrpc.jrpcgen -nobackup demo.x
      

  • classes/: compiled Java bytecode. After running the jarify.bat script, this directory will also contain two jar files called classes/oncrpc.jar and classes/jrpcgen.jar.

  • projects/: contains project files for Borland's JBuilder.

  • readme-first/: this directory containing release and changelog information about one or several modules or Java packages.

  • etc/: misc. stuff (scripts) for maintaining the Remote Tea ONC/RPC Java Library. Currently, this is rather Win32-centric, but this will change in the future (writing the same scripts for unices should be really straightforward).
    • docify.cmd runs javadoc on all org.acplt.* packages, thus making live much easier (or do you want to type such long command lines over and over again?).
    • phpify.pl is probably not useful for anyone except me: it copies the javadoc-generated html files over to another directory and modifies the html code by inserting php commands and removing unnecessary html code. The generated pages then can be used for the web server of the Chair of Process Control Engineering.
    • build.bat runs javac on all source code (including examples). In case of Sun's javac the term "runs" is much too euphemistically -- "crawls" would be more precise. Afterwards, the packages belonging to org.acplt.oncrpc (including sub packages) will be archived into the file called classes/oncrpc.jar.
    • jarify.bat archives the packages belonging to org.acplt.oncrpc (including sub packages) into the file called classes/oncrpc.jar.

So far, the Remote Tea ONC/RPC Java package is developed and tested using Borland's JBuilder 3 featuring Sun's JDK-1.2.2-001 (Windows) as well as JBuilder 6 with JDK-1.3.1. In addition I also use en par JBuilder 4 with IBM's JDK-1.3.0 on Linux. I would like to hear feedback from people using other Java2-compliant Java compilers and virtual machines. For people who want to compile the source themselves, there is a JBuilder project file called remotetea.jpr in the projects/ directory. The project file just compiles all packages but does nothing else.

Written by Harald Albrecht (harald@plt.rwth-aachen.de).

© 1999, 2002 Chair of Process Control Engineering,
Aachen University of Technology,
52064 Aachen, Germany

CVS info: $Revision: 1.1 $ $Date: 2003/02/25 21:50:08 $ $State: Exp $ $Locker: $